{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper - Interest, Regions, Related Queries", "description": "Google Trends data without a browser: interest over time, interest by country, region, city or metro, related and rising queries, comparisons of up to 5 terms. Pay per complete report, no start fee, nothing for empty or partial results.", "version": "0.1", "x-build-id": "WgWJprUrwLFbyy8cG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maksym_kotenko~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maksym_kotenko-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/maksym_kotenko~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-maksym_kotenko-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/maksym_kotenko~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-maksym_kotenko-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", "required": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "One report per line. Separate up to 5 terms with commas to compare them on one scale, for example coffee, tea. Topic ids like /m/02vqfm work too.", "items": { "type": "string" } }, "geos": { "title": "Locations", "type": "array", "description": "Google Trends location codes, one per line: US, GB, US-CA, US-CA-807. Leave empty or write worldwide for the whole world. Every search term is reported for every location.", "items": { "type": "string" } }, "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": "Period of the report. Google picks the timeline step from it: minutes for the last hours, days up to 9 months, weeks up to 5 years, months beyond.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "pattern": "^(\\s*|\\d{4}-\\d{2}-\\d{2}\\s+\\d{4}-\\d{2}-\\d{2})$", "type": "string", "description": "Overrides the time range above: two dates YYYY-MM-DD YYYY-MM-DD, for example 2024-01-01 2024-12-31. Data starts on 2004-01-01." }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Google Trends category id, the cat= value in a Trends URL: 0 all categories, 71 Food and drink, 5 Computers and electronics.", "default": 0 }, "property": { "title": "Google property", "enum": [ "web", "images", "news", "shopping", "youtube" ], "type": "string", "description": "Where the searches happened.", "default": "web" }, "language": { "title": "Language", "type": "string", "description": "Language of related query links and Google's labels, like en-US, de or ja. Search interest does not depend on it.", "default": "en-US" }, "interestOverTime": { "title": "Interest over time", "type": "boolean", "description": "Timeline of search interest on a 0-100 scale, plus average, latest and peak value per term.", "default": true }, "interestByRegion": { "title": "Interest by region", "type": "boolean", "description": "Search interest per country, region, city or metro area. Comparisons also get the share of each term per region.", "default": true }, "relatedQueries": { "title": "Related queries", "type": "boolean", "description": "Top and rising related queries per term, with Breakout flags.", "default": true }, "relatedTopics": { "title": "Related topics", "type": "boolean", "description": "Top and rising related topics per term, single-term reports only. Google currently sends automated clients an empty topic list, so this is off by default.", "default": false }, "regionResolution": { "title": "Region level", "enum": [ "auto", "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Level of the interest by region table. Auto follows Google: countries for worldwide, regions inside a country. Metro areas (DMA) exist only for the US.", "default": "auto" }, "includeLowVolumeRegions": { "title": "Include low search volume regions", "type": "boolean", "description": "Also list regions with little search volume, like the checkbox on the Trends page.", "default": false }, "maxConcurrency": { "title": "Reports in parallel", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many reports are fetched at the same time, each through its own proxy session. Requests of one report are spaced by about 1.5 seconds so Google does not rate limit them.", "default": 2 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How often a rate-limited or failed request is retried with growing pauses; the proxy session is replaced after two failures in a row.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google rate limits shared datacenter addresses quickly. Apify Proxy is on by default and costs you nothing extra.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Fall back to residential proxy", "type": "boolean", "description": "When the first proxy keeps getting rate limited, continue through Apify residential proxy. Included in the price.", "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 }, "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 } } } } } } } } } }