Nimbleway Fast SERP API

The Fast SERP API from Nimbleway — 1 operation(s) for fast serp.

OpenAPI Specification

nimbleway-fast-serp-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Nimble SDK Agents Fast SERP API
  version: 1.0.0
  description: The AI-Native SDK for Real-Time Web Data at scale
servers:
- url: https://sdk.nimbleway.com
tags:
- name: Fast SERP
paths:
  /v1/realtime/serp:
    post:
      servers:
      - url: https://api.us.webit.live/api
        description: Production
      summary: Fast Google SERP
      tags:
      - Fast SERP
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FastSerpPayload'
              examples:
              - search_engine: google_search
                query: NBA Allstar 2026
                country: US
                locale: en
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SerpResponse'
                examples:
                - url: https://www.google.com/search?hl=en&gl=us&q=NBA+Allstar+2026
                  task_id: bd46cd9c-50f7-4736-9c4a-660a32e4dc87
                  status: success
                  query_time: '2026-03-05T13:47:16.435Z'
                  html_content: '...'
                  status_code: 200
                  parsing:
                    entities:
                      AnswerBox:
                      - entity_type: AnswerBox
                        snippet: NBANBA
                        snippet_highlighted:
                        - NBANBA
                        display_link: ''
                      InlineImages:
                      - entity_type: InlineImages
                        title: '#NBAAllStar 2026: Day of Service with Habitat for Humanity & Baby2Baby'
                        url: https://www.youtube.com/watch?v=CG98tKo
                      OrganicResult:
                      - position: 1
                        title: 2026 All-Star | Schedule
                        url: https://www.nba.com/allstar/2026/schedule
                        snippet: The 2026 NBA All-Star Game will take place on Sunday, Feb. 15, 2026 in Los Angeles, California at the Intuit Dome, the home of the LA Clippers.
                        cleaned_domain: nba
                        displayed_url: https://www.nba.com › allstar › 2026 › schedule
                        entity_type: OrganicResult
                      - position: 2
                        title: 2026 All-Star | Roster
                        url: https://www.nba.com/allstar/2026/roster
                        snippet: '2026 All-Star · Latest · Events. Feb. 13: Ruffles All-Star Celebrity Game ...'
                        cleaned_domain: nba
                        displayed_url: https://www.nba.com › allstar › 2026 › roster
                        entity_type: OrganicResult
                      - '...': more results
                      TopStory:
                      - entity_type: TopStory
                        url: https://www.youtube.com/watch?v=0omGCG98tKo
                      - '...': more results
                      Pagination:
                      - current_page: 1
                        entity_type: Pagination
                        next_page_url: https://www.google.com/search?q=NBA+All+Star+2026&start=10
                        other_page_urls:
                          '3': https://www.google.com/search?q=NBA+All+Star+2026&start=20
                          '...': more pages
                      RelatedQuestion:
                      - entity_type: RelatedQuestion
                        question: Who are the NBA All-Star 2026?
                      - '...': more questions
                      RelatedSearch:
                      - entity_type: RelatedSearch
                        position: '7'
                        query: NBA All-Star 2026 tickets
                        url: /search?q=NBA+All-Star+2026+tickets
                      - '...': more searches
                    total_entities_count: 32
                    entities_count:
                      AnswerBox: 1
                      InlineImages: 1
                      OrganicResult: 8
                      Pagination: 1
                      RelatedQuestion: 4
                      RelatedSearch: 14
                      TopStory: 3
                    metrics: {}
                  nimble_pagination:
                    next_page_url: https://api.us.webit.live/api/v1/realtime/serp?search_engine=google_search&query=NBA+Allstar+2026&country=US&locale=en&parse=true&page_params=...
                    other_pages:
                    - '...'
                  nimble_payload:
                    next_page:
                      search_engine: google_search
                      query: NBA Allstar 2026
                      country: US
                      locale: en
                      parse: 'true'
                      page_params: q=NBA+All+Star+2026&start=10&...
                  driver: vx6
        '400':
          description: Unprocessable Entity - Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error402'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  schemas:
    Error400:
      type: object
      title: Error400
      properties:
        status:
          type: string
          example: failed
          examples:
          - failed
        msg:
          type: string
          description: Validation error message describing what went wrong
          example: Invalid request parameters
          examples:
          - Invalid request parameters
        error:
          type: string
          description: The validation error type
          example: PARAMETERS_FAILED_JSON_SCHEMA_VALIDATION_ERROR
          examples:
          - PARAMETERS_FAILED_JSON_SCHEMA_VALIDATION_ERROR
        details:
          type: object
          description: Detailed validation error information
          example:
            schema_validation_errors:
            - instancePath: ''
              schemaPath: '#/required'
              keyword: required
              params:
                missingProperty: search_engine
              message: must have required property 'search_engine'
      required:
      - status
      - msg
      example:
        status: failed
        msg: Invalid request parameters
        error: PARAMETERS_FAILED_JSON_SCHEMA_VALIDATION_ERROR
        details:
          schema_validation_errors:
          - instancePath: ''
            schemaPath: '#/required'
            keyword: required
            params:
              missingProperty: search_engine
            message: must have required property 'search_engine'
    SerpResponse:
      type: object
      title: SerpResponse
      description: Response from the Fast SERP realtime API. All engines share the same top-level envelope; entity types under parsing.entities vary by search_engine.
      properties:
        task_id:
          type: string
          description: Unique identifier for this request
          examples:
          - bd46cd9c-50f7-4736-9c4a-660a32e4dc87
        status:
          type: string
          enum:
          - success
          - error
          description: Request status
          examples:
          - success
        query_time:
          type: string
          format: date-time
          description: ISO timestamp of when the query ran
          examples:
          - '2026-03-05T13:47:16.435Z'
        status_code:
          type: integer
          description: HTTP status code from the upstream source
          examples:
          - 200
        url:
          type: string
          description: The upstream URL that was queried
          examples:
          - https://www.google.com/search?hl=en&gl=us&q=NBA+Allstar+2026
        input_url:
          type: string
          description: The original input URL before any redirects
          examples:
          - https://www.google.com/search?hl=en&gl=us&q=NBA+Allstar+2026
        html_content:
          type: string
          nullable: true
          description: Raw HTML of the response page. Omitted when no_html is true.
          examples:
          - <!DOCTYPE html>...
        driver:
          type: string
          description: Internal routing driver used for this request
          examples:
          - vx6
        parsing:
          type: object
          description: Structured parsing output. Entity types under entities vary by search_engine.
        nimble_links:
          type: object
          nullable: true
          description: Pagination links as ready-to-use Nimble API URLs (Maps engines)
          properties:
            next_page:
              type: string
              description: URL to fetch the next page of results
        nimble_payload:
          type: object
          nullable: true
          description: Next-page parameters as a structured object (web search engines)
      required:
      - task_id
      - status
      - status_code
      - parsing
    Error429:
      type: object
      title: Error429
      properties:
        status:
          type: string
          example: failed
          examples:
          - failed
        msg:
          type: string
          example: Rate limit exceeded
          examples:
          - Rate limit exceeded
      required:
      - status
      - msg
      example:
        status: failed
        msg: Rate limit exceeded
    FastSerpPayload:
      type: object
      title: FastSerpPayload
      properties:
        search_engine:
          type: string
          description: The search engine to query
          examples:
          - google_search
          enum:
          - google_search
          - google_news
          - google_images
          - google_maps_search
          - google_maps_place
          - google_maps_reviews
        query:
          type: string
          description: The search query string. Required for google_search, google_news, google_images, and google_maps_search
          examples:
          - NBA Allstars 2026
        place_id:
          type: string
          description: Google Maps place identifier. Required for google_maps_place and google_maps_reviews
          examples:
          - ChIJtRq8oUjLw4kR_tN2GQKUOXs
        coordinates:
          type: object
          properties:
            latitude:
              type: string
              description: Google Maps place identifier. Required for google_maps_place and google_maps_reviews
              examples:
              - '40.7123695'
            longitude:
              type: string
              examples:
              - '-74.0357317'
          examples:
          - latitude: '40.7123695'
            longitude: '-74.0357317'
        time:
          type: string
          description: Filter results by time range. Only supported for google_search, google_news, and google_images
          examples:
          - hour
          - day
          - week
          - month
          - year
        country:
          type: string
          default: US
          description: Run the search as if from a specific country. Returns geo-localized results (optimized for US)
          examples:
          - US
        locale:
          type: string
          description: Language preference for the search results. Use LCID standard
          examples:
          - en
        location:
          type: string
          description: Location context for the search. Accepted for google_search, google_news, and google_images — not supported for Maps engines. Pass a location string (e.g. "United States", "New York, NY") or a raw Google UULE value.
          examples:
          - United States
          - New York, NY
        no_html:
          type: boolean
          default: false
          description: When set to true, removes the html_content field from the response
          examples:
          - true
      required:
      - search_engine
      description: Request body model for the fast serp endpoint
    Error402:
      type: object
      title: Error402
      properties:
        status:
          type: string
          example: failed
          examples:
          - failed
        msg:
          type: string
          description: Error message indicating the payment issue
          example: trial expired
          enum:
          - no budget
          - limit reached
          - trial expired
          - trial quota finished
      required:
      - status
      - msg
      example:
        status: failed
        msg: trial expired
    Error500:
      type: object
      title: Error500
      properties:
        success:
          type: string
          example: 'false'
          examples:
          - 'false'
        task_id:
          type: string
          example: 1ed1dbeb-8f34-4fd1-bb2d-a72bacae2ef3
          examples:
          - 1ed1dbeb-8f34-4fd1-bb2d-a72bacae2ef3
        message:
          type: string
          example: can't download the query response - please try again
          examples:
          - can't download the query response - please try again
      required:
      - success
      - task_id
      - message
      example:
        success: 'false'
        task_id: 1ed1dbeb-8f34-4fd1-bb2d-a72bacae2ef3
        message: can't download the query response - please try again
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer