/discord/invites

POST /api/discord/invites

Price: 1 credit

Get Discord Invite

How to use it

Resolve a Discord invite by code, vanity name, or invite URL. Returns the server snapshot (name, description, icon, banner, features, verification level, premium tier), the target channel, the inviter, and approximate member and online counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• invite string required — Invite code, vanity name, or invite URL (examples: "python", "discord.gg/python"; minLength: 1)

Response

• @type string (default: "DiscordInvite")
• code string required
• url string nullable
• type integer nullable
• flags integer nullable
• expires_at string nullable
• approximate_member_count integer nullable
• approximate_presence_count integer nullable
• guild_tag object nullable
  • @type string (default: "DiscordGuildTag")
  • tag string required
  • badge integer nullable
  • badge_image string nullable
  • badge_color_primary string nullable
  • badge_color_secondary string nullable
  • member_count integer nullable
  • online_count integer nullable
  • traits array (default: [])
    • @type string (default: "DiscordGuildTagTrait")
    • label string nullable
    • emoji_id string nullable
    • emoji_name string nullable
    • is_animated boolean (default: false)
    • position integer nullable
• guild object nullable
  • @type string (default: "DiscordInviteGuild")
  • id string required
  • name string nullable
  • description string nullable
  • alias string nullable
  • image string nullable
  • banner string nullable
  • splash string nullable
  • features array (default: [])
  • is_verified boolean (default: false)
  • is_partnered boolean (default: false)
  • verification_level integer nullable
  • nsfw_level integer nullable
  • is_nsfw boolean (default: false)
  • premium_subscription_count integer nullable
  • premium_tier integer nullable
• channel object nullable
  • @type string (default: "DiscordInviteChannel")
  • id string required
  • name string nullable
  • type integer nullable
• inviter object nullable
  • @type string (default: "DiscordUser")
  • id string required
  • username string nullable
  • global_name string nullable
  • discriminator string nullable
  • image string nullable
  • public_flags integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Invite not found, expired, or revoked. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.