> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scoutlayer.io/llms.txt
> Use this file to discover all available pages before exploring further.

# YouTube Search API

> One page of keyword search results.



## OpenAPI

````yaml openapi.json GET /v1/youtube/search
openapi: 3.0.0
info:
  title: ScoutLayer API
  version: 1.0.0
  description: Competitor data. One API.
servers:
  - url: https://api.scoutlayer.io
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/youtube/search:
    get:
      tags:
        - youtube
        - search
      summary: Search YouTube for videos and channels
      description: One page of keyword search results.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: shopify app review
          required: true
          name: query
          in: query
        - schema:
            type: string
            enum:
              - day
              - week
              - month
              - year
          required: false
          name: publishedWithin
          in: query
        - schema:
            type: string
            enum:
              - relevance
              - date
              - views
              - rating
          required: false
          name: sort
          in: query
        - schema:
            type: string
            enum:
              - video
              - channel
              - short
              - live
          required: false
          name: type
          in: query
        - schema:
            type: string
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: Search YouTube for videos and channels
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YouTubeSearchResult'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: This endpoint is declared but not yet implemented — never charged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The orchestrator failed or was unreachable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    YouTubeSearchResult:
      type: object
      properties:
        videos:
          type: array
          items:
            type: object
            properties:
              videoId:
                type: string
              url:
                type: string
              title:
                type: string
              thumbnailUrl:
                type: string
              contentType:
                type: string
                enum:
                  - video
                  - short
                  - live
              publishedAt:
                type: string
              channel:
                type: object
                properties:
                  channelId:
                    type: string
                  handle:
                    type: string
                  name:
                    type: string
                required:
                  - channelId
                  - handle
                  - name
              views:
                type: integer
                nullable: true
            required:
              - videoId
              - url
              - title
              - thumbnailUrl
              - contentType
              - publishedAt
              - channel
              - views
        channels:
          type: array
          items:
            type: object
            properties:
              channelId:
                type: string
              handle:
                type: string
              name:
                type: string
              avatarUrl:
                type: string
              subscribers:
                type: integer
                nullable: true
            required:
              - channelId
              - handle
              - name
              - avatarUrl
              - subscribers
        nextCursor:
          type: string
          nullable: true
          description: >-
            Opaque pagination cursor — pass as ?cursor= for the next page; null
            on the last page
        hasMore:
          type: boolean
      required:
        - videos
        - channels
        - nextCursor
        - hasMore
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key passed as the X-API-Key request header. Recommended for
        server-to-server calls.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key (or OAuth token) passed as a Bearer token in the Authorization
        header.

````