/discord/guilds

POST /api/discord/guilds

Price: 5 credits

Get Discord Server

How to use it

Get a public Discord server profile by ID or discovery page URL. Returns the rich discovery profile (about, social links, categories, keywords, reasons to join, creation date, member and online counts). Available only for servers listed in the public server discovery catalog.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• guild string required — Server ID or discovery page URL (examples: "662267976984297473", "https://discord.com/servers/midjourney-662267976984297473"; minLength: 1)

Response

• @type string (default: "DiscordGuild")
• id string required
• name string nullable
• description string nullable
• alias string nullable
• url string nullable
• image string nullable
• banner string nullable
• splash string nullable
• discovery_splash string nullable
• approximate_member_count integer nullable
• approximate_presence_count integer nullable
• premium_subscription_count integer nullable
• preferred_locale string nullable
• primary_category_id integer nullable
• category_ids array (default: [])
• categories array (default: [])
• keywords array (default: [])
• features array (default: [])
• is_verified boolean (default: false)
• is_partnered boolean (default: false)
• is_locked boolean (default: false)
• created_at integer nullable
• about string nullable
• social_links array (default: [])
• reasons_to_join array (default: [])
  • @type string (default: "DiscordGuildReason")
  • reason string required
  • emoji_name string 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 — Server not found or not listed in the public discovery catalog. 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.