finedata-ai Google SERP API

openapi: 3.2.0
info:
  title: Finedata Ai Google SERP API
  version: 1.0.0
  description: 'Operations tagged Google SERP across 2 of this provider''s published API definitions: finedata-ai.json, finedata-openapi.json. Each path carries the servers of the definition it was published in.'
security:
- BearerAuth: []
tags:
- name: Google SERP
paths:
  /api/v1/serp:
    post:
      tags:
      - Google SERP
      summary: Google search (SERP)
      description: 'Run a Google search and return structured JSON results.


        Same auth and billing gates as ``POST /api/v1/scrape``. Charged only when a

        page is actually parsed; a Google block or a run with no results is free.'
      operationId: serp_endpoint_api_v1_serp_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SerpRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SerpRequest:
      properties:
        q:
          type: string
          maxLength: 2048
          minLength: 1
          title: Q
          description: Search query (1-2048 chars)
        gl:
          type: string
          title: Gl
          description: 'Google country: ISO 3166-1 alpha-2 (e.g. ''us'')'
          default: us
        hl:
          type: string
          title: Hl
          description: 'Google interface language: ISO 639-1, optional region (e.g. ''en'' or ''en-GB'')'
          default: en
        location:
          anyOf:
          - type: string
          - type: 'null'
          title: Location
          description: Accepted but unused in P1 (only gl/hl apply)
        start:
          type: integer
          maximum: 90.0
          minimum: 0.0
          title: Start
          description: Result offset; 0-90 in steps of 10 (10 results per page)
          default: 0
        device:
          type: string
          title: Device
          description: Only 'desktop' is supported in P1
          default: desktop
        include_html:
          type: boolean
          title: Include Html
          description: Also return the raw Google HTML
          default: false
      type: object
      required:
      - q
      title: SerpRequest
      description: Google search request. The Google URL is built here, never sent by the client.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API key obtained from the dashboard. Pass as `Authorization: Bearer fd_...`'
x-refined-from:
- finedata-ai.json
- finedata-openapi.json