About PronounDB

API Documentation

Types

Platform: codeberg, discord, facebook, github, gitlab, instagram, mastodon, osu, reddit, twitch, or twitter
Pronouns: Short identifier for a set of pronouns. Here are the identifiers recognized by PronounDB:
  • unspecified: Unspecified
  • hh: he/him
  • hi: he/it
  • hs: he/she
  • ht: he/they
  • ih: it/him
  • ii: it/its
  • is: it/she
  • it: it/they
  • shh: she/he
  • sh: she/her
  • si: she/it
  • st: she/they
  • th: they/he
  • ti: they/it
  • ts: they/she
  • tt: they/them
  • any: Any pronouns
  • other: Other pronouns
  • ask: Ask me my pronouns
  • avoid: Avoid pronouns, use my name

Lookup an account

GET /api/v1/lookup

Query parameters

  • platform: A supported platform as described above
  • id: Account ID on the platform

Response: 404 if not found, 200 otherwise with the following payload

  • pronouns: Short identifier as defined above

Lookup accounts in bulk

GET /api/v1/lookup-bulk

Note: you can only lookup multiple account for a single platform.

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. IDs not found will not be included.