About PronounDB
API Documentation
This will be rewritten soon, with a better look and a new API that includes new features. Stay tuned!
Types
Platform:
discord
, facebook
, github
, minecraft
, twitch
, or twitter
Pronouns: Short identifier for a set of pronouns. Here are the identifiers supported by PronounDB, sorted alphabetically:
unspecified
: Unspecifiedhh
: he/himhi
: he/iths
: he/sheht
: he/theyih
: it/himii
: it/itsis
: it/sheit
: it/theyshh
: she/hesh
: she/hersi
: she/itst
: she/theyth
: they/heti
: they/itts
: they/shett
: they/themany
: Any pronounsother
: Other pronounsask
: Ask me my pronounsavoid
: Avoid pronouns, use my name
For privacy reasons, the API will respond successfully regardless of whether the account is linked to a PronounDB account or not.
Lookup an account
GET /api/v1/lookup
Query parameters
- platform: A supported platform as described above
- id: Account ID on the platform
Response: A JSON object with a pronouns property.
Lookup accounts in bulk
It is more efficient to use a simple lookup for single-id queries, and the API may refuse to do bulk lookup for single-id queries in the future.
GET /api/v1/lookup-bulk
Query parameters
- platform: A supported platform as described above
- ids: Comma-separated Account IDs, will be cropped to 50 max
Response: A map of IDs with their corresponding set of pronouns.
shields.io endpoint
You can use shields.io's endpoint functionality to create a badge of your pronouns using PronounDB's API. The endpoint is at
/shields/:pronoundbId
. By default, everything will be in lowercase, but you can add the capitalize
query parameter to change this behavior. The PronounDB ID is shown under "Advanced settings" in your account screen.See shields.io's docs for more information. Below is an example badge of the website's developer pronouns.
https://img.shields.io/endpoint?color=f49898&style=flat-square&url=https%3A%2F%2Fpronoundb.org%2Fshields%2F5fd62c00985db32c8e80d5b6