{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper", "description": "Google Trends interest over time, interest by region and related queries (top + rising) for Web, YouTube, News, Images or Shopping. Compare up to 5 terms or run many separately, with retries, session rotation and visible failures.", "version": "1.1", "x-build-id": "GQLaOEKaIShgUkbac" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lomo-dev~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lomo-dev-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/lomo-dev~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-lomo-dev-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/lomo-dev~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-lomo-dev-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 or topics to look up. In 'separate' mode each term is queried on its own (any number). In 'compare' mode up to 5 terms are compared on one chart, like the Google Trends compare box.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "separate", "compare" ], "type": "string", "description": "How search terms are grouped into Google Trends queries.", "default": "separate" }, "geo": { "title": "Location (geo)", "type": "string", "description": "Country or region code, e.g. US, GB, US-CA. Empty = worldwide.", "default": "" }, "timeframe": { "title": "Timeframe", "type": "string", "description": "Google Trends time string: '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', or a custom range 'YYYY-MM-DD YYYY-MM-DD'.", "default": "today 12-m" }, "category": { "title": "Category ID", "minimum": 0, "type": "integer", "description": "Google Trends category ID (0 = all categories).", "default": 0 }, "property": { "title": "Search property", "enum": [ "web", "youtube", "news", "images", "shopping" ], "type": "string", "description": "Which Google search property to measure.", "default": "web" }, "outputs": { "title": "Data to return", "type": "array", "description": "Sections to collect for every query. Note: Google currently withholds related topics from non-logged-in clients (empty lists, flagged with a warning), so it is off by default.", "items": { "type": "string", "enum": [ "interestOverTime", "interestByRegion", "relatedQueries", "relatedTopics" ], "enumTitles": [ "Interest over time", "Interest by region", "Related queries (top + rising)", "Related topics (top + rising)" ] }, "default": [ "interestOverTime", "interestByRegion", "relatedQueries" ] }, "risingFilter": { "title": "Rising queries decoy filter", "enum": [ "strict", "off" ], "type": "string", "description": "Google mixes unrelated 'Breakout' rising queries into responses for automated sessions. Strict moves Breakout queries with no overlap with your term into suspectedDecoys (kept, not deleted).", "default": "strict" }, "regionResolution": { "title": "Region resolution", "enum": [ "AUTO", "COUNTRY", "REGION", "DMA", "CITY" ], "type": "string", "description": "Granularity for interest by region. AUTO uses Google's default (countries worldwide, subregions inside a country). DMA only works for US.", "default": "AUTO" }, "includeLowVolumeRegions": { "title": "Include low-volume regions", "type": "boolean", "description": "Include regions with too little data (value 0).", "default": false }, "language": { "title": "Language (hl)", "type": "string", "description": "Interface language for topic names, e.g. en-US, de, fr.", "default": "en-US" }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 15, "type": "integer", "description": "Retries with exponential backoff and session/IP rotation when Google rate-limits (HTTP 429) or errors.", "default": 6 }, "delayBetweenQueriesMs": { "title": "Delay between queries (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Pause between Google Trends queries to stay under rate limits.", "default": 1500 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended on the platform. Datacenter works for most runs; residential improves reliability at volume.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }