{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper & API — Compare Unlimited Keywords", "description": "Export Google Trends data to JSON, CSV or Excel. Interest over time, by region and related queries for any number of keywords, all on one comparable scale. Pay per result.", "version": "0.1", "x-build-id": "5WWHpGx4bTB5rWatm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datasmithhq~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datasmithhq-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/datasmithhq~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-datasmithhq-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/datasmithhq~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-datasmithhq-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 analyse. Any number — more than 5 are automatically compared on one scale.", "items": { "type": "string" } }, "anchorKeyword": { "title": "Anchor keyword (for more than 5 terms)", "type": "string", "description": "Keyword included in every batch to put all terms on one scale. Pick one of medium-to-high popularity. Defaults to the first search term." }, "geo": { "title": "Country / region code", "type": "string", "description": "ISO code like US, GB, IN or US-CA. 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": "Period to analyse. Use Custom time range for exact dates.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range", "type": "string", "description": "Overrides Time range. Format: YYYY-MM-DD YYYY-MM-DD, e.g. 2024-01-01 2024-12-31." }, "category": { "title": "Category ID", "type": "integer", "description": "Google Trends category ID (0 = all categories).", "default": 0 }, "searchProperty": { "title": "Search type", "enum": [ "", "images", "news", "froogle", "youtube" ], "type": "string", "description": "Which Google search to measure: web, images, news, Shopping or YouTube.", "default": "" }, "includeInterestOverTime": { "title": "Interest over time", "type": "boolean", "description": "Timeline of search interest with average, peak value and peak date.", "default": true }, "includeInterestByRegion": { "title": "Interest by region", "type": "boolean", "description": "Where each keyword is most popular (countries, states, metro areas or cities).", "default": false }, "regionResolution": { "title": "Region detail", "enum": [ "REGION", "DMA", "CITY" ], "type": "string", "description": "Used when a country is set. Metro areas (DMA) are US only.", "default": "REGION" }, "includeRelatedQueries": { "title": "Related queries (top & rising)", "type": "boolean", "description": "Top and rising searches related to each keyword, including Breakout terms.", "default": false }, "outputFormat": { "title": "Interest over time format", "enum": [ "perKeyword", "perDate" ], "type": "string", "description": "One row per keyword (timeline as a list) or one row per keyword per date (best for spreadsheets).", "default": "perKeyword" }, "language": { "title": "Language", "type": "string", "description": "Interface language for names of regions and topics, e.g. en-US, de, fr.", "default": "en-US" }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 15, "type": "integer", "description": "How many times to retry a request Google rate-limits before giving up.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxies strongly recommended — Google rate-limits datacenter IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }