> ## 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 videos API

> Search Google's Videos tab for videos from every site, with duration and channel. Call the Google videos API for JSON. 1 credit per call.

Searches Google's Videos tab for videos from every site, with duration and channel.

## Request

`query` is required.

<CodeGroup>
  ```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.google.videos({ query: "sourdough bread" });
  console.log(result.data.results);
  ```

  ```python Python icon="python" theme={null} theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.google.videos(query="sourdough bread")
  print(result["data"]["results"])
  ```

  ```bash cURL icon="terminal" theme={null} theme={null}
  curl -X POST https://api.stophy.dev/v1/google/videos \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"query":"sourdough bread"}'
  ```

  ```bash CLI icon="square-terminal" theme={null} theme={null}
  stophy google videos "sourdough bread"
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data.results[]` contains the videos, each with its site, channel and length.

The following example is illustrative.

```json theme={null}
{
  "success": true,
  "data": {
    "results": [
      {
        "title": "How to bake sourdough bread at home",
        "url": "https://www.example.com/watch?v=abc123",
        "site": "YouTube",
        "channelName": "Example Bakery",
        "durationSeconds": 754,
        "publishedAt": "2026-09-12T00:00:00.000Z",
        "description": "A step by step guide to your first sourdough loaf.",
        "position": 1
      }
    ],
    "page": 1
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `site` | string | Where the video is hosted, such as YouTube. |
| `publishedAt` | string (ISO 8601) | Approximate when Google shows only how long ago, such as 1 month ago. |
| `page` | integer | The page number of this response. |
| `position` | integer | The 1-based position of the result in the list. |
| `durationSeconds` | integer | The duration, in seconds. |

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`. |
| `duration` | string | Video length: `short` is under 4 minutes, `medium` is 4 to 20 and `long` is over 20. Acceptable values are `short`, `medium` and `long`. |
| `highQuality` | boolean | Restricts results to high quality videos. If unset, defaults to `false`. |
| `closedCaptioned` | boolean | Restricts results to videos with captions. If unset, defaults to `false`. |
| `page` | integer | The page to return. Pages are numbered from 1. Must be between 1 and 20. 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 20.

## Related methods

* [YouTube video](/api-reference/endpoint/youtube-video): Accepts a YouTube `url` as `videoUrl`. Returns a video's stats, description, chapters and most replayed moments.
* [YouTube transcript](/api-reference/endpoint/youtube-transcript): Accepts a YouTube `url` as `videoUrl`. Returns what a YouTube video says, from its captions.
* [TikTok video](/api-reference/endpoint/tiktok-video): Accepts a TikTok `url` as `videoUrl`. Returns a video's caption, stats and music.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/google/videos
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/videos:
    post:
      summary: >-
        Search Google's Videos tab for videos from every site, with duration and
        channel
      description: Costs 1 credit per call. Pages with page.
      operationId: googleVideos
      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
                duration:
                  description: >-
                    Google's own Duration: short is under 4 min, medium 4–20,
                    long 20+.
                  type: string
                  enum:
                    - short
                    - medium
                    - long
                highQuality:
                  default: false
                  description: Google's own High quality.
                  type: boolean
                closedCaptioned:
                  default: false
                  description: Google's own Closed captioned.
                  type: boolean
                page:
                  default: 1
                  description: Page number, starting at 1.
                  type: integer
                  minimum: 1
                  maximum: 20
              required:
                - query
              additionalProperties: false
            example:
              query: sourdough bread
      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:
                            title:
                              type: string
                              minLength: 1
                            url:
                              type: string
                              format: uri
                            site:
                              description: Where the video is hosted, like YouTube.
                              type: string
                            channelName:
                              type: string
                            durationSeconds:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            publishedAt:
                              description: >-
                                Approximate when Google shows only how long ago,
                                like 1 month ago.
                              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))$
                            description:
                              type: string
                            position:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                          required:
                            - title
                            - url
                            - position
                      page:
                        type: integer
                        minimum: 1
                        maximum: 9007199254740991
                    required:
                      - results
                      - page
                  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.