{ "openapi": "3.0.1", "info": { "title": "SEMrush Position Tracker - Keyword Rankings & SERP Features", "description": "Track keyword rankings for any domain with SEMrush data using your own API key (BYOK). All in structured format.\nRanking Data\nKeyword Metrics\nCPC\nCompetition\nSERP Features\nFeatured Snippets\nPeople Also Ask\nImages, Video, News\nLocal Pack\nKnowledge Panel\nSitelinks", "version": "1.0", "x-build-id": "jfBL2GnOg830JeYHZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~semrush-position-tracker---keyword-rankings-serp-features/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-semrush-position-tracker---keyword-rankings-serp-features", "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/alizarin_refrigerator-owner~semrush-position-tracker---keyword-rankings-serp-features/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-semrush-position-tracker---keyword-rankings-serp-features", "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/alizarin_refrigerator-owner~semrush-position-tracker---keyword-rankings-serp-features/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-semrush-position-tracker---keyword-rankings-serp-features", "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": { "semrushApiKey": { "title": "SEMrush API Key", "type": "string", "description": "Your SEMrush API key. Get it from SEMrush → My Profile → API → Subscription Info" }, "domain": { "title": "Domain", "type": "string", "description": "Domain to track rankings for (e.g., example.com)" }, "database": { "title": "Database", "enum": [ "us", "uk", "ca", "au", "de", "fr", "es", "it", "br", "mx", "ru", "pl", "nl", "be", "se", "no", "dk", "fi", "ie", "at", "ch", "pt", "gr", "tr", "il", "ae", "za", "in", "jp", "kr" ], "type": "string", "description": "SEMrush database/country to use for data", "default": "us" }, "keywordLimit": { "title": "Keyword Limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Max number of keywords to retrieve", "default": 100 }, "positionFilter": { "title": "Position Filter", "enum": [ "all", "top3", "top10", "top20", "top50", "top100" ], "type": "string", "description": "Filter by ranking position", "default": "all" }, "sortBy": { "title": "Sort By", "enum": [ "traffic", "volume", "position", "cpc" ], "type": "string", "description": "How to sort results", "default": "traffic" }, "minVolume": { "title": "Minimum Search Volume", "minimum": 0, "type": "integer", "description": "Filter keywords below this monthly volume", "default": 0 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional webhook URL to send results (Zapier, Make, n8n, or custom)" }, "webhookPlatform": { "title": "Webhook Platform", "enum": [ "zapier", "make", "n8n", "custom" ], "type": "string", "description": "Select your webhook platform for optimized payload formatting", "default": "custom" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Return sample data without using SEMrush API (for testing)", "default": true } } }, "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 } } }, "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 } } } } } } } } } }