{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Scrapes Google Trends interest over time, interest by region and related/rising searches. States what the 0-100 numbers actually mean: they rescale per request, so every row carries the keyword set it was scaled against, and rising searches keep their growth percent separate.", "version": "0.1", "x-build-id": "sQ0nsQbwmTm8hHFfu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-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/scrapyx~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-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/scrapyx~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-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": "Search terms to look up. With 'Compare keywords' off each term is scraped in its own request and scaled to its own peak; with it on they share one 0-100 scale (Google allows at most 5 per comparison).", "items": { "type": "string" } }, "compareKeywords": { "title": "Compare keywords against each other", "type": "boolean", "description": "OFF (default): one request per keyword, each series scaled to its own peak — values are NOT comparable between keywords. ON: all keywords in one request sharing a single 0-100 scale, so they ARE comparable. Max 5 keywords; Google returns HTTP 400 for more.", "default": false }, "geo": { "title": "Region", "type": "string", "description": "Two-letter country code (US, GB, ID), a subregion (US-CA), or leave empty for worldwide. An unrecognised code is refused by Google with HTTP 400, so a typo fails loudly rather than silently returning worldwide data." }, "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 picks the data resolution from this and reports it back — minute, hourly, daily, weekly or monthly. The resolution decides what one data point means, so it is recorded on every row.", "default": "today 12-m" }, "category": { "title": "Category id", "minimum": 0, "type": "integer", "description": "Google Trends category id (0 = all categories, 7 = finance, 5 = computers & electronics...). A real category genuinely changes the data. An INVALID id is not refused by the first API call — it returns HTTP 200 with a full payload and only fails one call later.", "default": 0 }, "property": { "title": "Search property", "enum": [ "", "images", "news", "youtube", "froogle" ], "type": "string", "description": "Which Google surface to measure. An unknown value passes the first call and fails the second, so this actor validates it up front.", "default": "" }, "includeTimeseries": { "title": "Include interest over time", "type": "boolean", "description": "One row per keyword per time point. The final point is the current unfinished period and is flagged isPartial.", "default": true }, "includeRegions": { "title": "Include interest by region", "type": "boolean", "description": "One row per keyword per region, with the region code and name.", "default": true }, "includeRelatedQueries": { "title": "Include related queries", "type": "boolean", "description": "Top queries (a 0-100 index) and rising queries (percent growth, with Google's 'Breakout' label kept as its own flag).", "default": true }, "includeRelatedTopics": { "title": "Include related topics", "type": "boolean", "description": "Same shape as related queries, but Google Knowledge Graph topics. Note Google omits this widget entirely for multi-keyword comparisons.", "default": true }, "language": { "title": "Language (hl)", "type": "string", "description": "Interface language. Affects region names and formatted labels, not the numbers.", "default": "en-US" }, "timezoneOffset": { "title": "Timezone offset (minutes)", "type": "string", "description": "Minutes offset Google uses to bucket time points, as its own web app sends it. -420 is UTC-7.", "default": "-420" }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 4, "type": "integer", "description": "Kept at 1 by default: Google Trends rate-limits by IP and answers HTTP 429 rather than throttling.", "default": 1 }, "minRequestInterval": { "title": "Min seconds between request starts", "minimum": 0, "maximum": 30, "type": "integer", "description": "Politeness pacing shared across all workers. This is a metered public endpoint, not a bulk feed.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional and OFF by default. Google Trends rate-limits by IP, so Residential is the difference between a large run finishing and not.", "default": { "useApifyProxy": 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 } } } } } } } } } }