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

# Ranked Keywords API

> Every keyword a domain ranks for, with position, search volume, and estimated traffic.



## OpenAPI

````yaml openapi.json GET /v1/website/keywords/ranked
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/website/keywords/ranked:
    get:
      tags:
        - website
        - keywords
        - serp
      summary: Get every keyword a domain ranks for on Google
      description: >-
        Every keyword a domain ranks for, with position, search volume, and
        estimated traffic.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: shopify.com
          required: true
          name: target
          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: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 1000
          required: false
          name: limit
          in: query
        - schema:
            type: string
          required: false
          name: cursor
          in: query
      responses:
        '200':
          description: Get every keyword a domain ranks for on Google
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RankedKeywordList'
        '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:
    RankedKeywordList:
      type: object
      properties:
        keywords:
          type: array
          items:
            $ref: '#/components/schemas/RankedKeyword'
        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:
        - keywords
        - nextCursor
        - hasMore
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
    RankedKeyword:
      type: object
      properties:
        keyword:
          type: string
        rank:
          type: integer
        absoluteRank:
          type: integer
        previousRank:
          type: integer
          nullable: true
        url:
          type: string
        serpFeature:
          type: string
          enum:
            - organic
            - paid
            - featured_snippet
            - people_also_ask
            - ai_overview
            - local_pack
            - shopping
            - video
            - image
            - news
            - knowledge_panel
            - other
        searchVolume:
          type: integer
          nullable: true
        cpc:
          type: number
          nullable: true
        competition:
          type: number
          nullable: true
        keywordDifficulty:
          type: integer
          nullable: true
        searchIntent:
          type: string
          enum:
            - informational
            - navigational
            - commercial
            - transactional
            - unknown
        estimatedTraffic:
          type: number
        monthlySearches:
          type: array
          items:
            type: object
            properties:
              year:
                type: integer
              month:
                type: integer
              searchVolume:
                type: integer
            required:
              - year
              - month
              - searchVolume
      required:
        - keyword
        - rank
        - absoluteRank
        - previousRank
        - url
        - serpFeature
        - searchVolume
        - cpc
        - competition
        - keywordDifficulty
        - searchIntent
        - estimatedTraffic
        - monthlySearches
  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.

````