> **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 markets (https://www.socialfetch.dev/docs/api/v1/polymarket/markets/get) ## Summary List Polymarket markets by volume, liquidity, tag or ids, with prices and rules. **Tags:** `Polymarket` ## HTTP - **Method:** GET - **Path:** `/v1/polymarket/markets` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.polymarket.listMarkets({ status: "open", limit: 10 })` - **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 - **Description:** Which markets to list: `open` (default) or `closed`. When you filter by `conditionIds` or `tokenIds` and omit this, open and closed markets are both searched. ### `tagId` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^\d{1,10}$` - **Description:** Only markets with this tag id. Find ids with the tags list. ### `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). ### `minVolume` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only markets with at least this much volume (US dollars). ### `maxVolume` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only markets with at most this much volume (US dollars). ### `minLiquidity` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only markets with at least this much liquidity. ### `maxLiquidity` (query) - **Required:** no - **Constraints:** type `number`; minimum: 0; maximum: 1000000000000000 - **Description:** Only markets with at most this much liquidity. ### `conditionIds` (query) - **Required:** no - **Constraints:** type `array` - **Description:** Only these markets, by condition id, up to 50. Repeat the parameter or separate ids with commas. For more ids use the batch endpoint. ### `tokenIds` (query) - **Required:** no - **Constraints:** type `array` - **Description:** Only the markets these outcome tokens belong to, up to 30. Repeat the parameter or separate ids with commas. For more ids use the batch endpoint. ### `sportsMarketType` (query) - **Required:** no - **Constraints:** type `string`; pattern: `^[a-z0-9_]{1,60}$` - **Description:** Only sports markets of this kind, such as `moneyline`. ### `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: 100 - **Description:** Items per page, 1–100. Default: 50. ### `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 markets. - **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 markets. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` on success. - **markets** (required) — type `array`. Markets in order. - _items:_ - **id** (required) — type `string`. Market id. - **slug** (required) — type `string`. Market slug. - **question** (required) — type `string`. The question the market asks. - **description** (required) — type `string`; nullable. Full resolution rules. - **conditionId** (required) — type `string`; nullable. Condition id (0x and 64 hex digits). Null for a market without an order book. - **eventId** (required) — type `string`; nullable. Id of the event the market belongs to. - **eventSlug** (required) — type `string`; nullable. Slug of the event the market belongs to. - **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 market. - **groupTitle** (required) — type `string`; nullable. Label inside a multi-market event, for example a candidate name. - **image** (required) — type `string`; nullable. Image URL. - **icon** (required) — type `string`; nullable. Icon URL. - **outcomes** (required) — type `array`. The outcomes, in order, with their current prices. - _items:_ - **winningOutcome** (required) — type `string`; nullable. Name of the outcome that won, once the market has closed with a clear winner. - **lastTradePrice** (required) — type `number`; nullable. Price of the last trade. - **bestBid** (required) — type `number`; nullable. Highest buy price on the book. - **bestAsk** (required) — type `number`; nullable. Lowest sell price on the book. - **spread** (required) — type `number`; nullable. Gap between best ask and best bid. - **priceChange** (required) — type `object`. Change of the leading outcome price over several windows. - **volume** (required) — type `object`. Traded volume in US dollars over several windows. - **liquidity** (required). Current order book liquidity in US dollars. A number, or an exact decimal string when the value has more digits than a number can hold. - **startsAt** (required) — type `string`; nullable. When the market opens (ISO-8601, UTC). - **endsAt** (required) — type `string`; nullable. Scheduled end (ISO-8601, UTC). - **closedAt** (required) — type `string`; nullable. When the market closed (ISO-8601, UTC). - **createdAt** (required) — type `string`; nullable. When the market was created (ISO-8601, UTC). - **updatedAt** (required) — type `string`; nullable. When the market was last changed (ISO-8601, UTC). - **resolution** (required) — type `object`. How and where the market resolves. - **negRisk** (required) — type `boolean`; nullable. Whether the market is part of a winner-takes-all group whose prices sum to about 100 percent. - **negRiskMarketId** (required) — type `string`; nullable. Id of the winner-takes-all group. - **minOrderSize** (required) — type `number`; nullable. Smallest order size in shares. - **tickSize** (required) — type `number`; nullable. Smallest price step. - **fees** (required) — type `object`. Trading fees on a market. - **cryptoMarketConfig** (required) — type `object`; nullable. Settings of a short-lived up-or-down market on a crypto or commodity price. - **acceptingOrders** (required) — type `boolean`; nullable. Whether the order book accepts orders. - **isUserCreated** (required) — type `boolean`. Whether a user rather than Polymarket created it. - **sportsMarketType** (required) — type `string`; nullable. Kind of sports market, for example `moneyline`. Null for other markets. - **line** (required) — type `number`; nullable. Spread or total line for a sports market. - **gameStartTime** (required) — type `string`; nullable. Kickoff of the game a sports market covers (ISO-8601, UTC). - **rewards** (required) — type `object`; nullable. Liquidity rewards offered on a market. - **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", "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, 20…", "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.06, "month": -0.01, "year": null }, "volume": { "total": 77385305.29938401, "day": 735836.6584669999, "week": 1831408.241519, "month": 5980460.278726, "year": 77461717.219574 }, "liquidity": 356982.5618, "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:09:57.793Z", "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 } } ], "page": { "hasMore": true, "nextCursor": "eyJvIjoicG9seW1hcmtldC5tYXJrZXRzLmxpc3QiLCJjIjoiem1KQ01aTWJ3bHFRZ3J4WHA1ZGh4cTlLbG9oZkltdGFlRHVRenpMRGRfVjdJbllpT2pFc0ltc2lPaUp0WVhKclpYUnpJaXdpYjJnaU9pSXdZbVE…" } }, "meta": { "requestId": "req_48e2f384-9420-4880-948a-4d57657f6693", "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.listMarkets({ status: "open", limit: 10, }); 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/markets?status=open&limit=10", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/polymarket/markets?status=open&limit=10" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/polymarket/markets?status=open&limit=10", 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/markets"); 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(); } ```