> ## 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 search API > Search Google and get results, the AI Overview, the knowledge panel and related questions. Call the Google search API for JSON. From 1 credit per call. * **Endpoint:** `google.search` * **Returns:** `data` has `results`, `aiOverview`, `knowledgeGraph`, `peopleAlsoAsk`, `relatedSearches`, `isPartial`. * **Cost:** 1 credit per 10 results returned, never more than you asked for (10 credits at most). Failed calls cost nothing. * **Paging:** No. Filter with `within`, `country`, `language`, and domains to include or exclude. Keys a result does not have are left out. Without a key you get up to 10 results. ## Example ```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.search({ query: "best project management software" }); console.log(result.data.results); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.google.search(query="best project management software") print(result["data"]["results"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/google/search \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"query":"best project management software"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy google search "best project management software" ``` ## OpenAPI ````yaml api-reference/openapi.json POST /v1/google/search 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 sets a price scale. Then x-credits is the lowest price and x-credits-max the highest. When a response has a cursor, send it back with the same input to get the next page. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/google/search: post: summary: >- Search Google and get results, the AI Overview, the knowledge panel and related questions description: Costs 1 credit per 10 results returned, never more than you asked for. operationId: googleSearch requestBody: required: true content: application/json: schema: type: object properties: limit: default: 10 description: How many results to return, up to 100. type: integer minimum: 1 maximum: 100 query: type: string minLength: 1 maxLength: 400 country: type: string pattern: ^[A-Za-z]{2}$ description: >- ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted. language: type: string pattern: ^[A-Za-z]{2}$ description: >- Two-letter language code like en or pt. Any case is accepted. includeDomains: maxItems: 10 type: array items: type: string excludeDomains: maxItems: 10 type: array items: type: string within: default: all type: string enum: - day - week - month - year - all required: - query additionalProperties: false example: query: best project management software 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: url: type: string format: uri title: type: string minLength: 1 description: description: Text shown under the title. type: string date: description: Day shown on the result, when there is one. type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ sitelinks: description: Links listed under the result. type: array items: type: object additionalProperties: false properties: title: type: string minLength: 1 description: Link text. url: type: string format: uri description: Destination URL. required: - title - url position: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - url - title - position aiOverview: type: object additionalProperties: false properties: text: type: string minLength: 1 sources: description: Pages the overview cites. type: array items: type: object additionalProperties: false properties: url: type: string format: uri title: type: string minLength: 1 required: - url required: - text knowledgeGraph: type: object additionalProperties: false properties: title: type: string minLength: 1 type: type: string website: type: string format: uri imageUrl: type: string format: uri description: type: string descriptionSource: type: string descriptionUrl: type: string format: uri attributes: description: Labelled facts, like Founded or Headquarters. type: object propertyNames: type: string additionalProperties: type: string required: - title peopleAlsoAsk: type: array items: type: object additionalProperties: false properties: question: type: string minLength: 1 answer: type: string title: type: string url: type: string format: uri required: - question relatedSearches: type: array items: type: string isPartial: description: >- True when later pages failed and only the earlier results are here. type: boolean const: true required: - results creditsUsed: type: integer requestId: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' security: - apiKey: [] 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: - agentCodeCompleted - agentCodeNotFound - agentEmailMismatch - 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.