Skip to content

Instantly share code, notes, and snippets.

@Ratstail91
Last active April 18, 2021 20:59
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Ratstail91/21cbd0c44e1df4584fad16f42cb1e63d to your computer and use it in GitHub Desktop.
Save Ratstail91/21cbd0c44e1df4584fad16f42cb1e63d to your computer and use it in GitHub Desktop.

API

This api can be tested with curl like this:

curl https://mock.eggtrainer.com/stat/v1/<route>
# Every route is a GET and HEAD route
# All data is returned in JSON format

#########################

# global "last updated" data can be fetched from here
/stat/v1

# potential utility routes
/stat/v1/shop*
/stat/v1/battle*

#########################

# return a list of all egg keys
/stat/v1/eggs

# return details of all eggs
/stat/v1/eggs/all

# return details of a specific egg by key
/stat/v1/eggs?key=

#########################

# return a list of all element keys
/stat/v1/elements

# return entire type graph
/stat/v1/elements/all

# return specific element's type graph
/stat/v1/elements?key=

#########################

# return a list of all item keys
/stat/v1/items

# return details of all items
/stat/v1/items/all

# return details of a specific item by key
/stat/v1/items?key=

#########################

# return a list of all species keys
/stat/v1/species

# return all species profiles
/stat/v1/species/all

# return profile of a specific species by key
/stat/v1/species?key=

# filter profiles based on element
/stat/v1/species?element=

# filter profiles based on rarity
/stat/v1/species?rarity=

# filer profiles based on possessing a technique
/stat/v1/species?technique=

#########################

# return a list of all technique keys
/stat/v1/techniques

# return all techniques
/stat/v1/techniques/all

# return details of a technique by key
/stat/v1/techniques?key=

# filter details of all techniques by type (physical or magical)
/stat/v1/techniques?type=

# filter details of all techniques by element
/stat/v1/techniques?element=

# filter details of all techniques by signature element
/stat/v1/techniques?signatureElement=

# filter details of all techniques by signature species
/stat/v1/techniques?signatureSpecies=
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment