{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Reliable Google Trends data: interest over time, interest by region, related queries/topics and daily trending searches, with automatic retries, session/proxy rotation and honest error reporting instead of silent failures.", "version": "0.1", "x-build-id": "pec6bZxx9cPr7FBZH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gravelly_caladium~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gravelly_caladium-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/gravelly_caladium~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-gravelly_caladium-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/gravelly_caladium~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-gravelly_caladium-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Up to 5 terms are compared directly in one request (Google Trends' own limit). More than 5 are automatically split into batches that share a common \"anchor\" term (see anchorTerm) so the 0-100 values stay comparable across batches. Leave empty to only fetch trendingNow.", "items": { "type": "string" } }, "anchorTerm": { "title": "Anchor term for batching", "type": "string", "description": "Only relevant with more than 5 searchTerms. This term is repeated in every batch and used to rescale the other batches onto the same 0-100 scale. Defaults to the first search term if left blank." }, "geo": { "title": "Geo (country/region code)", "type": "string", "description": "Two-letter country code (e.g. \"US\", \"LV\"), a region code (e.g. \"US-CA\"), or empty for worldwide.", "default": "" }, "timeframe": { "title": "Timeframe", "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": "Preset time range, or \"custom\" to use customTimeframeStart/customTimeframeEnd.", "default": "today 12-m" }, "customTimeframeStart": { "title": "Custom timeframe start (YYYY-MM-DD)", "type": "string", "description": "Required when timeframe is \"custom\"." }, "customTimeframeEnd": { "title": "Custom timeframe end (YYYY-MM-DD)", "type": "string", "description": "Required when timeframe is \"custom\"." }, "category": { "title": "Category ID", "minimum": 0, "type": "integer", "description": "Google Trends category ID to restrict results to (0 = All categories). See Google's published category list.", "default": 0 }, "property": { "title": "Property (search vertical)", "enum": [ "", "news", "images", "youtube", "froogle" ], "type": "string", "description": "Which Google search vertical to pull trends from.", "default": "" }, "includeInterestOverTime": { "title": "Output: interest over time", "type": "boolean", "description": "Search interest over time, as long-format rows (one per term per date).", "default": true }, "includeInterestByRegion": { "title": "Output: interest by region", "type": "boolean", "description": "Search interest broken down by region, as long-format rows (one per term per location).", "default": true }, "regionResolution": { "title": "Region resolution", "enum": [ "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Granularity for interest-by-region: COUNTRY (worldwide/multi-country geo), REGION (state/province within one country), CITY, or DMA (US media markets only).", "default": "COUNTRY" }, "includeRelatedQueries": { "title": "Output: related queries", "type": "boolean", "description": "Top and rising related search queries per term.", "default": true }, "includeRelatedTopics": { "title": "Output: related topics", "type": "boolean", "description": "Top and rising related topics per term. Always issues one extra single-term request per term regardless of batching (Google Trends only returns this widget for single-term explores). See README limitations: Google's related-topics widget has been observed returning no data even for popular terms.", "default": false }, "trendingNow": { "title": "Output: trending now", "type": "boolean", "description": "Fetch today's trending searches for trendingNowGeo (independent of searchTerms).", "default": false }, "trendingNowGeo": { "title": "Trending now: country", "type": "string", "description": "Two-letter country code for the trending-now feed.", "default": "US" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Google Trends throttles aggressively; using Apify Proxy (residential recommended for larger runs) spreads requests across IPs and makes retries far more likely to succeed. Optional for small/light runs.", "default": { "useApifyProxy": false } }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a single Trends request (with exponential backoff + a fresh session/identity) before giving up and recording an error for that piece of data.", "default": 5 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Politeness delay before each request (+/-25% jitter). Lower is faster but more likely to be throttled; raise it for large runs.", "default": 1000 } } }, "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 } } } } } } } } } }