> **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`). --- # List Polymarket events (https://www.socialfetch.dev/docs/api/v1/polymarket/events/get) ## Summary List Polymarket events by volume, date, tag or title, with each event's markets. **Tags:** `Polymarket` ## HTTP - **Method:** GET - **Path:** `/v1/polymarket/events` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.polymarket.listEvents({ status: "open", limit: 5 })` - **Accepted identifiers:** `query` (query) - **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore` - **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 ### `status` (query) - **Required:** no - **Constraints:** type `string`; enum: open, closed, all - **Description:** Which items to list: `open` (default), `closed` (ended or resolved) or `all`. `open` is Polymarket's own flag and can outlast the end date. ### `tag` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 120; pattern: `^[A-Za-z0-9][A-Za-z0-9._-]*$` - **Description:** Only events with this tag: a tag id or slug. ### `query` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Words to find in event titles. Titles are English, so search in English. ### `sort` (query) - **Required:** no - **Constraints:** type `string`; enum: volume, volume24h, liquidity, startDate, endDate, createdAt, closedTime - **Description:** Sort field. Default: `volume`. ### `ascending` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Sort from smallest to largest. Default: false (largest first). ### `featured` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Only events Polymarket features (true) or only those it does not (false). ### `seriesId` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^\d{1,10}$` - **Description:** Only events in this series. ### `minVolume` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only events with at least this much volume (US dollars). ### `maxVolume` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only events with at most this much volume (US dollars). ### `minLiquidity` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only events with at least this much liquidity. ### `startDateFrom` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Only events starting on or after this date. ### `startDateTo` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Only events starting on or before this date. ### `endDateFrom` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Only events ending on or after this date. ### `endDateTo` (query) - **Required:** no - **Constraints:** type `string` - **Description:** Only events ending on or before this date. ### `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. ### `limit` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 25 - **Description:** Events per page, 1–25. Default: 20. Each event carries all of its markets and the busiest hold hundreds, so a page stays small. Use `cursor` for the next page. ### `cursor` (query) - **Required:** no - **Constraints:** type `string`; minLength: 1; maxLength: 6000 - **Description:** Pass `page.nextCursor` from the previous response to get the next page. Keep the other filters the same. ## Pagination This endpoint uses **cursor-based pagination** via the `cursor` query parameter. - Read **hasMore** from `data.page.hasMore`. - When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string). - Omit `cursor` on the **first** request. - Stop when **hasMore** is `false` or **nextCursor** is null (end of list). ## Responses (status codes) - **200**: Polymarket events. - **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 events. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` on success. - **events** (required) — type `array`. Events in the requested order, each with its markets. - _items:_ - **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. - **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. - **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. - **markets** (required) — type `array`. The event's markets, headline numbers only. - _items:_ - **page** (required) — type `object`. Pagination state for the current page. - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextCursor** (required) — type `string`; nullable. Cursor to pass in the next request when more pages exist; null on the last page. - **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", "events": [ { "id": "106116", "slug": "nv-01-house-election-winner", "url": "https://polymarket.com/event/nv-01-house-election-winner", "title": "NV-01 House Election Winner", "description": "This market will resolve according to the party of the candidate who wins the NV-01 congressional district seat in the U.S. House of Representatives in the 202…", "status": "closed", "archived": false, "featured": false, "image": "https://polymarket-upload.s3.us-east-2.amazonaws.com/nv-01-house-election-winner-MTOx653yZ-oz.png", "icon": "https://polymarket-upload.s3.us-east-2.amazonaws.com/nv-01-house-election-winner-MTOx653yZ-oz.png", "startsAt": "2025-12-16T17:48:33.322Z", "endsAt": "2026-11-04T04:59:00.000Z", "closedAt": "2026-11-04T12:07:19.000Z", "createdAt": "2025-12-15T20:54:16.751Z", "updatedAt": "2026-11-04T12:08:19.968Z", "volume": { "total": 38881.97674500001, "day": 1169.92506, "week": 2123.61274, "month": 6641.154979, "year": 38881.976745 }, "liquidity": 0, "openInterest": 6709.778912, "commentCount": 0, "competitive": 0, "negRisk": true, "isUserCreated": false, "resolutionSource": null, "metadata": null, "marketCount": 8, "tags": [ { "id": "102289", "label": "Midterms", "slug": "midterms", "createdAt": "2025-06-19T20:54:40.884Z", "updatedAt": "2026-04-17T20:51:49.953Z" } ], "series": [], "sports": null, "markets": [ { "id": "942885", "slug": "will-the-republican-party-win-the-nv-01-house-seat", "question": "Will the Republican Party win the NV-01 House seat?", "conditionId": "0xaf681bb7e57ee20f081c575c293c61d956c95e3c08246d216c5df123bcc1ff7c", "status": "closed", "groupTitle": "Carrie Buck (R)", "outcomes": [ { "name": "Yes", "tokenId": "100936365235088365887390148339025781650492541691117144201293268974573722080526", "price": 0 } ], "lastTradePrice": 0.051, "bestBid": null, "bestAsk": 0.001, "volume": 18025.880045, "liquidity": null } ] } ], "page": { "hasMore": true, "nextCursor": "eyJvIjoicG9seW1hcmtldC5ldmVudHMubGlzdCIsImMiOiJPbFpwLVVZTW50VWRmTExFUHRVNUpJblRkeDdRLUI3T2ZGOEY2N1M4VnlKN0luWWlPakVzSW1zaU9pSmxkbVZ1ZEhNaUxDSnZhQ0k2SW1NMllqWXp…" } }, "meta": { "requestId": "req_66e8040c-7830-4883-aab9-65a88ecd2d49", "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.listEvents({ status: "open", limit: 5, }); 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?status=open&limit=5", { 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?status=open&limit=5" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/polymarket/events?status=open&limit=5", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ``` ### Example: next page (pagination) After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string): ```javascript const previous = await response.json(); const nextCursor = previous?.data?.page?.nextCursor; const hasMore = previous?.data?.page?.hasMore; if (!hasMore || nextCursor == null) { // no more pages } else { const nextUrl = new URL("https://api.socialfetch.dev/v1/polymarket/events"); nextUrl.searchParams.set("cursor", nextCursor); // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest"); const nextResponse = await fetch(nextUrl.toString(), { headers: { "x-api-key": "YOUR_API_KEY" }, }); const nextData = await nextResponse.json(); } ```