> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # Google trends by region API > Get Google Trends search interest by region. Call the Google trends by region API for JSON. 1 credit per call. Every call returns the same flat shape. Returns Google Trends search interest by region. ## Request `queries` is required. ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.google.trends.regions({ queries: ["bitcoin"] }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.google.trends.regions(queries=["bitcoin"]) print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/google/trends/regions \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"queries":["bitcoin"]}' ``` ```bash CLI icon="square-terminal" theme={null} stophy google trends regions --queries bitcoin ``` ## Response If successful, the response body contains the standard envelope. `data.results[]` contains the regions, each with one value for each query. The following example is a real response, truncated: each list shows one item and long strings are cut. ```json theme={null} { "success": true, "data": { "results": [ { "code": "CH", "name": "Switzerland", "values": { "bitcoin": 100 } } ] }, "creditsUsed": 1, "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b" } ``` | Field | Type | Description | | - | - | - | | `values` | object | Search interest for each query, relative to the peak value of 100. | For every field, see the response schema on this page. ## Optional parameters | Parameter | Type | Description | | - | - | - | | `country` | string | The country to query, as a two-letter ISO 3166-1 code such as `us`. | | `time` | string | Specifies the time range. Acceptable values are `pastHour`, `past4Hours`, `pastDay`, `past7Days`, `past30Days`, `past90Days`, `past12Months`, `past5Years` and `since2004`. If unset, defaults to `past12Months`. | | `searchType` | string | Specifies the Google property the searches were made on. Acceptable values are `web`, `images`, `news`, `shopping` and `youtube`. If unset, defaults to `web`. | | `category` | string | Restricts results to searches in this category. Accepts one of 25 values, such as `artsEntertainment`, `autosVehicles` and `beautyFitness`. | | `resolution` | string | Specifies the granularity of the regional breakdown. Acceptable values are `country`, `region` and `metro`. | ## Billing Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed. ## Pagination This method is not paginated. A single request returns the complete result. ## Related methods * [Google Trends interest over time](/api-reference/endpoint/google-trends-interest): Accepts the same `queries`. Returns Google Trends search interest over time, newest first, with one value per query. * [Google Trends related searches](/api-reference/endpoint/google-trends-related): Accepts one of the same queries as `query`. Returns related searches for a keyword. ## OpenAPI ````yaml api-reference/openapi.json POST /v1/google/trends/regions openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. Every call costs the same, whatever it returns, unless an operation's description says it costs per 10 results, or per second of audio. Then x-credits is the lowest price and x-credits-max the most one call can cost. Where an operation takes limit, send it to return fewer results and pay for fewer. When a response has a cursor, send it back unchanged with the same input to get the next page. When it has a page, send the next page number. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/google/trends/regions: post: summary: Get Google Trends search interest by region description: Costs 1 credit per call. operationId: googleTrendsRegions requestBody: required: true content: application/json: schema: type: object properties: queries: minItems: 1 maxItems: 5 type: array items: type: string minLength: 1 maxLength: 100 country: type: string pattern: ^[A-Za-z]{2}$ description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. time: default: past12Months description: Google Trends' own time range. type: string enum: - pastHour - past4Hours - pastDay - past7Days - past30Days - past90Days - past12Months - past5Years - since2004 searchType: default: web description: >- Google Trends' own search type: web, images, news, shopping or youtube. type: string enum: - web - images - news - shopping - youtube category: description: Google Trends' own top-level category. type: string enum: - artsEntertainment - autosVehicles - beautyFitness - booksLiterature - businessIndustrial - computersElectronics - finance - foodDrink - games - health - hobbiesLeisure - homeGarden - internetTelecom - jobsEducation - lawGovernment - news - onlineCommunities - peopleSociety - petsAnimals - realEstate - reference - science - shopping - sports - travel resolution: type: string enum: - country - region - metro required: - queries additionalProperties: false example: queries: - bitcoin responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' x-cache: $ref: '#/components/headers/Cache' x-cache-age: $ref: '#/components/headers/CacheAge' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: results: type: array items: type: object additionalProperties: false properties: code: type: string name: type: string values: type: object propertyNames: type: string additionalProperties: type: number required: [] required: - results creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix time in seconds when the current window resets. schema: type: integer Cache: description: hit if this result came from the cache, miss if it was fetched live. schema: type: string CacheAge: description: Seconds since the returned result was written to the cache. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - inviteClaimed - inviteDisabled - inviteExpired - inviteUsedUp - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string requiredCredits: type: number availableCredits: type: number billingUrl: type: string const: https://stophy.dev/billing securitySchemes: apiKey: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.