> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Get Google Trends interest by region (https://www.socialfetch.dev/docs/api/v1/google-trends/interest-by-region/get) ## Summary Get Google Trends search interest by place for one to five terms. **Tags:** `Google Trends` ## HTTP - **Method:** GET - **Path:** `/v1/google-trends/interest-by-region` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.googleTrends.getInterestByRegion({ query: ["coffee"], geo: "US", time: "today 12-m", resolution: "region" })` - **Accepted identifiers:** `query` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `no_data` ## Credits - **Base:** 1 credit per successful lookup. - **Maximum on success (200):** 1 credit. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `query` (query) - **Required:** yes - **Constraints:** type `array` - **Description:** One to five search terms, comma-separated or repeated when a term contains a comma. A topic is `id:` plus a Knowledge Graph id (`id:/m/02vqfm`), as the suggestions endpoint returns it. ### `geo` (query) - **Required:** no - **Constraints:** default: `US` - **Description:** Place: a country code (`US`, `DE`), a subdivision (`US-CA`, `DE-BY`) or an empty string for worldwide. Lowercase input is accepted and normalised to uppercase. Default: `US`. ### `category` (query) - **Required:** no - **Constraints:** type `integer`; default: `0`; minimum: 0; maximum: 9999999 - **Description:** Category id from the categories endpoint. `0` (the default) means all categories. ### `source` (query) - **Required:** no - **Constraints:** type `string`; enum: web, images, news, youtube, shopping; default: `web` - **Description:** Property to search: `web` (default), `images`, `news`, `youtube` or `shopping`. ### `language` (query) - **Required:** no - **Constraints:** type `string`; default: `en-US`; pattern: `^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})?$` - **Description:** Interface language, as Google calls `hl` (`en-US`, `de`, `ja`, `ar`). It localises names, dates and type text; it does not translate the queries. ### `time` (query) - **Required:** no - **Constraints:** type `string`; default: `today 12-m`; maxLength: 64 - **Description:** Time range: `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 `YYYY-MM-DD YYYY-MM-DD` range (hourly `YYYY-MM-DDTHH` is accepted). ### `resolution` (query) - **Required:** no - **Constraints:** type `string`; enum: region, dma, city - **Description:** Region resolution: `region` for subdivisions, `dma` for US metro areas, or `city`. The default is the one Google Trends picks for the geo. A place without a city-level breakdown is refused as input. ### `includeLowVolume` (query) - **Required:** no - **Constraints:** type `boolean` - **Description:** Include places with too little search volume to appear by default. ## Responses (status codes) - **200**: Google Trends interest by region. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed. - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Google Trends interest by region. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, no_data. `found` when the answer has data; `no_data` when it has none. - **geo** (required) — type `string`. The geo of this result; an empty string is worldwide. - **category** (required) — type `integer`. The category of this result; 0 is all categories. - **source** (required) — type `string`; enum: web, images, news, youtube, shopping. The property that was searched. - **language** (required) — type `string`. The interface language. - **queries** (required) — type `array`. The terms of this result, as given in the request (including an `id:` marker for a topic). - _items:_ - type `string` - **time** (required) — type `string`. The time range of this result. - **includeLowVolume** (required) — type `boolean`. Whether low-volume places were asked for. - **resolution** (required) — type `string`; nullable. The resolution Google Trends used, e.g. `COUNTRY`, `REGION`, `DMA` or `CITY`. - **regions** (required) — type `array`. Places, as Google Trends lists them. Rows with no data are kept when the term has data; a term with no data returns an empty list. City results carry at most 200 rows; DMA rows are prefixed with the requested state when the request names one, and keep the bare metro code for a national request because a national result carries no state. - _items:_ - **geo** (required) — type `string`; nullable. Full place id, e.g. `US-CA` or `US-CA-807`; null for city rows, which carry coordinates instead. - **name** (required) — type `string`. Place name, localised by language. - **values** (required) — type `array`. One value per term, relative to the peak inside this request. - _items:_ - type `number` - **hasData** (required) — type `array`. Whether each term has data in this place. Rows with no data are kept when the term has data somewhere. - _items:_ - type `boolean` - **leadingTermIndex** (required) — type `integer`; nullable. Index of the compared term leading this place; null when not sent. - **coordinates** (required) — type `object`; nullable. Coordinates, sent for city results only; null otherwise. - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "geo": "US", "category": 0, "source": "web", "language": "en-US", "queries": [ "coffee" ], "time": "today 12-m", "includeLowVolume": false, "resolution": "REGION", "regions": [ { "geo": "US-WY", "name": "Wyoming", "values": [ 100 ], "hasData": [ true ], "leadingTermIndex": 0, "coordinates": null } ] }, "meta": { "requestId": "req_73c04223-fffe-4bd9-87d1-6dc7f9d1bebd", "creditsCharged": 1, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.googleTrends.getInterestByRegion({ query: ["coffee"], }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v1/google-trends/interest-by-region?query=coffee", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/google-trends/interest-by-region?query=coffee" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/google-trends/interest-by-region?query=coffee", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```