{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper — Calibrated Keyword Comparison API", "description": "Compare Google Trends keyword portfolios beyond one request on a common calibrated scale, with uncertainty bounds and API-ready time-series data. One dataset record per keyword: raw series, calibrated series, bounds, anchor provenance.", "version": "0.1", "x-build-id": "tQ5SJJuX9G8y5B49V" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/george.the.developer~calibrated-google-trends-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-george.the.developer-calibrated-google-trends-api", "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/george.the.developer~calibrated-google-trends-api/runs": { "post": { "operationId": "runs-sync-george.the.developer-calibrated-google-trends-api", "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/george.the.developer~calibrated-google-trends-api/run-sync": { "post": { "operationId": "run-sync-george.the.developer-calibrated-google-trends-api", "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", "uniqueItems": true, "type": "array", "description": "Keywords to calibrate onto one common scale (1-20). Each successfully calibrated keyword is one charged result.", "items": { "type": "string" } }, "geo": { "title": "Geography", "enum": [ "", "US" ], "type": "string", "description": "Supported: worldwide (empty) or US. Unsupported combinations are rejected without charge.", "default": "" }, "timeframe": { "title": "Timeframe", "enum": [ "today 12-m" ], "type": "string", "description": "Analysis window. Launch catalog: past 12 months.", "default": "today 12-m" }, "category": { "title": "Category", "type": "integer", "description": "Google Trends category id. Launch catalog: 0 (all categories).", "default": 0 }, "property": { "title": "Search property", "enum": [ "web" ], "type": "string", "description": "Google search surface. Launch catalog: web search.", "default": "web" }, "maxCostUsd": { "title": "Max cost (USD)", "type": "integer", "description": "Hard pre-run charge cap in whole cents is not supported by Apify schema; this is USD. Run is rejected without charge if the keyword count would exceed this.", "default": 3 }, "mode": { "title": "Mode", "enum": [ "calibrate", "build-bank" ], "type": "string", "description": "calibrate = normal customer run. build-bank = owner-only anchor bank maintenance.", "default": "calibrate" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings. Default: US residential (required — Google Trends rate-limits datacenter IPs).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "bankSpec": { "title": "Bank spec (build-bank only)", "type": "object", "description": "Owner-only: anchor candidate terms and dimensions for bank construction." } } }, "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 } } } } } } } } } }