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

# Backlinks List API

> Individual backlinks pointing at a domain, one page at a time.



## OpenAPI

````yaml openapi.json GET /v1/website/backlinks
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/backlinks:
    get:
      tags:
        - website
        - backlinks
      summary: Get one page of a domain's backlinks
      description: Individual backlinks pointing at a domain, one page at a time.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: shopify.com
          required: true
          name: target
          in: query
        - schema:
            type: string
            enum:
              - as_is
              - one_per_domain
              - one_per_anchor
          required: false
          name: mode
          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 one page of a domain's backlinks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BacklinkList'
        '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:
    BacklinkList:
      type: object
      properties:
        backlinks:
          type: array
          items:
            $ref: '#/components/schemas/Backlink'
        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:
        - backlinks
        - nextCursor
        - hasMore
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
    Backlink:
      type: object
      properties:
        sourceDomain:
          type: string
        sourceUrl:
          type: string
        sourcePageTitle:
          type: string
          nullable: true
        targetUrl:
          type: string
        anchorText:
          type: string
          nullable: true
        linkType:
          type: string
          enum:
            - anchor
            - image
            - redirect
            - canonical
            - alternate
            - meta
            - other
        isDofollow:
          type: boolean
        isNew:
          type: boolean
        isLost:
          type: boolean
        spamScore:
          type: integer
        sourceDomainRank:
          type: integer
        sourcePageRank:
          type: integer
        sourceCountry:
          type: string
          nullable: true
        sourcePlatformTypes:
          type: array
          items:
            type: string
            enum:
              - cms
              - blog
              - ecommerce
              - forum
              - wiki
              - news
              - social
              - other
        firstSeenAt:
          type: string
        lastSeenAt:
          type: string
      required:
        - sourceDomain
        - sourceUrl
        - sourcePageTitle
        - targetUrl
        - anchorText
        - linkType
        - isDofollow
        - isNew
        - isLost
        - spamScore
        - sourceDomainRank
        - sourcePageRank
        - sourceCountry
        - sourcePlatformTypes
        - firstSeenAt
        - lastSeenAt
  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.

````