discord.invite

stable Standard

Public Discord invite lookup: server name and member counts.

GET /v1/discord/invite

What you get#

One Discord record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`code`	string	yes	(required)	Invite code or vanity, e.g. python	max 32 chars; must match `[A-Za-z0-9-]{2,32}`; trimmed

Request#

curl "https://api.onekey.dev/v1/discord/invite?code=python" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Discord response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "267624335836053506",
      "name": "Python",
      "description": "We're a large community focused around the Python programming language. We believe that anyone can learn to code.",
      "stats": {
        "members": 431976
      }
    },
    "ext": {
      "code": "python",
      "online": 45289,
      "boosts": 41,
      "verificationLevel": 2,
      "channel": "welcome",
      "expiresAt": null
    }
  },
  "metadata": {
    "platform": "discord",
    "endpoint": "invite",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`guild.id`	`entity.id`	-
`guild.name`	`entity.name`	-
`guild.description`	`entity.description`	-
`code`	`ext.code`	-
`approximate_member_count`	`entity.stats.members`	`toNumber`
`approximate_presence_count`	`ext.online`	`toNumber`
`guild.premium_subscription_count`	`ext.boosts`	`toNumber`
`guild.verification_level`	`ext.verificationLevel`	`toNumber`
`channel.name`	`ext.channel`	-
`expires_at`	`ext.expiresAt`	`toIsoDate`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).