Discord Server Widget
discord.server.get_widget
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.
At a glance
- Endpoint ID
discord.server.get_widget- Price
- 1 credit per call; failed calls are free
- Runs for up to
- 30 seconds
Request
Send the endpoint ID as capability and its fields as input. Set UPSCRAPE_API_KEY to your key first.
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));
Input
| Field | Type | Required | What it does | Example |
|---|---|---|---|---|
guild_id |
string | yes | Numeric Discord server (guild) ID. | 267624335836053506 |
Response
A finished call answers with HTTP 200; the data is in results[0].data, and billing.credits_charged is what it cost. A call still running after the wait answers 202: see jobs and results.
This is results[0].data from a real run:
{ "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" } ]}
Fields
| 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 |
If a call fails
A failed call costs nothing. The response carries an error.code you can branch on; Errors and retries lists every code and which ones to retry.
Other Discord endpoints
Something missing or unclear? Ask the team that builds the Discord endpoints.