superagnt-com SEO: Backlinks API

openapi: 3.2.0
info:
  title: 'superagnt SEO: Backlinks API'
  description: Unified API for social media data. Access LinkedIn, YouTube, TikTok, X, Instagram, Reddit, and Facebook through a single API key.
  version: 1.0.0
  contact:
    name: superagnt
    url: https://superagnt.com
servers:
- url: https://api.superagnt.com
  description: superagnt API
security:
- ApiKeyAuth: []
tags:
- name: 'SEO: Backlinks'
  description: Backlink profiles, referring domains, and link gaps.
paths:
  /v1/data/seo/backlinks-summary:
    post:
      operationId: backlinks_summary
      summary: Backlink profile summary
      x-agnt-permission: act
      description: 'Returns a domain or page''s backlink profile at a glance: total backlinks, referring domains, domain rank, spam score, broken links, and anchor/TLD distributions (flat object at result[0], no items array). The `rank` here is the target domain''s own backlink-authority rank — a different metric from the per-referring-domain `rank` in backlink_gap/referring_domains rows, so the same domain can carry different numbers in each. Use it to qualify a site''s authority in one cheap call before deeper link analysis.'
      tags:
      - 'SEO: Backlinks'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - target
              properties:
                target:
                  type: string
                  description: Domain, subdomain or full page URL. Domains without protocol; pages with protocol.
                include_subdomains:
                  type: boolean
                  default: true
                  description: Count links to subdomains too. Default true.
                exclude_internal_backlinks:
                  type: boolean
                  default: true
                  description: Ignore links from the target to itself. Default true.
            example:
              target: close.com
      responses:
        '200':
          description: Backlink profile summary in `result[0]`.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request or upstream task error.
        '401':
          description: Unauthorized.
        '429':
          description: Too many requests.
        5XX:
          description: Upstream error.
      security:
      - ApiKeyAuth: []
  /v1/data/seo/referring-domains:
    post:
      operationId: referring_domains
      summary: Referring domains for a target
      x-agnt-permission: act
      description: 'Lists the domains linking to a target, each with rank, backlink count, first/last seen dates and spam score. This is the outreach-prospecting call: the sites already linking to a competitor are the sites most likely to link to you. Cost scales with rows; default 100 is right for most pulls.'
      tags:
      - 'SEO: Backlinks'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - target
              properties:
                target:
                  type: string
                  description: Domain, subdomain or full page URL to list referring domains for.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Max referring domains to return. Default 100. Cost scales with rows.
                offset:
                  type: integer
                  minimum: 0
                  description: Pagination offset.
                exclude_internal_backlinks:
                  type: boolean
                  default: true
                  description: Ignore links from the target to itself. Default true.
                filters:
                  type: array
                  items: {}
                  description: 'Optional filter expression as [field, operator, value] triples. Operators: =, <>, <, <=, >, >=, in, not_in, like, not_like. Recipe: [["rank",">",100]] keeps stronger referring domains (rank is the referring domain''s authority, higher is better).'
                order_by:
                  type: array
                  items:
                    type: string
                  description: Sort rules, e.g. ["rank,desc"].
            example:
              target: competitor.com
              limit: 100
              order_by:
              - rank,desc
      responses:
        '200':
          description: Referring domains with metrics in `result[0].items`.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request or upstream task error.
        '401':
          description: Unauthorized.
        '429':
          description: Too many requests.
        5XX:
          description: Upstream error.
      security:
      - ApiKeyAuth: []
  /v1/data/seo/backlink-gap:
    post:
      operationId: backlink_gap
      summary: Domains linking to competitors but not you
      x-agnt-permission: act
      description: 'Finds domains that link to one or more competitor targets but NOT to the excluded target (you). The output is a ready-made link-building prospect list; chain it with an email-finder tool to turn rows into outreach. Response shape: each row''s referring domain lives at items[].domain_intersection["1"], ["2"], ... keyed by the 1-based index of your `targets` array, with that referring domain''s own authority score in `rank` (0-1000ish, higher is stronger; this is the referring domain''s rank, a different metric from the target-domain rank in backlinks_summary). Default sort is rank descending. When ranking prospects, check referring_domains and backlinks together — a huge backlink count with few referring domains usually means sitewide boilerplate links, not authority.'
      tags:
      - 'SEO: Backlinks'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - targets
              properties:
                targets:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  maxItems: 20
                  description: Competitor domains whose backlink sources to intersect (1-20).
                exclude_targets:
                  type: array
                  items:
                    type: string
                  maxItems: 10
                  description: Domains the referring sites must NOT already link to. Put your own domain here.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 100
                  description: Max referring domains to return. Default 100.
                offset:
                  type: integer
                  minimum: 0
                  description: Pagination offset.
                filters:
                  type: array
                  items: {}
                  description: Optional filter expression, e.g. minimum domain rank.
                order_by:
                  type: array
                  items:
                    type: string
                  description: Sort rules, e.g. ["1.rank,desc"].
            example:
              targets:
              - competitor-a.com
              - competitor-b.com
              exclude_targets:
              - yourapp.com
              limit: 100
      responses:
        '200':
          description: Referring domains that link to the targets, in `result[0].items`.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request or upstream task error.
        '401':
          description: Unauthorized.
        '429':
          description: Too many requests.
        5XX:
          description: Upstream error.
      security:
      - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Bearer token. Pass your agntdata API key as: Authorization: Bearer agnt_live_...'