> ## 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.

# Bing Search Results API

> Organic and paid rankings for a keyword on Bing.



## OpenAPI

````yaml openapi.json GET /v1/bing/serp
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/bing/serp:
    get:
      tags:
        - bing
        - serp
      summary: Get Bing search results for a keyword
      description: Organic and paid rankings for a keyword on Bing.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: shopify apps
          required: true
          name: keyword
          in: query
        - schema:
            type: string
            example: US
          required: false
          name: location
          in: query
        - schema:
            type: string
            example: en
          required: false
          name: language
          in: query
        - schema:
            type: string
            enum:
              - desktop
              - mobile
          required: false
          name: device
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 200
          required: false
          name: depth
          in: query
      responses:
        '200':
          description: Get Bing search results for a keyword
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SerpResult'
        '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:
    SerpResult:
      type: object
      properties:
        keyword:
          type: string
        searchEngine:
          type: string
          enum:
            - google
            - bing
        location:
          type: string
        language:
          type: string
        device:
          type: string
          enum:
            - desktop
            - mobile
        totalResults:
          type: integer
          nullable: true
        checkedAt:
          type: string
        features:
          type: array
          items:
            type: string
            enum:
              - organic
              - paid
              - featured_snippet
              - people_also_ask
              - ai_overview
              - local_pack
              - shopping
              - video
              - image
              - news
              - knowledge_panel
              - other
          description: >-
            Which SERP sections appeared for this keyword — e.g. spot when a
            keyword gets absorbed into an AI Overview instead of organic clicks
        organic:
          type: array
          items:
            type: object
            properties:
              rank:
                type: integer
              absoluteRank:
                type: integer
              domain:
                type: string
              url:
                type: string
              title:
                type: string
              description:
                type: string
                nullable: true
              breadcrumb:
                type: string
                nullable: true
              websiteName:
                type: string
                nullable: true
              isFeaturedSnippet:
                type: boolean
              rating:
                type: object
                nullable: true
                properties:
                  value:
                    type: number
                  votesCount:
                    type: integer
                    nullable: true
                  max:
                    type: number
                required:
                  - value
                  - votesCount
                  - max
            required:
              - rank
              - absoluteRank
              - domain
              - url
              - title
              - description
              - breadcrumb
              - websiteName
              - isFeaturedSnippet
              - rating
        paid:
          type: array
          items:
            type: object
            properties:
              rank:
                type: integer
              domain:
                type: string
              url:
                type: string
              title:
                type: string
              description:
                type: string
                nullable: true
              advertiserId:
                type: string
                nullable: true
            required:
              - rank
              - domain
              - url
              - title
              - description
              - advertiserId
        aiOverview:
          type: object
          nullable: true
          properties:
            text:
              type: string
            references:
              type: array
              items:
                type: object
                properties:
                  domain:
                    type: string
                  url:
                    type: string
                  title:
                    type: string
                required:
                  - domain
                  - url
                  - title
          required:
            - text
            - references
        relatedSearches:
          type: array
          items:
            type: string
      required:
        - keyword
        - searchEngine
        - location
        - language
        - device
        - totalResults
        - checkedAt
        - features
        - organic
        - paid
        - aiOverview
        - relatedSearches
    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.

````