{ "openapi": "3.0.1", "info": { "title": "Polymarket Markets Scraper", "description": "Scrape Polymarket prediction markets: odds, prices, volume, liquidity, order book, price history and trades. Search by keyword, category or market URL. Export to JSON, CSV or Excel.", "version": "0.0", "x-build-id": "AsHITfsAOdl7LC8xg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nice_dev~polymarket-markets-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nice_dev-polymarket-markets-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nice_dev~polymarket-markets-scraper/runs": { "post": { "operationId": "runs-sync-nice_dev-polymarket-markets-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nice_dev~polymarket-markets-scraper/run-sync": { "post": { "operationId": "run-sync-nice_dev-polymarket-markets-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "startUrls": { "title": "Start URLs", "maxItems": 1000, "type": "array", "description": "Polymarket URLs to start from: event pages (`https://polymarket.com/event/`), single market pages (`https://polymarket.com/event//`) or category pages (`https://polymarket.com/markets/`). When this list is not empty, the search fields below (keyword, categories, identifiers) are ignored; the market status, the sort, the filters, the caps and the monitoring still apply to every page. Max 1 000 URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "query": { "title": "Search keyword", "maxLength": 200, "type": "string", "description": "Free-text search, as typed on the site (e.g. `bitcoin`, `election`). Polymarket searches events, so every market of every matching event is returned. Empty = no keyword filter, the whole catalogue is walked (use the filters and caps below). With a keyword every filter, the status of the markets too, is checked on our side: each results page is charged as a filtered page ($0.0002)." }, "searchQueries": { "title": "More search keywords", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Several keywords in one run: one search per keyword. Added to **Search keyword**; a market found by several searches is saved once.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Categories", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Polymarket category slugs, as in the site URL `polymarket.com/markets/` (e.g. `politics`, `crypto`, `sports`). A category typed as the site shows it (`Pop Culture`, `US Politics`) is looked up as the slug of its page (`pop-culture`, `us-politics`); case does not matter. Each category is one search, combined with the keywords above (max 500 searches per run). A slug the site does not know stops the run before anything is charged.", "default": [], "items": { "type": "string" } }, "tagIds": { "title": "Tag IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Polymarket numeric tag ids (e.g. `21` for crypto), for the tags that have no slug. Same effect as **Categories**.", "default": [], "items": { "type": "string" } }, "marketSlugs": { "title": "Market slugs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Exact market slugs (the last part of a market URL, e.g. `will-bitcoin-hit-200k-in-2026`). Each one is fetched directly — no search, no pagination.", "default": [], "items": { "type": "string" } }, "eventSlugs": { "title": "Event slugs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Exact event slugs (e.g. `next-prime-minister-of-ethiopia`). Every market of the event is returned.", "default": [], "items": { "type": "string" } }, "conditionIds": { "title": "Condition IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "On-chain condition ids (`0x…`), as used by the CLOB and by the trade API. Each one is fetched directly.", "default": [], "items": { "type": "string" } }, "marketIds": { "title": "Market IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Numeric Polymarket market ids (e.g. `559651`). Each one is fetched directly.", "default": [], "items": { "type": "string" } }, "outcomeTokenIds": { "title": "Outcome token IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "CLOB token ids of an outcome (the `clobTokenIds` of a market, long decimal numbers): the market of each token is fetched directly — either outcome's token finds it.", "default": [], "items": { "type": "string" } }, "status": { "title": "Market status", "enum": [ "open", "closed", "resolved", "all" ], "type": "string", "description": "Which markets to return. `open` = still accepting orders. `closed` = finished, whatever the outcome. `resolved` = finished AND settled, with the winning outcome. `all` = everything, open and finished. Applies to exact identifiers and pasted market URLs too: a market that has finished is only returned with `closed`, `resolved` or `all`. `resolved` is checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": "open" }, "sortBy": { "title": "Sort by", "enum": [ "volume24hr", "volume", "liquidity", "startDate", "endDate", "createdAt", "spread", "competitive" ], "type": "string", "description": "Order the site returns the markets in — it decides which markets come first when **Max markets** stops the run. Applies to the catalogue and category searches; a keyword search comes in the site's own relevance order.", "default": "volume24hr" }, "sortDescending": { "title": "Sort descending", "type": "boolean", "description": "Highest value first (biggest volume, latest date). Untick for the other way round.", "default": true }, "maxItems": { "title": "Max markets", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Maximum number of markets to save for the whole run (after deduplication and filters). 0 = no limit — the whole catalogue is over 40 000 open markets.", "default": 100 }, "maxItemsPerQuery": { "title": "Max markets per search", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Cap for EACH search (keyword, category or start URL), so that the first search cannot use up the whole **Max markets** budget. 0 = no per-search cap.", "default": 0 }, "includeEvent": { "title": "Include parent event", "type": "boolean", "description": "Add the parent event (title, description, slug, URL, total volume, open interest, comment count).", "default": true }, "includeTags": { "title": "Include tags", "type": "boolean", "description": "Add the market's categories/tags (label and slug).", "default": true }, "includeOrderBook": { "title": "Include order book", "type": "boolean", "description": "Add the live CLOB order book (bids and asks with price and size) for every outcome. The books of 100 markets come in one extra request. Option charged $0.0001 per market that gets a book ($0.10 per 1,000; a closed market has none) — untick it for the markets alone, $0.09 per 1,000.", "default": true }, "orderBookDepth": { "title": "Order book depth", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many price levels to keep on each side of the book. 0 = the whole book.", "default": 10 }, "includePriceHistory": { "title": "Include price history", "type": "boolean", "description": "Add the price time series for every outcome: at the default resolution (one point an hour) 25 points over the last day (the default range), 744 over a month; up to about 4,500 at ten minutes over a month. One extra request per market, and a much heavier item — off by default. Option charged $0.0001 per market ($0.10 per 1,000).", "default": false }, "priceHistoryInterval": { "title": "Price history range", "enum": [ "1h", "6h", "1d", "1w", "1m", "max" ], "type": "string", "description": "How far back the price history goes.", "default": "1d" }, "priceHistoryFidelity": { "title": "Price history resolution", "minimum": 1, "maximum": 10080, "type": "integer", "description": "Minutes between two points of the price history (60 = one point per hour). Lower = more points, heavier items. Polymarket's own floor: at least 5 for a week, at least 10 for a month, at least 720 for the whole life of a market (finer, Polymarket only gives the last 31 days: use the range of dates below) — a finer value is refused before the run starts.", "default": 60 }, "priceHistoryStartDate": { "title": "Price history from", "type": "string", "description": "A range of dates for the price history instead of the range above: from this date, `2026-08-01`, or a period before now such as `30 days`, `6 months` (API: full ISO date-times work too). Any resolution, one extra request per 15 days of range per market, up to 750 days. The first 15 days are in the price of the option; each 15 days after them is an extra option page, $0.00003 (750 days: up to $0.0015 more per market)." }, "priceHistoryEndDate": { "title": "Price history until", "type": "string", "description": "End of that range (the whole day is included): `2026-08-31`, or a period before now such as `7 days`. Empty = until now." }, "includeRecentTrades": { "title": "Include recent trades", "type": "boolean", "description": "Add the latest trades of the market (side, size, price, time, wallet, trader pseudonym). One extra request per market — off by default. Option charged $0.0001 per market ($0.10 per 1,000).", "default": false }, "recentTradesLimit": { "title": "Recent trades per market", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many trades to keep per market, newest first: up to 1,000, in one extra request whatever the number.", "default": 100 }, "minTradeSizeUsd": { "title": "Min trade size (whale mode)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Keep only the trades worth at least this much in USD (Polymarket's own filter, so the big trades are not lost behind the small ones). 0 = every trade.", "default": 0 }, "includeTopHolders": { "title": "Include top holders", "type": "boolean", "description": "Add the biggest position holders of the market (wallet, pseudonym, user name, verified badge, picture, size), per outcome. One extra request per market. Option charged $0.0001 per market ($0.10 per 1,000). These are public on-chain identities — off by default.", "default": false }, "maxHoldersPerOutcome": { "title": "Top holders per outcome", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many holders to keep per outcome, biggest first: up to 500, in one extra request whatever the number.", "default": 20 }, "includeComments": { "title": "Include event comments", "type": "boolean", "description": "Add the comments of the market's event (text, author, date, reactions, replies with their thread, pictures). The markets of one event each carry the same comments. Switches 'Include parent event' on. One extra request per 100 threads per market: option charged $0.0001 per market ($0.10 per 1,000) with the first 100 threads, each 100 after them an extra option page, $0.00003. Authors are public identities — off by default.", "default": false }, "maxCommentsPerEvent": { "title": "Comments per event", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many comment threads to keep per event, newest first, their replies along: up to 1,000 (one extra request per 100 threads). Each 100 after the first is an extra option page, $0.00003 — 1,000 threads: up to $0.0003 more per market.", "default": 100 }, "minVolume24h": { "title": "Min 24h volume", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only markets traded at least this much (USD) over the last 24 hours. 0 = no minimum. Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": 0 }, "minVolume": { "title": "Min total volume", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only markets whose all-time volume (USD) reaches this. 0 = no minimum.", "default": 0 }, "minLiquidity": { "title": "Min liquidity", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only markets with at least this much liquidity (USD) in the order book. 0 = no minimum.", "default": 0 }, "minOpenInterest": { "title": "Min open interest", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Only markets whose event holds at least this much open interest (USD: the value of every open position). 0 = no minimum. Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": 0 }, "minSpread": { "title": "Min spread", "minimum": 0, "maximum": 1, "type": "number", "description": "Only markets whose bid-ask spread is at least this, in probability points. 0 = no minimum. Useful to look for the markets where the price is still being argued over. Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": 0 }, "maxSpread": { "title": "Max spread", "minimum": 0, "maximum": 1, "type": "number", "description": "Only markets whose bid-ask spread is at most this, in probability points (0.05 = 5 cents). 0 = no maximum. Useful to drop the markets nobody is really quoting. Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": 0 }, "minPriceChangePct": { "title": "Min 24h price move", "minimum": 0, "maximum": 100, "type": "number", "description": "Only markets whose price moved by at least this many percentage points over 24 hours, up or down (5 = 5 points). 0 = no minimum. Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": 0 }, "endingWithinMinutes": { "title": "Ending within", "minimum": 0, "maximum": 5256000, "type": "integer", "description": "Only markets that close within this many minutes from now (60 = the next hour). 0 = no limit. Markets without an end date are dropped.", "default": 0 }, "postedAfter": { "title": "Started after", "type": "string", "description": "Only markets that opened on or after this date: `2026-09-01`, or a period before now such as `7 days`, `2 weeks`, `1 month` (API: `24 hours` and full ISO date-times work too). Reads the market's start date; markets without one are dropped." }, "postedBefore": { "title": "Started before", "type": "string", "description": "Only markets that opened on or before this date (the whole day is included), or older than a period such as `30 days`. Reads the market's start date." }, "endingAfter": { "title": "Ending after", "type": "string", "description": "Only markets whose end date is on or after this date, or after a period from now such as `7 days`. Markets without an end date are dropped." }, "endingBefore": { "title": "Ending before", "type": "string", "description": "Only markets whose end date is on or before this date, or before a period from now such as `30 days`. Open markets already past their end date (not settled yet) are kept too; the `endingWithinMinutes` window starts from now." }, "excludeKeywords": { "title": "Exclude keywords", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Drop the markets whose question contains one of these words (case and accents ignored). Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": [], "items": { "type": "string" } }, "feeTypes": { "title": "Fee categories", "maxItems": 30, "uniqueItems": true, "type": "array", "description": "Only the markets of these Polymarket fee categories, e.g. `politics_fees`, `sports_fees_v3`, `crypto_fees_v2`, `zero_fees`; `none` = the markets without a fee category. Empty = every market. Checked on our side: each results page read for it is charged as a filtered page ($0.0002).", "default": [], "items": { "type": "string" } }, "onlyNew": { "title": "Only new markets", "type": "boolean", "description": "Skip the markets that a previous run (same **Memory key**) already delivered: they are not saved and not charged, and their order book is not even fetched. First run = everything is new. A market delivered open is not returned again once it resolves: give a `resolved` schedule its own Memory key.", "default": false }, "stateKey": { "title": "Memory key", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "maxLength": 64, "type": "string", "description": "Name of the memory used by **Only new markets**. Give each schedule / task its own key (e.g. `crypto-hourly`) so that they do not share their memory. Letters, digits, `-` and `_`.", "default": "default" }, "resetState": { "title": "Reset the memory", "type": "boolean", "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) every market again. Untick it afterwards.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy or your own proxies. Keep the default: it is included in the price. The residential Apify proxy is not available in this Actor.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of requests processed in parallel.", "default": 8 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 10, "maximum": 2000, "type": "integer", "description": "Global request rate. Polymarket allows far more (300 market requests and 1,500 order book requests per 10 s per IP), so lower this only if the log shows HTTP 429. A results page gives 100 markets, and the order books of those 100 markets take one more request: 600 a minute is thousands of markets a minute. Every request to the site counts, the next pages of an option read on the way included: a budget, not an even pace (spread them with the minimum delay below).", "default": 600 }, "minRequestIntervalMs": { "title": "Min delay between requests", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute rate, this spreads the requests evenly instead of letting them go out in a burst. 0 = no gap.", "default": 0 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 20, "type": "integer", "description": "Retries per request before it is marked as failed. Behind a proxy, a request the site turns away is also retried on a new proxy session up to 10 times without using up these retries.", "default": 5 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Include debug messages in the run log.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }