{ "openapi": "3.0.1", "info": { "title": "TCGplayer Price Scraper – Pokémon, MTG & Yu-Gi-Oh Card Prices", "description": "TCGplayer price scraper & TCGplayer API alternative: market, low & mid card prices per condition and printing for Pokémon, Magic: The Gathering, Yu-Gi-Oh!, One Piece, Lorcana and more. Listing counts, 30-day sales, set, rarity. Price-change alerts. No login.", "version": "1.0", "x-build-id": "GDNNm5lSgDd1mbmAl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeworkshq~tcgplayer-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeworkshq-tcgplayer-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/scrapeworkshq~tcgplayer-scraper/runs": { "post": { "operationId": "runs-sync-scrapeworkshq-tcgplayer-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/scrapeworkshq~tcgplayer-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeworkshq-tcgplayer-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": { "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Card or product names to search, e.g. \"charizard\", \"lightning bolt\". Leave empty to browse by game/set filters only.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "TCGplayer product pages (https://www.tcgplayer.com/product/42382/...) or bare product IDs.", "items": { "type": "string" } }, "games": { "title": "Games (product lines)", "type": "array", "description": "Filter by game, e.g. pokemon, magic (or mtg), yugioh, one-piece, lorcana, flesh-and-blood, digimon, pokemon-japan.", "items": { "type": "string" } }, "sets": { "title": "Sets", "type": "array", "description": "Filter by set name as shown on TCGplayer, e.g. \"Base Set\", \"SWSH: Crown Zenith\", \"Double Masters 2022\".", "items": { "type": "string" } }, "rarities": { "title": "Rarities", "type": "array", "description": "Exact rarity names, e.g. \"Secret Rare\", \"Holo Rare\", \"Mythic\".", "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "e.g. \"Cards\" (singles only) or \"Sealed Products\".", "items": { "type": "string" } }, "sortBy": { "title": "Sort", "enum": [ "relevance", "price-desc", "price-asc", "name-asc", "name-desc" ], "type": "string", "description": "Sort order of search results.", "default": "relevance" }, "maxResultsPerSearch": { "title": "Max products per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Per keyword (or per filter-only browse).", "default": 50 }, "maxResultsTotal": { "title": "Max products total", "minimum": 0, "type": "integer", "description": "0 = no overall limit.", "default": 0 }, "includeConditionPrices": { "title": "Condition-level prices", "type": "boolean", "description": "Market / low / mid price, listing count and recent sales for every condition (NM, LP, MP, HP, DMG) and printing. ~5–12 extra requests per product; turn off for fast bulk catalog scraping.", "default": true }, "priceHistoryRange": { "title": "Sales window", "enum": [ "month", "quarter", "semi-annual", "annual" ], "type": "string", "description": "Window for per-condition sales stats.", "default": "month" }, "conditionListingSample": { "title": "Listings sampled per condition", "minimum": 0, "maximum": 50, "type": "integer", "description": "Listings read (cheapest first) to compute low & mid prices. 0 skips listing stats.", "default": 50 }, "englishOnly": { "title": "English only", "type": "boolean", "description": "Ignore non-English SKUs/listings in condition prices.", "default": false }, "includeCardAttributes": { "title": "Card attributes", "type": "boolean", "description": "Card text, HP, types, attacks, colors, etc. when TCGplayer provides them.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel products processed.", "default": 4 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 10, "maximum": 300, "type": "integer", "description": "Global polite rate limit across all requests.", "default": 120 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed. Use Apify Proxy if you see 403/429 errors.", "default": { "useApifyProxy": false } }, "monitorMode": { "title": "Monitor mode (track changes across runs)", "enum": [ "off", "all", "changes", "onlyNew" ], "type": "string", "description": "Remembers items from previous runs (per Monitor key) and adds changeType = new/changed/unchanged plus a field-level diff. In the two 'only' modes, unchanged/old items are not output and not charged.", "default": "off" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Name of the memory used by Monitor mode. Use a different key per schedule/task (e.g. 'daily-pokemon'), so separate watchlists don't mix.", "default": "default" }, "outputFormat": { "title": "Output format", "enum": [ "full", "flat" ], "type": "string", "description": "Flat makes CSV/Excel/Google Sheets exports one clean column per field.", "default": "full" }, "summaryWebhookUrl": { "title": "Summary webhook URL (optional)", "type": "string", "description": "At the end of the run, POST a compact JSON summary (counts, new/changed, price drops, dataset ID) to this URL – e.g. Zapier/Make/n8n catch hook or Slack workflow. Free." } } }, "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 } } } } } } } } } }