{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Scrapes Google Trends for any keyword. Extracts the full set of trends-vertical fields: interest-over-time / interest-by-region, related queries / topics / articles, value, percentage, rank, delta, growth rate, breakout flag, suggestions, time range, geo, category, and more.", "version": "3.0", "x-build-id": "QpUd4Hd3lDt4T6ded" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/searchapi~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-searchapi-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/searchapi~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-searchapi-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/searchapi~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-searchapi-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": [ "query" ], "properties": { "mode": { "title": "Search Mode", "enum": [ "single", "batch" ], "type": "string", "description": "Run one keyword or a deduplicated batch of independent keywords.", "default": "single" }, "query": { "title": "Search Query", "type": "string", "description": "Keyword or topic to enter in Google Trends." }, "queries": { "title": "Batch Queries", "type": "array", "description": "Additional keywords for batch mode. Duplicates are removed.", "items": { "type": "string" }, "default": [] }, "dataTypes": { "title": "Trend Data Types", "type": "array", "description": "Structured widgets to collect: interestOverTime, interestByRegion, relatedQueries, and/or relatedTopics.", "items": { "type": "string" }, "default": [ "interestOverTime", "interestByRegion", "relatedQueries", "relatedTopics" ] }, "geo": { "title": "Country", "type": "string", "description": "Two-letter country code, or an empty string for worldwide data.", "default": "US" }, "language": { "title": "Language / Locale", "type": "string", "description": "Google locale such as en-US.", "default": "en-US" }, "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": "Google Trends time window used when custom dates are not provided.", "default": "today 12-m" }, "startDate": { "title": "Custom Start Date", "type": "string", "description": "Optional YYYY-MM-DD start. Provide both custom dates." }, "endDate": { "title": "Custom End Date", "type": "string", "description": "Optional YYYY-MM-DD end. Provide both custom dates." }, "category": { "title": "Category", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Google Trends category ID. 0 means all categories.", "default": 0 }, "searchType": { "title": "Search Type", "enum": [ "web", "images", "news", "shopping", "youtube" ], "type": "string", "description": "Select the Google vertical whose trend interest should be measured.", "default": "web" }, "maxItems": { "title": "Maximum Records", "minimum": 1, "maximum": 500, "type": "integer", "description": "Global record limit across every query and data type.", "default": 100 }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Independent query jobs processed in parallel.", "default": 2 }, "maxRequestRetries": { "title": "Maximum Request Retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Bounded retries for rate limits, proxy failures, and temporary 5xx responses.", "default": 2 }, "requestTimeoutSecs": { "title": "Request Timeout", "minimum": 10, "maximum": 120, "type": "integer", "description": "Maximum seconds for one Trends endpoint request.", "default": 45 }, "timezoneOffsetMinutes": { "title": "Timezone Offset", "minimum": -840, "maximum": 840, "type": "integer", "description": "Timezone offset in minutes used by Google Trends.", "default": 0 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Use Residential or custom proxies when direct Trends API traffic is rate-limited. GOOGLE_SERP is attempted through its HTTP transport but is not guaranteed to support Trends widget endpoints." }, "debug": { "title": "Debug Logging", "type": "boolean", "description": "Log safe aggregate diagnostics only. Raw responses and widget tokens are never logged.", "default": false } } }, "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 } } } } } } } } } }