Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thebowja/genshin-db-api
Web API for retrieving genshin-db data.
https://github.com/thebowja/genshin-db-api
api genshin genshin-db genshin-impact
Last synced: 29 days ago
JSON representation
Web API for retrieving genshin-db data.
- Host: GitHub
- URL: https://github.com/thebowja/genshin-db-api
- Owner: theBowja
- Created: 2021-10-14T23:12:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T16:43:17.000Z (about 1 month ago)
- Last Synced: 2024-11-21T17:39:21.039Z (about 1 month ago)
- Topics: api, genshin, genshin-db, genshin-impact
- Language: JavaScript
- Homepage: https://genshin-db-api.vercel.app/
- Size: 177 KB
- Stars: 13
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# genshin-db-api
Web API for [genshin-db](https://www.npmjs.com/package/genshin-db) using Vercel serverless function.
You can access v4 style data by switch `/v5` with `/v4`.
## [folder]?query=[query]
https://genshin-db-api.vercel.app/api/v5/characters?query=hutao
Returns the search result for the specified folder and query.
You'll have to retrieve stats for characters/talents/weapons using the stats API.
You may include standard genshindb options as url query parameters (case-sensitive):
- dumpResult // The query result will return an object with the properties: { query, folder, match, matchtype, options, filename, result }.
- matchNames // Allows the matching of names.
- matchAltNames // Allows the matching of alternate or custom names.
- matchAliases // Allows the matching of aliases. These are searchable fields that returns the data object the query matched in.
- matchCategories // Allows the matching of categories. If true, then returns an array if it matches.
- verboseCategories // Used if a category is matched. If true, then replaces each string name in the array with the data object instead.
- queryLanguages // Comma separated list of languages that your query will be searched in.
- resultLanguage // Output language that you want your results to be in.
Examples:
https://genshin-db-api.vercel.app/api/v5/characters?query=hutao
https://genshin-db-api.vercel.app/api/v5/characters?query=胡桃&queryLanguages=chinese&resultLanguage=chinese
https://genshin-db-api.vercel.app/api/v5/talents?query=slime&matchCategories=true&queryLanguages=english,jap
https://genshin-db-api.vercel.app/api/v5/weapons?query=skywardharp&dumpResult=true&resultLanguage=korean
### [folder]?query=names&matchCategories=true
https://genshin-db-api.vercel.app/api/v5/characters?query=names&matchCategories=true
Returns a list of names for the specified folder.
You may also include the option verboseCategories to get a list of data objects instead of a list of names.
## config
https://genshin-db-api.vercel.app/api/v5/config
Returns the following:
- list of folders
- list of languages
- the default options used by the api
- list of category values for each folder
You can use `resultLanguage` to get category values for other languages.
Example:
https://genshin-db-api.vercel.app/api/v5/config?resultLanguage=spanish
## folders
https://genshin-db-api.vercel.app/api/v5/folders
Returns the list of folders.
## languages
https://genshin-db-api.vercel.app/api/v5/languages
Returns the list of languages.
## categories
https://genshin-db-api.vercel.app/api/v5/categories
Returns the category values for every folder.
You can use `resultLanguage` to get category values for other languages.
Example:
https://genshin-db-api.vercel.app/api/v5/categories?resultLanguage=spanish
## stats?folder=[folder]&query=[query]
https://genshin-db-api.vercel.app/api/v5/stats?folder=characters&query=hutao
Returns the stats for every level for the specified folder and query as a JSON map.
Ascended stats are mapped with a '+' like '80+'.
Only for `characters` and `weapons` folder.
You may include standard genshindb options as url query parameters (case-sensitive).
Adding `dumpResult=true` will allow you to get the data object of the character/weapon being searched.
You may include `level` as a query parameter to get the stats for a specific level.
Examples:
https://genshin-db-api.vercel.app/api/v5/stats?folder=characters&query=胡桃&queryLanguages=chinese
https://genshin-db-api.vercel.app/api/v5/stats?folder=weapons&query=jadespear&level=90
https://genshin-db-api.vercel.app/api/v5/stats?folder=characters&query=hutao&dumpResult=true
https://genshin-db-api.vercel.app/api/v5/stats?folder=characters&query=ganyu&level=60+
## tcgdeckshare/decode?code=[deckcode]
https://genshin-db-api.vercel.app/api/tcgdeckshare/decode?code=A0Bw8TQPARBw8pcPCSBw9cIPDFAg9sgQDAGAAMkQDCGQCdkQDaGQC+MQDrEwDOQQDsAA
Converts a tcg deck share code into an array of card share ids.
Returns an object with the properties:
- `deckcode`
## tcgdeckshare/encode?deck=[cardids]
https://genshin-db-api.vercel.app/api/tcgdeckshare/encode?deck=55,52,23,151,151,194,194,200,200,201,201,217,217,227,227,228,228,241,241,242,242,245,245,246,256,256,258,265,266,267,267,268,268
Converts a comma-separated array of card share ids into a tcg deck share code.
You can an `offset` query parameter to generate a different deck share code for the same deck. This is useful for the extremely rare case where the deck share code is invalid because it contains a bad word.
Example:
https://genshin-db-api.vercel.app/api/tcgdeckshare/encode?offset=1&deck=55,52,23,151,151,194,194,200,200,201,201,217,217,227,227,228,228,241,241,242,242,245,245,246,256,256,258,265,266,267,267,268,268
Returns a string.
## tcgdeckshare/getdata?code=[deckcode]&deck=[cardids]
https://genshin-db-api.vercel.app/api/tcgdeckshare/decode?code=A0Bw8TQPARBw8pcPCSBw9cIPDFAg9sgQDAGAAMkQDCGQCdkQDaGQC+MQDrEwDOQQDsAA