{ "openapi": "3.0.1", "info": { "title": "Amazon Rank Tracker - Keyword Rank Checker", "description": "Amazon rank tracker that checks where your ASINs rank for any keyword: organic position, sponsored and video ad position, page, share of shelf by brand and rank change vs the last run. 21 marketplaces. $0.001 per rank check, $0.002 per results page.", "version": "0.1", "x-build-id": "pau1HRx0ekrtktAFK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tiger19935~amazon-keyword-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tiger19935-amazon-keyword-rank-tracker", "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/tiger19935~amazon-keyword-rank-tracker/runs": { "post": { "operationId": "runs-sync-tiger19935-amazon-keyword-rank-tracker", "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/tiger19935~amazon-keyword-rank-tracker/run-sync": { "post": { "operationId": "run-sync-tiger19935-amazon-keyword-rank-tracker", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "Search phrases to check, exactly as a shopper would type them. One Amazon search is run per keyword and marketplace.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "asins": { "title": "ASINs to track", "type": "array", "description": "ASINs (10 characters, for example B0BDHWDR12) whose rank you want. Leave empty to only collect share of shelf for each keyword.", "default": [ "B0BDHWDR12" ], "items": { "type": "string" } }, "marketplaces": { "title": "Marketplaces", "type": "array", "description": "Amazon domains to search. Each marketplace is checked separately, so ranks are per country.", "items": { "type": "string", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "ca", "com.au", "in", "co.jp", "com.mx", "com.br", "nl", "se", "pl", "sg", "ae", "sa", "com.tr", "be", "eg" ], "enumTitles": [ "amazon.com (US)", "amazon.co.uk (UK)", "amazon.de (Germany)", "amazon.fr (France)", "amazon.it (Italy)", "amazon.es (Spain)", "amazon.ca (Canada)", "amazon.com.au (Australia)", "amazon.in (India)", "amazon.co.jp (Japan)", "amazon.com.mx (Mexico)", "amazon.com.br (Brazil)", "amazon.nl (Netherlands)", "amazon.se (Sweden)", "amazon.pl (Poland)", "amazon.sg (Singapore)", "amazon.ae (UAE)", "amazon.sa (Saudi Arabia)", "amazon.com.tr (Turkey)", "amazon.be (Belgium)", "amazon.eg (Egypt)" ] }, "default": [ "com" ] }, "maxPages": { "title": "Search depth (pages)", "minimum": 1, "maximum": 7, "type": "integer", "description": "How many result pages to read per keyword and marketplace (about 16 to 48 results per page, Amazon shows at most 7). Each page is one serp-page event.", "default": 2 }, "brands": { "title": "Brands to highlight", "type": "array", "description": "Optional brand names (for example your brand and competitors). They are always listed in the share-of-shelf row and used to recognise the brand in product titles.", "default": [], "items": { "type": "string" } }, "zipCode": { "title": "Delivery ZIP / postal code", "type": "string", "description": "Optional. Try to set the delivery location before searching (best effort, mainly amazon.com, .ca, .co.uk, .de). Leave empty for the default location of the proxy IP. Rankings can differ by location.", "default": "" }, "includeSponsored": { "title": "Detect sponsored placements", "type": "boolean", "description": "Report sponsored position (sponsored products, sponsored brands and video ads) separately from organic position.", "default": true }, "compareWithPrevious": { "title": "Compare with previous run", "type": "boolean", "description": "Save each result to a named key-value store and report the rank change versus the previous run for the same state key.", "default": true }, "stateKey": { "title": "History state key", "type": "string", "description": "Name of the history. Runs that share the same key (letters, digits, hyphens) are compared with each other. Use a different key per project or client.", "default": "default" }, "maxItems": { "title": "Max result rows", "minimum": 0, "type": "integer", "description": "Stop after this many dataset rows (rank rows and share-of-shelf rows). 0 means no limit.", "default": 0 }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many keyword and marketplace searches run at the same time. Keep low to avoid Amazon robot checks.", "default": 2 }, "maxRetries": { "title": "Retries per page", "minimum": 0, "maximum": 10, "type": "integer", "description": "How often a page is retried with a fresh session and proxy IP after a robot check, block or server error.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Amazon blocks many datacenter IPs. The default Apify datacenter proxy is tried first, with a country matching the marketplace.", "default": { "useApifyProxy": true } }, "useResidentialFallback": { "title": "Fall back to residential proxy", "type": "boolean", "description": "When Amazon keeps blocking the configured proxy, switch to Apify residential proxy for the rest of the run. Residential traffic is billed by Apify to your account.", "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 } } } } } } } } } }