> **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):** - **Markdown (.mdx) URL:** ## 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:** ## 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 Polymarket event (https://www.socialfetch.dev/docs/api/v1/polymarket/events/eventidorslug/get) ## Summary Get a Polymarket event with all its markets, prices and resolution rules. **Tags:** `Polymarket` ## HTTP - **Method:** GET - **Path:** `/v1/polymarket/events/{eventIdOrSlug}` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.polymarket.getEvent({ eventIdOrSlug: "democratic-presidential-nominee-2028" })` - **Accepted identifiers:** `eventIdOrSlug` (path) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## 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 ### `eventIdOrSlug` (path) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 300; pattern: `^[A-Za-z0-9_]+(?:-[A-Za-z0-9_]+)*$` - **Description:** Event id (digits) or slug, as in polymarket.com/event/{slug}. ### `locale` (query) - **Required:** no - **Constraints:** type `string`; enum: es, fr, de, ja, zh, ko, ru, hi, th, tr, vi, pt, it, pl, id, bn, uk, zh-hant, tl - **Description:** Translate titles and market questions into this language. Descriptions stay in English. ### `include` (query) - **Required:** no - **Constraints:** type `array` - **Description:** Extras to add, comma separated: `insights` (the written market context) and `annotations` (dated explanations of price moves). Each is one extra lookup and can be absent, in which case it is null. ## Responses (status codes) - **200**: Polymarket event. - **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) Polymarket event. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `not_found` when no event has this id or slug. - **event** (required) — type `object`; nullable. An event with its full markets. - **id** (required) — type `string`. Event id. - **slug** (required) — type `string`. Event slug, as in polymarket.com/event/{slug}. - **url** (required) — type `string`. Link to the event on polymarket.com. - **title** (required) — type `string`. Event title. - **description** (required) — type `string`; nullable. Event description and resolution rules. - **status** (required) — type `string`; enum: open, closed, inactive. Polymarket's own state: `open`, `closed` or `inactive`. An open event or market can carry an end date in the past. - **archived** (required) — type `boolean`. Whether Polymarket archived the event. - **featured** (required) — type `boolean`. Whether Polymarket features the event. - **image** (required) — type `string`; nullable. Image URL. - **icon** (required) — type `string`; nullable. Icon URL. - **startsAt** (required) — type `string`; nullable. When the event starts (ISO-8601, UTC). - **endsAt** (required) — type `string`; nullable. Scheduled end (ISO-8601, UTC). - **closedAt** (required) — type `string`; nullable. When the event closed (ISO-8601, UTC). - **createdAt** (required) — type `string`; nullable. When the event was created (ISO-8601, UTC). - **updatedAt** (required) — type `string`; nullable. When the event was last changed (ISO-8601, UTC). - **volume** (required) — type `object`. Traded volume in US dollars over several windows. - **total** (required). All-time traded volume in US dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **day** (required). Volume in the last 24 hours. A number, or an exact decimal string when the value has more digits than a number can hold. - **week** (required). Volume in the last 7 days. A number, or an exact decimal string when the value has more digits than a number can hold. - **month** (required). Volume in the last 30 days. A number, or an exact decimal string when the value has more digits than a number can hold. - **year** (required). Volume in the last 365 days. A number, or an exact decimal string when the value has more digits than a number can hold. - **liquidity** (required). Current liquidity in US dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **openInterest** (required). Value of all open positions in US dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **commentCount** (required) — type `integer`; nullable. Number of comments. - **competitive** (required) — type `number`; nullable. How close the leading outcomes are, 0 to 1. - **negRisk** (required) — type `boolean`. Whether the markets form a winner-takes-all group whose prices sum to about 100 percent. - **isUserCreated** (required) — type `boolean`. Whether a user rather than Polymarket created it. - **resolutionSource** (required) — type `string`; nullable. Where the outcome is decided. - **metadata** (required) — type `object`; nullable. Extra details Polymarket attaches to some events. - **priceToBeat** (required) — type `number`; nullable. For an up-or-down market: the price the outcome is measured against. - **finalPrice** (required) — type `number`; nullable. For an up-or-down market: the price it settled at. - **gameId** (required) — type `string`; nullable. Game id of a sports event. - **league** (required) — type `string`; nullable. League or competition. - **leagueTier** (required) — type `string`; nullable. Tier of the league. - **tournament** (required) — type `string`; nullable. Tournament or stage. - **originalStart** (required) — type `string`; nullable. When the event was first scheduled to start (ISO-8601, UTC). - **marketCount** (required) — type `integer`. Number of markets in the event. - **tags** (required) — type `array`. Topic tags. - _items:_ - **series** (required) — type `array`. Series the event belongs to. - _items:_ - **sports** (required) — type `object`; nullable. Game details on a sports event. - **gameId** (required) — type `integer`; nullable. Game id. - **league** (required) — type `string`; nullable. League code, for example `lal`. - **leagueName** (required) — type `string`; nullable. League name. - **score** (required) — type `string`; nullable. Current score, for example `1-0`. - **period** (required) — type `string`; nullable. Current period of the game. - **elapsed** (required) — type `string`; nullable. Elapsed game time. - **live** (required) — type `boolean`; nullable. Whether the game is in play. - **ended** (required) — type `boolean`; nullable. Whether the game has ended. - **startTime** (required) — type `string`; nullable. Kickoff (ISO-8601, UTC). - **week** (required) — type `integer`; nullable. Week of the season. - **teams** (required) — type `array`. The teams playing. - _items:_ - **markets** (required) — type `array`. The event's markets with full detail. - _items:_ - **insights** (required) — type `object`; nullable. The market context text. Null unless requested with `include=insights`, or when the event has none. - **text** (required) — type `string`. A written summary of the news and context behind the event's prices. Machine written; dates inside it may be old. - **updatedAt** (required) — type `string`; nullable. When the text was written (ISO-8601, UTC). - **annotations** (required) — type `array`; nullable. Dated price-move explanations. Null unless requested with `include=annotations`, or when unavailable. - _items:_ - **at** (required) — type `string`. When the price moved (ISO-8601, UTC). - **title** (required) — type `string`. Headline of the explanation. - **summary** (required) — type `string`; nullable. What happened and why the price moved. - **outcome** (required) — type `string`; nullable. The outcome whose price moved. - **priceBefore** (required) — type `number`; nullable. Price before the move (0 to 1). - **priceAfter** (required) — type `number`; nullable. Price after the move (0 to 1). - **priceChange** (required) — type `number`; nullable. Size of the move. - **sources** (required) — type `array`. News articles cited for the move. - _items:_ - **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", "event": { "id": "73130", "slug": "will-the-us-invade-iran-before-2027", "url": "https://polymarket.com/event/will-the-us-invade-iran-before-2027", "title": "Will the U.S. invade Iran before 2027?", "description": "This market will resolve to \"Yes\" if the United States commences a military offensive intended to establish control over any portion of Iran by December 31, 2026, 11:59 PM ET. Otherwise, this market will resolve to \"No\".\n\nFor the purposes of this market, land de facto controlled by Iran or the United States as of Nove…", "status": "open", "archived": false, "featured": true, "image": "https://polymarket-upload.s3.us-east-2.amazonaws.com/will-the-us-invade-iran-in-2025-0Eh3J0ku_Fbj.jpg", "icon": "https://polymarket-upload.s3.us-east-2.amazonaws.com/will-the-us-invade-iran-in-2025-0Eh3J0ku_Fbj.jpg", "startsAt": "2025-11-05T17:52:17.414Z", "endsAt": "2027-01-01T04:59:00.000Z", "closedAt": null, "createdAt": "2025-11-04T19:52:57.169Z", "updatedAt": "2026-11-04T12:02:15.246Z", "volume": { "total": 77384823.165098, "day": 660377.163822, "week": 1756043.191318, "month": 5905583.463819999, "year": 77386252.16937302 }, "liquidity": 357494.9148, "openInterest": 6570895.297184, "commentCount": 1, "competitive": 0.8824372917999515, "negRisk": false, "isUserCreated": false, "resolutionSource": null, "metadata": null, "marketCount": 1, "tags": [ { "id": "104007", "label": "Military Strikes", "slug": "military-strikes", "createdAt": "2026-03-02T19:51:19.151Z", "updatedAt": "2026-04-17T20:50:04.318Z" } ], "series": [ { "id": "10135", "slug": "us-to-invade-iran", "title": "US to invade Iran" } ], "sports": null, "markets": [ { "id": "665374", "slug": "will-the-us-invade-iran-before-2027", "question": "Will the U.S. invade Iran before 2027?", "description": "This market will resolve to \"Yes\" if the United States commences a military offensive intended to establish control over any portion of Iran by December 31, 2026, 11:59 PM ET. Otherwise, this market will resolve to \"No\".\n\nFor the purposes of this market, land de facto controlled by Iran or the United States as of Nove…", "conditionId": "0x5db999fad322cea2914535aae5517060c3f80ad6d8c0231cde2124a434d16846", "eventId": "73130", "eventSlug": "will-the-us-invade-iran-before-2027", "status": "open", "archived": false, "groupTitle": null, "image": "https://polymarket-upload.s3.us-east-2.amazonaws.com/will-the-us-invade-iran-in-2025-0Eh3J0ku_Fbj.jpg", "icon": "https://polymarket-upload.s3.us-east-2.amazonaws.com/will-the-us-invade-iran-in-2025-0Eh3J0ku_Fbj.jpg", "outcomes": [ { "name": "Yes", "tokenId": "55115078421062885512539156303747803058407616201213034911037320915726138659123", "price": 0.135 } ], "winningOutcome": null, "lastTradePrice": 0.13, "bestBid": 0.13, "bestAsk": 0.14, "spread": 0.01, "priceChange": { "hour": -0.01, "day": -0.04, "week": -0.05, "month": -0.02, "year": null }, "volume": { "total": 77384823.165098, "day": 660377.163822, "week": 1756043.191318, "month": 5905583.463819999, "year": 77386252.16937302 }, "liquidity": 362898.6447, "startsAt": "2025-11-05T17:52:17.414Z", "endsAt": "2027-01-01T04:59:00.000Z", "closedAt": null, "createdAt": "2025-11-04T19:52:57.799Z", "updatedAt": "2026-11-04T12:01:58.370Z", "resolution": { "source": null, "umaStatus": null, "resolvedBy": "0x65070BE91477460D8A7AeEb94ef92fe056C2f2A7" }, "negRisk": false, "negRiskMarketId": null, "minOrderSize": 5, "tickSize": 0.01, "fees": { "enabled": false, "type": null, "makerBaseFee": null, "takerBaseFee": null, "makerRebatesFeeShareBps": null, "schedule": null }, "cryptoMarketConfig": null, "acceptingOrders": true, "isUserCreated": false, "sportsMarketType": null, "line": null, "gameStartTime": null, "rewards": { "dailyRate": 30, "minSize": 200, "maxSpread": 3.5 } } ] }, "insights": null, "annotations": null }, "meta": { "requestId": "req_c4ee05d1-7378-40db-bbdd-c3da12ac3e16", "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.polymarket.getEvent({ eventIdOrSlug: "democratic-presidential-nominee-2028", }); 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/polymarket/events/democratic-presidential-nominee-2028", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/polymarket/events/democratic-presidential-nominee-2028" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/polymarket/events/democratic-presidential-nominee-2028", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```