{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Get Google Trends interest over time, interest by region and related queries for any list of keywords. Compare more than 5 terms on one 0-100 scale with an anchor term. Smart retries on rate limits; failed terms are never charged.", "version": "1.0", "x-build-id": "JT7WxpJLqXRuR8nq8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cairnware~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cairnware-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/cairnware~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-cairnware-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/cairnware~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-cairnware-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": "Keywords to look up on Google Trends, one per line. Each term is scraped separately (one result row each) unless you turn on \"Compare terms together\". You can also paste a chart link from trends.google.com/trends/explore: its terms become one comparison and its location, time range, category and search type are used for the whole run.", "items": { "type": "string" } }, "compareTogether": { "title": "Compare terms together", "type": "boolean", "description": "Put the terms on one Google Trends chart (like typing \"coffee, tea\" on trends.google.com) so their values are relative to each other. Google allows up to 5 terms per comparison; longer lists are split into groups of 5 and each group becomes one result row.", "default": false }, "anchorTerm": { "title": "Anchor term (compare more than 5 terms)", "type": "string", "description": "Optional. Google compares at most 5 terms at once. Enter one term that is about as popular as your terms (for example \"coffee\" when you compare drinks): it is added to every comparison group of 4, and at the end you get one extra free row (\"combined: ...\") with the interest over time of ALL your terms on one 0-100 scale. Turns on \"Compare terms together\"." }, "geo": { "title": "Location (geo code)", "pattern": "^$|^[A-Za-z]{2}(-[A-Za-z0-9]{1,3}(-[0-9]{3})?)?$", "type": "string", "description": "Google Trends location code: a 2-letter country code like US, GB, DE, a region like US-CA or GB-ENG, or a US metro (DMA) like US-CA-807. 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": "Preset period, same as the time menu on trends.google.com. Ignored when \"Custom time range\" is filled in.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2} \\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional exact period as \"YYYY-MM-DD YYYY-MM-DD\" (for example \"2024-01-01 2024-12-31\"). Overrides \"Time range\". Earliest start is 2004-01-01." }, "category": { "title": "Category", "minimum": 0, "type": "integer", "description": "Google Trends category ID to narrow the meaning of a term (0 = all categories). Examples: 71 Food & Drink, 7 Finance, 5 Computers & Electronics, 18 Shopping, 3 Arts & Entertainment. You can read the ID from the \"cat=\" part of a trends.google.com URL.", "default": 0 }, "property": { "title": "Search type", "enum": [ "", "news", "images", "youtube", "froogle" ], "type": "string", "description": "Which Google search to measure, same as the \"Web search\" menu on trends.google.com.", "default": "" }, "includeInterestOverTime": { "title": "Interest over time", "type": "boolean", "description": "Time series of relative search interest (0-100).", "default": true }, "includeInterestByRegion": { "title": "Interest by region", "type": "boolean", "description": "Relative search interest per country, region, metro or city (0-100).", "default": true }, "regionResolution": { "title": "Region resolution", "enum": [ "AUTO", "COUNTRY", "REGION", "DMA", "CITY" ], "type": "string", "description": "Level of detail for interest by region. Automatic = countries for worldwide, sub-regions (states, provinces) for a country. DMA (metro areas) is only available for the US. If Google does not offer the chosen level for your location, the automatic level is returned and a warning is added to the row.", "default": "AUTO" }, "includeRelatedQueries": { "title": "Related queries", "type": "boolean", "description": "Top and rising related search queries for each term.", "default": true }, "includeRelatedTopics": { "title": "Related topics", "type": "boolean", "description": "Top and rising related topics (entities) for each term. Note: Google Trends currently returns related topics for few searches and never for comparisons; when it returns none, the row gets a warning. Adds one request per term.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Google Trends rate-limits busy IP addresses (HTTP 429). Residential proxies give each retry a fresh IP and are strongly recommended; proxy traffic is included in the price.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many times a rate-limited or failed request is retried (exponential backoff with jitter, new proxy IP each time) before the term is returned with status \"error\".", "default": 8 }, "maxConcurrency": { "title": "Parallel terms", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many terms are scraped at the same time. Higher is faster for long lists but triggers more rate limiting.", "default": 3 } } }, "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 } } } } } } } } } }