{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper - Interest Over Time & Related Queries", "description": "Scrape Google Trends by keyword: interest over time with peak, average and momentum already computed, interest by region, and top and rising related queries. Each keyword has its own time budget, so one stalled keyword never costs you the run - and is never charged.", "version": "0.0", "x-build-id": "V1Fv1nhHB6DaRIpcz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/smart-digital~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-smart-digital-google-trends-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/smart-digital~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-smart-digital-google-trends-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/smart-digital~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-smart-digital-google-trends-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Search terms to analyze, one plain string per line. Each one is collected independently, so a term Google throttles never affects the others. Duplicates are removed, and up to 500 terms are collected per run.", "items": { "type": "string" } }, "geo": { "title": "Location", "type": "string", "description": "Two-letter country code (US, FR, GB), or a sub-region such as US-CA. Leave empty for worldwide.", "default": "" }, "timeRange": { "title": "Time range", "enum": [ "now 1-H", "now 4-H", "now 1-d", "now 7-d", "today 1-m", "today 3-m", "today 12-m", "today 5-y", "all" ], "type": "string", "description": "The window the interest curve covers. Google changes the granularity with the window: hourly under a week, daily up to nine months, weekly beyond, monthly for the full history.", "default": "today 12-m" }, "searchType": { "title": "Google property", "enum": [ "web", "images", "news", "youtube", "shopping" ], "type": "string", "description": "Which Google surface the interest is measured on. Web search is the default and the only one with full history.", "default": "web" }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Optional Google Trends category ID to narrow the topic (0 is all categories, 7 finance, 71 food and drink, 174 computers and electronics). Leave at 0 unless you know the ID.", "default": 0 }, "includeRegions": { "title": "Include interest by region", "type": "boolean", "description": "Add the breakdown of interest by region for each keyword. Costs one extra request per keyword and nothing extra to you.", "default": true }, "includeRelated": { "title": "Include related queries", "type": "boolean", "description": "Add the top and rising related queries for each keyword, with breakout terms flagged as such. Costs one extra request per keyword and nothing extra to you.", "default": true }, "trendingSearches": { "title": "Add today's trending searches", "type": "boolean", "description": "Also return the trending searches of the day for the chosen country, with their rank and approximate traffic. These rows carry no interest curve and are never charged.", "default": false }, "keywordTimeoutSecs": { "title": "Time budget per keyword (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "How long a single keyword may take before it is returned marked as timed out and the run moves on. Raise it on slow windows such as 2004 to now.", "default": 45 }, "language": { "title": "Language", "type": "string", "description": "Interface language code, which drives the region names and date labels Google returns (en-US, fr-FR, de-DE).", "default": "en-US" } } }, "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 } } } } } } } } } }