> ## 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. 1 credit per call.
Searches Google and returns results, the AI Overview, the knowledge panel and related questions.
## Request
`query` is required.
This endpoint can be called without an API key, subject to per-address limits. Pagination requires a key.
```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"
```
## Response
If successful, the response body contains the standard envelope. `data` contains the web results in `results`, Google's AI Overview when it shows one, related questions and related searches.
The following example is a real response, truncated: each list shows one item and long strings are cut.
```json theme={null}
{
"success": true,
"data": {
"aiOverview": {
"text": "The best project management software depends on your team's specific workflow, size, and goals, with top platforms…"
},
"results": [
{
"type": "web",
"url": "https://www.reddit.com/r/projectmanagement/comments/1dogwhv/looking_for_a_project_management_software_with/",
"title": "Looking for a project management software with specific ...",
"description": "Microsoft Access, Smartsuite, NocoDB, Fibery, Zoho Creator, Baserow), Asana is capable of this. Use Monday.com. Look…",
"position": 1
},
{
"type": "post",
"url": "https://www.linkedin.com/pulse/12-must-have-tools-project-managers-successful-project-managers-sszdf",
"text": "12 Must-Have Tools for Project Managers",
"site": "LinkedIn",
"authorName": "Successful Project Managers",
"publishedAt": "2026-09-17T07:00:00.000Z",
"position": 5
}
],
"peopleAlsoAsk": [
{
"question": "Which is the most popular project management software?"
}
],
"relatedSearches": ["Best project management software reddit"],
"page": 1
},
"creditsUsed": 1,
"requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```
| Field | Type | Description |
| - | - | - |
| `type` | string | The kind of item: `web`, `news`, `video` or `post`. |
| `site` | string | Where the result was found, such as YouTube or Reddit. |
| `publishedAt` | string (ISO 8601) | When it was published. For videos it is approximate, because Google shows only how long ago. |
| `page` | integer | The page number of this response. |
| `position` | integer | The 1-based position of the result in the list. |
| `aiOverview` | object | The Google AI Overview. Omitted when Google does not display one. |
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`. |
| `language` | string | The language of the results, as a two-letter ISO 639-1 code such as `en`. |
| `includeDomains` | string\[] | Restricts results to results from these domains. Accepts up to 10 values. |
| `excludeDomains` | string\[] | Leave out results from these domains. Accepts up to 10 values. |
| `time` | string | Restricts results to results from this period. Leave it out for any time. Acceptable values are `pastHour`, `past24Hours`, `pastWeek`, `pastMonth` and `pastYear`. |
| `verbatim` | boolean | Search the exact words, with no spelling fixes. If unset, defaults to `false`. |
| `fileType` | string | Restricts results to files of this type. Accepts one of 11 values, such as `pdf`, `doc` and `docx`. |
| `safeSearch` | boolean | Hide explicit results. If unset, defaults to `false`. |
| `page` | integer | The page to return. Pages are numbered from 1. Must be between 1 and 100. If unset, defaults to `1`. |
## 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
Results are paginated. To retrieve the next page, increment `page`. An empty `data.results` indicates the last page. The maximum value of `page` is 100. Requests without an API key return the first page only.
## Related methods
* [Google AI Mode](/api-reference/endpoint/google-aiMode): Accepts a question from `peopleAlsoAsk` as `query`. Sends a question to Google AI Mode a question and returns its answer with the sources it cites.
* [Google Search](/api-reference/endpoint/google-search): Accepts an entry from `relatedSearches` as `query`. Searches Google and returns results, the AI Overview, the knowledge panel and related questions.
## 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 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/search:
post:
summary: >-
Search Google and get results, the AI Overview, the knowledge panel and
related questions
description: Costs 1 credit per call. Pages with page.
operationId: googleSearch
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
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
time:
description: Google's Tools time filter. Leave out for any time.
type: string
enum:
- pastHour
- past24Hours
- pastWeek
- pastMonth
- pastYear
verbatim:
default: false
description: >-
Google's Verbatim: search the exact words, with no spelling
fixes.
type: boolean
fileType:
type: string
enum:
- pdf
- doc
- docx
- xls
- xlsx
- ppt
- pptx
- txt
- rtf
- csv
- kml
safeSearch:
default: false
description: Hide explicit results.
type: boolean
page:
default: 1
description: Page number, starting at 1.
type: integer
minimum: 1
maximum: 100
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:
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
profiles:
description: Official social profiles.
type: array
items:
type: object
additionalProperties: false
properties:
site:
type: string
minLength: 1
url:
type: string
format: uri
required:
- site
- url
required:
- title
results:
type: array
items:
oneOf:
- type: object
additionalProperties: false
properties:
type:
type: string
const: web
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:
- type
- url
- title
- position
- type: object
additionalProperties: false
properties:
type:
type: string
const: news
url:
type: string
format: uri
title:
type: string
minLength: 1
source:
description: Publication that ran the story.
type: string
publishedAt:
type: string
format: date-time
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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
position:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
required:
- type
- url
- title
- position
- type: object
additionalProperties: false
properties:
type:
type: string
const: video
url:
type: string
format: uri
title:
type: string
minLength: 1
site:
description: Where the video is hosted, like YouTube.
type: string
channelName:
type: string
durationSeconds:
type: integer
minimum: 0
maximum: 9007199254740991
publishedAt:
description: >-
Approximate: Google shows only how long ago
the video was published.
type: string
format: date-time
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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
position:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
required:
- type
- url
- title
- position
- type: object
additionalProperties: false
properties:
type:
type: string
const: post
url:
type: string
format: uri
text:
type: string
minLength: 1
site:
description: Where it was posted, like Reddit or X.
type: string
authorName:
type: string
comments:
description: At least this many.
type: integer
minimum: 0
maximum: 9007199254740991
likes:
description: At least this many.
type: integer
minimum: 0
maximum: 9007199254740991
publishedAt:
type: string
format: date-time
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])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
position:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
required:
- type
- url
- text
- position
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
page:
type: integer
minimum: 1
maximum: 9007199254740991
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:
- 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.