{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper - Trending Now, Interest & Metrics", "description": "Interest over time, by region, and related queries in one run - most scrapers return one series and charge you three times. Survives Google's rate limits; a throttled dataset is skipped, not fatal. Missing data is null, never zero. Never charges for an empty or failed run.", "version": "0.1", "x-build-id": "6euVRzNG4dF98CYzD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ballast~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ballast-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/ballast~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-ballast-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/ballast~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-ballast-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": { "keywords": { "title": "Keywords", "maxItems": 5, "type": "array", "description": "Up to 5 search terms. With more than one, values are relative to the most popular term across the whole period. Not needed if you only want Trending now.", "items": { "type": "string" } }, "timeframe": { "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.", "default": "today 12-m" }, "geo": { "title": "Country or region", "type": "string", "description": "Two-letter country code such as US, GB, IL. Leave empty for worldwide.", "default": "" }, "datasets": { "title": "Datasets to collect", "type": "array", "description": "Which datasets to return. Collecting fewer is faster and cheaper. Trending now needs no keywords and can be run on its own. Trend metrics are computed from interest over time and cost no extra requests. Note: Google returns related topics only intermittently for API clients, so it is off by default; related queries are unaffected.", "items": { "type": "string", "enum": [ "timeseries", "geo", "related_queries", "related_topics", "trending", "metrics" ], "enumTitles": [ "Interest over time", "Interest by region", "Related queries", "Related topics", "Trending now (daily, no keywords needed)", "Trend metrics (direction, growth, volatility, score)" ] }, "default": [ "timeseries", "geo", "related_queries", "metrics" ] }, "trendingGeo": { "title": "Trending now country", "type": "string", "description": "Country for the Trending now feed, such as US, GB, IL. Defaults to the country above, or US when that is empty. Google publishes trending searches per country, so worldwide is not an option here.", "default": "" }, "category": { "title": "Category ID", "type": "integer", "description": "Google Trends category. 0 means all categories.", "default": 0 }, "property": { "title": "Google property", "enum": [ "", "images", "news", "youtube", "froogle" ], "type": "string", "description": "Restrict to a Google surface. Empty means web search.", "default": "" }, "includeEmptyRegions": { "title": "Include regions with no data", "type": "boolean", "description": "Off by default, so regions Google has no data for are omitted rather than reported as zero.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google rate-limits Trends aggressively per IP. Running through a proxy is what keeps repeated runs reliable, and is strongly recommended.", "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 } } }, "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 } } } } } } } } } }