> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/discord/invites/code/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/discord/invites/code/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Discord invite (https://www.socialfetch.dev/docs/api/v1/discord/invites/code/get)

## Summary

Get a Discord invite's live member and online counts, the server behind it, its boosts, tag, traits and games.

**Tags:** `Discord`

## HTTP

- **Method:** GET
- **Path:** `/v1/discord/invites/{code}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.discord.getInvite({ code: "python" })`
- **Accepted identifiers:** `code` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `restricted`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `code` (path)

- **Required:** yes
- **Constraints:** type `string`; pattern: `^[A-Za-z0-9_-]{2,32}$`
- **Description:** 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.

## Responses (status codes)

- **200**: Invite.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Invite.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found, restricted. `not_found` for an unknown, expired or malformed code; `reason` uses the same `unknown_or_expired` value for all of them.
  - **reason** (required) — type `string`; enum: unknown_or_expired, not_found, null; nullable. Why the invite was not returned; null when found.
  - **invite** (required) — type `object`; nullable. The invite when `lookupStatus` is `found`.
    - **code** (required) — type `string`. The invite code.
    - **type** (required) — type `string`; enum: guild, group_dm, friend, unknown. Invite kind: `guild` for a server invite; `group_dm`, `friend` and `unknown` cover the rest.
    - **expiresAt** (required) — type `string`; nullable. When a temporary invite expires, ISO 8601 UTC; null for a permanent one.
    - **channel** (required) — type `object`; nullable. The channel the invite lands in.
      - **id** (required) — type `string`. Channel id.
      - **name** (required) — type `string`; nullable. Channel name.
      - **type** (required) — type `string`; enum: text, announcement, unknown. Channel kind: `text`, `announcement`, or `unknown` for any other kind.
      - **typeId** (required) — type `integer`; nullable. Discord's channel type.
  - **server** (required) — type `object`; nullable. The server behind the invite when it was found.
    - **id** (required) — type `string`. Server id.
    - **name** (required) — type `string`. Server name.
    - **description** (required) — type `string`; nullable. Short description shown in the directory.
    - **iconUrl** (required) — type `string`; nullable. Server icon URL.
    - **splashUrl** (required) — type `string`; nullable. Invite splash URL.
    - **discoverySplashUrl** (required) — type `string`; nullable. Discovery splash URL.
    - **bannerUrl** (required) — type `string`; nullable. Banner URL.
    - **customBannerUrl** (required) — type `string`; nullable. Custom invite banner URL, when a working image path is known.
    - **customBannerHash** (required) — type `string`; nullable. The custom invite banner hash. No image URL is available for it.
    - **members** (required) — type `integer`; nullable. Member count; live on an invite, indexed elsewhere.
    - **online** (required) — type `integer`; nullable. Online member count; live on an invite, indexed elsewhere.
    - **countsAsOf** (required) — type `string`; enum: live, index, null; nullable. Whether `members` and `online` are live or indexed.
    - **boosts** (required) — type `object`; nullable. Boost count and tier, when present.
      - **count** (required) — type `integer`; nullable. Boost count.
      - **tier** (required) — type `integer`; nullable. Boost tier.
    - **locale** (required) — type `string`; nullable. The server's preferred locale, e.g. `en-US`.
    - **verificationLevel** (required) — type `string`; enum: none, low, medium, high, very_high, unknown, null; nullable. The server's verification level.
    - **ageRestricted** (required) — type `boolean`; nullable. Whether the server is age-restricted.
    - **nsfwLevel** (required) — type `integer`; nullable. Discord's NSFW level value.
    - **vanityCode** (required) — type `string`; nullable. The server's vanity invite code, when it has one.
    - **tag** (required) — type `string`; nullable. The server tag shown on the invite card.
    - **tagBadge** (required) — type `object`; nullable. The server tag's badge, when it has one.
      - **id** (required) — type `integer`; nullable. Discord's badge id.
      - **hash** (required) — type `string`; nullable. Badge image hash.
      - **url** (required) — type `string`; nullable. Badge image URL.
      - **colors** (required) — type `object`. Badge colours as hex strings.
    - **brandColor** (required) — type `string`; nullable. The invite card's brand colour.
    - **traits** (required) — type `array`. Labels the server shows on its invite card.
      - _items:_
    - **games** (required) — type `array`. Games the invite card shows for this server.
      - _items:_
    - **features** (required) — type `array`. The server's feature flags, passed through.
      - _items:_
        - type `string`
    - **profileFeatures** (required) — type `array`. Feature flags from the invite card's profile block, when present.
      - _items:_
        - type `string`
    - **profileVisibility** (required) — type `integer`; nullable. The invite card profile visibility value, when given.
    - **flags** (required) — type `integer`; nullable. The invite's public flags value, when given.
    - **nsfwProperties** (required) — type `object`; nullable. The server's age-gate properties, passed through.
    - **keywords** (required) — type `array`. Search keywords listed for the server.
      - _items:_
        - type `string`
    - **categories** (required) — type `array`. Directory categories the server belongs to.
      - _items:_
    - **primaryCategory** (required) — type `object`; nullable. The server's primary directory category.
      - **id** (required) — type `integer`. Category id.
      - **name** (required) — type `string`; nullable. Category name; null when unknown.
      - **isPrimary** (required) — type `boolean`; nullable. 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.
      - **nameLocalizations** (required) — type `object`; nullable. Localised category names, keyed by locale, passed through.
    - **createdAt** (required) — type `string`; nullable. When the server was created, ISO 8601 UTC.
    - **reasonsToJoin** (required) — type `array`. Reasons to join that the server lists.
      - _items:_
    - **socialLinks** (required) — type `array`. Social links the server lists.
      - _items:_
        - type `string`
    - **about** (required) — type `string`; nullable. The server's long about text.
    - **categoryIds** (required) — type `array`. Directory category ids the server lists.
      - _items:_
        - type `integer`
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "reason": null,
    "invite": {
      "code": "python",
      "type": "guild",
      "expiresAt": null,
      "channel": {
        "id": "267631170882240512",
        "name": "welcome",
        "type": "text",
        "typeId": 0
      }
    },
    "server": {
      "id": "267624335836053506",
      "name": "Python",
      "description": "We're a large community focused around the Python programming language. We believe that anyone can learn to code.",
      "iconUrl": "https://cdn.discordapp.com/icons/267624335836053506/f4dfb709ab6c46f00116a36ba2ac9479.png?size=256",
      "splashUrl": "https://cdn.discordapp.com/splashes/267624335836053506/b7099fe221153a7faff76048dc2e63ef.jpg?size=2048",
      "discoverySplashUrl": null,
      "bannerUrl": "https://cdn.discordapp.com/banners/267624335836053506/147377ff8a73a5f0717c249d29ee947b.webp",
      "customBannerUrl": null,
      "customBannerHash": "99f4a269f925d0c495dc2711e78e00df",
      "members": 428389,
      "online": 34216,
      "countsAsOf": "live",
      "boosts": {
        "count": 29,
        "tier": 3
      },
      "locale": null,
      "verificationLevel": "medium",
      "ageRestricted": false,
      "nsfwLevel": 0,
      "vanityCode": "python",
      "tag": "snek",
      "tagBadge": {
        "id": 0,
        "hash": "fd3549e1a1a692afda2a7b4cf6b6cad6",
        "url": "https://cdn.discordapp.com/guild-tag-badges/267624335836053506/fd3549e1a1a692afda2a7b4cf6b6cad6.png",
        "colors": {
          "primary": "#008cff",
          "secondary": "#fdf300"
        }
      },
      "brandColor": null,
      "traits": [],
      "games": [],
      "features": [
        "PIN_PERMISSION_MIGRATION_COMPLETE"
      ],
      "profileFeatures": [
        "DISCOVERABLE"
      ],
      "profileVisibility": 1,
      "flags": 2,
      "nsfwProperties": null,
      "keywords": [],
      "categories": [],
      "primaryCategory": null,
      "createdAt": null,
      "reasonsToJoin": [],
      "socialLinks": [],
      "about": null,
      "categoryIds": []
    }
  },
  "meta": {
    "requestId": "req_367b53a0-5fef-4781-8556-678d5f0d2dc5",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.discord.getInvite({
  code: "python",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/discord/invites/python",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/discord/invites/python" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/discord/invites/python",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```