Discord API · Endpoint
Discord Server Widget Scraper API
Read a server's public widget: online presence count, voice channels, and a live sample of online members. A disabled widget is reported, not an error.
- 1 credit per call
- Failed calls are free
- Updated
- discord.server.get_widget
{ "name": "Python", "enabled": true, "instant_invite": "https://discord.com/invite/WgmmdFEg", "presence_count": 40126, "channels": [ { "name": "AFK", "id": "756327105389920306", "position": 22 }, { "name": "Code/Help", "id": "751592231726481530", "position": 20 } ], "members": [ { "username": "alen", "id": "4", "status": "idle" }, { "username": "ArrowSquid", "activity": "Monster Hunter Rise", "id": "10", "status": "online" } ]}
| # | Name | Position | Id |
|---|---|---|---|
| 1 | AFK | 22 | 756327105389920306 |
| 2 | Code/Help | 20 | 751592231726481530 |
| 3 | Main Stage Channel | 0 | 855798297763512341 |
What you send
The input
object of the request, with every field the endpoint accepts.
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
| guild_id | string | yes | Numeric Discord server (guild) ID. | 267624335836053506 |
Fields it returns
What each record in the response holds, with the values from the sample above.
| Field | Type | Example |
|---|---|---|
| channels[].name | string | AFK |
| channels[].id | string | 756327105389920306 |
| channels[].position | integer | 22 |
| name | string | Python |
| channels | array | 3 records |
| enabled | boolean | true |
| instant_invite | string | https://discord.com/invite/WgmmdFEg |
| members | array | 2 records |
| members[].id | string | 4 |
| members[].status | string | idle |
| members[].username | string | alen |
| presence_count | integer | 40,126 |
Call it from your code, or ask your agent
Set UPSCRAPE_API_KEY to your key and copy a working request.
curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "capability": "discord.server.get_widget", "input": { "guild_id": "267624335836053506" }}'
import jsonimport osimport requestspayload = json.loads(r'''{ "capability": "discord.server.get_widget", "input": { "guild_id": "267624335836053506" }}''')response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload,)response.raise_for_status()print(json.dumps(response.json(), indent=2))
const response = await fetch("https://data.upscrape.com/execute", { method: "POST", headers: { "Authorization": `Bearer ${process.env.UPSCRAPE_API_KEY}`, "Content-Type": "application/json", "Prefer": "wait=30", }, body: JSON.stringify({ "capability": "discord.server.get_widget", "input": { "guild_id": "267624335836053506" }}),});if (!response.ok) { throw new Error(`Upscrape request failed: ${response.status}`);}console.log(JSON.stringify(await response.json(), null, 2));
https://data.upscrape.com/mcp
With Upscrape, get the Discord server widget for guild id "267624335836053506". Tell me what it costs before you run it, then show the results as a table.
More from the Discord API
Discord Server Widget Scraper API FAQ
The short answers. The docs have the long ones.
How much does the Discord Server Widget Scraper API cost?
1 credit per successful call, shown before it runs. You buy credits once, and paid credits never expire.
What do I send?
Send guild_id. The input fields below list every option with its type and limits.
Do I need a Discord login?
No. It reads public Discord data; nothing runs on your account.
Can my AI agent call it?
Yes, over MCP: the agent finds discord.server.get_widget, checks its price and runs it with the same credits as the REST API.
Your first Discord call is free.
Up to 100 free credits to start, no card needed.