{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper: Keywords, Regions & Related Queries", "description": "Bulk Google Trends data: interest over time, interest by region, related queries and topics for many keywords per run, 5-keyword comparisons, any country, time range and category, plus alerts for new rising queries.", "version": "1.0", "x-build-id": "kZBfXLtmoMciYUT14" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northloop-labs~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northloop-labs-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/northloop-labs~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-northloop-labs-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/northloop-labs~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-northloop-labs-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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "One report per line. To compare keywords on the same 0-100 scale, put up to 5 on one line separated by commas, e.g. \"coffee, tea, matcha\". You can also enter a Google Trends topic ID such as /m/0dl567.", "default": [ "chatgpt", "coffee, tea" ], "items": { "type": "string" } }, "geos": { "title": "Countries / regions", "type": "array", "description": "Where to measure interest: a 2-letter country code (US, GB, DE), a region (US-CA, GB-ENG, IN-MH) or a US metro area (US-NY-501). Use \"worldwide\" (or leave empty) for the whole world. Each keyword line is run once per geo.", "default": [ "US" ], "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", "custom" ], "type": "string", "description": "The period of the report. Short ranges give minute or hourly points, 12 months gives weekly points, 5 years and 2004-present give monthly points.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Only used when Time range is Custom: start and end date separated by a space, e.g. \"2024-01-01 2024-12-31\" (any dates from 2004-01-01)." }, "reports": { "title": "Reports", "type": "array", "description": "Which Google Trends sections to collect for each keyword. Fewer sections run faster; the price per keyword report is the same. Related topics: Google currently serves them only to signed-in users, so this list is usually empty (a report with no data at all is free).", "items": { "type": "string", "enum": [ "interestOverTime", "interestByRegion", "relatedQueries", "relatedTopics" ], "enumTitles": [ "Interest over time", "Interest by region", "Related queries (top + rising)", "Related topics (often empty: Google withholds them from automated sessions)" ] }, "default": [ "interestOverTime", "interestByRegion", "relatedQueries" ] }, "category": { "title": "Category", "enum": [ "0", "3", "47", "44", "22", "12", "5", "7", "71", "8", "45", "65", "11", "13", "958", "19", "16", "299", "14", "66", "29", "533", "174", "18", "20", "67" ], "type": "string", "description": "Limit interest to one Google Trends category. For any other category, set its numeric ID in Category ID.", "default": "0" }, "categoryId": { "title": "Category ID (overrides Category)", "minimum": 0, "type": "integer", "description": "Any numeric Google Trends category ID, e.g. 1227 for Computer Security. Takes priority over Category." }, "searchType": { "title": "Search type", "enum": [ "web", "images", "news", "shopping", "youtube" ], "type": "string", "description": "Which Google search to measure.", "default": "web" }, "regionResolution": { "title": "Region level", "enum": [ "auto", "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Level of detail for Interest by region. Auto = countries for worldwide, subregions (states) for a country. Metro areas (DMA) work for the US. Google currently withholds city-level data from automated sessions, so City usually comes back empty.", "default": "auto" }, "includeLowVolumeRegions": { "title": "Include low-search-volume regions", "type": "boolean", "description": "Also return regions with low search volume in Interest by region (same as the checkbox on Google Trends).", "default": false }, "maxRelatedItems": { "title": "Max related items per list", "minimum": 1, "maximum": 25, "type": "integer", "description": "Cap for each related queries/topics list (top and rising). Google returns up to 25.", "default": 25 }, "language": { "title": "Language", "type": "string", "description": "Language for region and topic names, e.g. en-US, de, fr, es, pt-BR, ja.", "default": "en-US" }, "onlyNewRising": { "title": "Only new rising queries since last run (monitor)", "type": "boolean", "description": "Remember the rising queries and topics already seen for each keyword and add newRisingQueries / newRisingTopics to every report. Schedule the run daily or weekly to get an alert-style feed of breakout searches. The first run is a baseline.", "default": false }, "monitorOutput": { "title": "Monitor output", "enum": [ "changes", "all" ], "type": "string", "description": "Changes only = after the first run, save (and pay for) only reports that have new rising items. All = save every report with the new items marked.", "default": "changes" }, "monitorStoreName": { "title": "Monitor name", "type": "string", "description": "Name of the key-value store in your Apify account that keeps the seen rising items (a-z, 0-9 and dashes). Use different names for separate monitors.", "default": "google-trends-monitor" }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many keyword lines are fetched in parallel, each through its own residential IP.", "default": 8 } } }, "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 } } } } } } } } } }