Get Discord invite
Get a Discord invite's live member and online counts, the server behind it, its boosts, tag, traits and games.
Headers
Get your API keyAPI key (`sfk_...`)
Invite code (a vanity code or a temporary code), 2 to 32 letters, digits, underscores or hyphens. Vanity codes are case-insensitive; temporary codes are case-sensitive.
pattern: ^[A-Za-z0-9_-]{2,32}$
Endpoint-specific response payload.
`not_found` for an unknown, expired or malformed code; `reason` uses the same `unknown_or_expired` value for all of them.
one of: found, not_found, restricted
Why the invite was not returned; null when found.
one of: unknown_or_expired, not_found, null
The invite when `lookupStatus` is `found`.
The invite code.
Invite kind: `guild` for a server invite; `group_dm`, `friend` and `unknown` cover the rest.
one of: guild, group_dm, friend, unknown
When a temporary invite expires, ISO 8601 UTC; null for a permanent one.
The channel the invite lands in.
Channel id.
Channel name.
Channel kind: `text`, `announcement`, or `unknown` for any other kind.
one of: text, announcement, unknown
Discord's channel type.
The server behind the invite when it was found.
Server id.
Server name.
Short description shown in the directory.
Server icon URL.
Invite splash URL.
Discovery splash URL.
Banner URL.
Custom invite banner URL, when a working image path is known.
The custom invite banner hash. No image URL is available for it.
Member count; live on an invite, indexed elsewhere.
Online member count; live on an invite, indexed elsewhere.
Whether `members` and `online` are live or indexed.
one of: live, index, null
Boost count and tier, when present.
Boost count.
Boost tier.
The server's preferred locale, e.g. `en-US`.
The server's verification level.
one of: none, low, medium, high, very_high, unknown, null
Whether the server is age-restricted.
Discord's NSFW level value.
The server's vanity invite code, when it has one.
The server tag shown on the invite card.
The server tag's badge, when it has one.
Discord's badge id.
Badge image hash.
Badge image URL.
Badge colours as hex strings.
Primary badge colour.
Secondary badge colour.
The invite card's brand colour.
Labels the server shows on its invite card.
The trait label.
Emoji name shown with the trait, or null.
Custom emoji id shown with the trait, or null.
Whether the custom emoji is animated; null when absent.
Games the invite card shows for this server.
The game's application id.
How active the game is on the server, as Discord ranks it.
Discord's activity score for the game on the server.
The server's feature flags, passed through.
Feature flags from the invite card's profile block, when present.
The invite card profile visibility value, when given.
The invite's public flags value, when given.
The server's age-gate properties, passed through.
Search keywords listed for the server.
Directory categories the server belongs to.
Category id.
Category name; null when unknown.
True on `primaryCategory`, which is primary by definition. On a list entry, whether it is the server's primary category, or null when the page names no primary.
Localised category names, keyed by locale, passed through.
The server's primary directory category.
Category id.
Category name; null when unknown.
True on `primaryCategory`, which is primary by definition. On a list entry, whether it is the server's primary category, or null when the page names no primary.
Localised category names, keyed by locale, passed through.
When the server was created, ISO 8601 UTC.
Reasons to join that the server lists.
The reason text.
Emoji name, or null.
Custom emoji id, or null.
Social links the server lists.
The server's long about text.
Directory category ids the server lists.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
min 1 chars
Credits charged for this request.
≥ 0
Public API version that served the response.
one of: v1
Code example
curl "https://api.socialfetch.dev/v1/discord/invites/python" \
-H "x-api-key: YOUR_API_KEY"Responses
Invite.