> **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`). --- # Search Polymarket (https://www.socialfetch.dev/docs/api/v1/polymarket/search/get) ## Summary Search Polymarket events, tags and profiles by keyword. **Tags:** `Polymarket` ## HTTP - **Method:** GET - **Path:** `/v1/polymarket/search` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.polymarket.search({ query: "election", types: ["events", "tags"] })` - **Accepted identifiers:** `query` (query) - **Pagination:** page via `page`, next page: `data.page.nextPage`, 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 ### `query` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Search text. The index is English: other scripts return nothing. ### `types` (query) - **Required:** no - **Constraints:** type `array` - **Description:** What to search, comma separated: `events`, `tags`, `profiles`. Default: `events,tags`. ### `page` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 100 - **Description:** Page number, 1–100. Default: 1. Polymarket can stop a deep page early and report `hasMore: false`. ### `limitPerType` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 50 - **Description:** Items per page, 1–50. Default: 10. ### `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. ## Responses (status codes) - **200**: Polymarket search. - **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 search. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. `found` when the search ran. No hits is an empty list. - **query** (required) — type `string`. The search text. - **events** (required) — type `array`. Matching events. - _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:_ - **tags** (required) — type `array`. Matching tags. - _items:_ - **id** (required) — type `string`. Tag id. - **label** (required) — type `string`. Tag name, for example `Politics`. - **slug** (required) — type `string`. Tag slug. - **createdAt** (required) — type `string`; nullable. When the tag was created (ISO-8601, UTC). - **updatedAt** (required) — type `string`; nullable. When the tag was last changed (ISO-8601, UTC). - **profiles** (required) — type `array`. Matching profiles. - _items:_ - **wallet** (required) — type `string`. Wallet address. - **name** (required) — type `string`; nullable. Chosen username, as Polymarket sends it. Present even when the holder does not show it on their own profile (see `usernamePublic`). - **usernamePublic** (required) — type `boolean`; nullable. Whether the holder shows the chosen username publicly on their profile. - **pseudonym** (required) — type `string`; nullable. Auto-generated name. - **image** (required) — type `string`; nullable. Profile image URL. - **totalResults** (required) — type `integer`; nullable. Matching events across all pages. - **page** (required) — type `object`. Pagination state for the current page. - **page** (required) — type `integer`; minimum: 0. Current page number (1-based). - **hasMore** (required) — type `boolean`. Whether another page is available. - **nextPage** (required) — type `integer`; minimum: 0; nullable. Next page number 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", "query": "bitcoin", "events": [ { "id": "1283785", "slug": "bitcoin-above-on-november-6-2026", "url": "https://polymarket.com/event/bitcoin-above-on-november-6-2026", "title": "Bitcoin above ___ on November 6?", "description": "This market will resolve to \"Yes\" if the Binance 1 minute candle for BTC/USDT closing at 12:00 in the ET timezone (noon) on the date specified in the title has…", "status": "closed", "archived": false, "featured": false, "image": "https://polymarket-upload.s3.us-east-2.amazonaws.com/BTC+fullsize.png", "icon": "https://polymarket-upload.s3.us-east-2.amazonaws.com/BTC+fullsize.png", "startsAt": "2026-10-30T16:00:14.000Z", "endsAt": "2026-11-06T17:00:00.000Z", "closedAt": "2026-11-06T17:14:03.000Z", "createdAt": "2026-10-30T16:00:05.167Z", "updatedAt": "2026-11-07T05:09:46.685Z", "volume": { "total": 2015239.240235, "day": 1035879.184716, "week": 1962956.598365, "month": 1963102.1942470002, "year": 1963102.1942470002 }, "liquidity": null, "openInterest": 997395.964489, "commentCount": 0, "competitive": null, "negRisk": false, "isUserCreated": false, "resolutionSource": "https://www.binance.com/en/trade/BTC_USDT", "metadata": null, "marketCount": 11, "tags": [ { "id": "235", "label": "Bitcoin", "slug": "bitcoin", "createdAt": "2023-11-02T21:40:32.974Z", "updatedAt": "2026-04-17T20:39:34.210Z" } ], "series": [ { "id": "45", "slug": "btc-multi-strikes-weekly", "title": "BTC Multi Strikes Weekly" } ], "sports": null, "markets": [ { "id": "6423883", "slug": "bitcoin-above-68k-on-november-6-2026", "question": "Will the price of Bitcoin be above $68,000 on November 6?", "conditionId": "0xcdb2f010e8310f301ada4caff1cdbeba6da4eda74fdec5507210576f837eaa5a", "status": "closed", "groupTitle": "68,000", "outcomes": [ { "name": "Yes", "tokenId": "94374810691768600626762739701479727827766901905556938989055498697959112550416", "price": 1 } ], "lastTradePrice": 0.999, "bestBid": 0.999, "bestAsk": 1, "volume": 118065.44372500002, "liquidity": null } ] } ], "tags": [ { "id": "235", "label": "Bitcoin", "slug": "bitcoin", "createdAt": null, "updatedAt": null } ], "profiles": [], "totalResults": 153733, "page": { "page": 1, "hasMore": true, "nextPage": 2 } }, "meta": { "requestId": "req_0049ec59-d1ea-4514-872f-54728750dc53", "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.search({ query: "election", }); 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/search?query=election", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/polymarket/search?query=election" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/polymarket/search?query=election", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```