snoopscan-com Domain API

openapi: 3.2.0
info:
  title: SnoopScan Domain API
  description: 'Turn any public web page into clean markdown or structured JSON: scrape, crawl, map, search and extract. One bearer key for every endpoint.'
  version: 0.1.0
servers:
- url: https://api.snoopscan.com
tags:
- name: Domain
paths:
  /v1/domain:
    post:
      tags:
      - Domain
      summary: Domain Intelligence
      operationId: domain_intelligence_v1_domain_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Domain Intelligence V1 Domain Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/domain/report:
    post:
      tags:
      - Domain
      summary: Domain Report
      description: 'Get a buyer''s report on a domain: key findings, concerns, open questions

        for the seller, and the evidence behind each.'
      operationId: domain_report_v1_domain_report_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainReportRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Domain Report V1 Domain Report Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/domain/history/snapshots:
    post:
      tags:
      - Domain
      summary: Domain History Snapshots
      description: 'Load the archived snapshots a domain report left `pending`.


        Any still not loaded when the call returns stay in `pending`: call again.'
      operationId: domain_history_snapshots_v1_domain_history_snapshots_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainSnapshotsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Domain History Snapshots V1 Domain History Snapshots Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/domain/screen:
    post:
      tags:
      - Domain
      summary: Domain Screen
      description: 'Check which of up to 500 domain names can be registered.


        A long list takes a while: allow about a quarter second per name.'
      operationId: domain_screen_v1_domain_screen_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainScreenRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Domain Screen V1 Domain Screen Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DomainSnapshotsRequest:
      properties:
        domain:
          type: string
          title: Domain
          description: The domain the report was for, or any URL on it.
        years:
          anyOf:
          - items:
              type: integer
              maximum: 2100.0
              minimum: 1990.0
            type: array
            maxItems: 24
          - type: 'null'
          title: Years
          description: Only these years (from the report's `evidence.history.pending`). Omit for every snapshot not yet read.
        snapshots:
          type: integer
          maximum: 24.0
          minimum: 1.0
          title: Snapshots
          description: How many snapshots the report chose, one per year at most. Pass the report's own figure (6 for `buyer` unless you set `snapshots`).
          default: 6
      additionalProperties: false
      type: object
      required:
      - domain
      title: DomainSnapshotsRequest
      description: 'Load the archived snapshots a `buyer` or `deep` domain report left `pending`.


        Snapshots included in the report are free here for 7 days. Beyond those,

        each snapshot loaded costs 1 credit, and one already loaded is free.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DomainScreenRequest:
      properties:
        domains:
          items:
            type: string
          type: array
          maxItems: 500
          minItems: 1
          title: Domains
          description: Up to 500 domains, or URLs on them. Duplicates are checked once.
        dns:
          type: boolean
          title: Dns
          description: Check DNS for names the registry has no record of, so they can read `likely_available`. Off, they read `no_registry_record`.
          default: true
      additionalProperties: false
      type: object
      required:
      - domains
      title: DomainScreenRequest
      description: 'Check up to 500 domain names for availability, from each registry''s

        record and DNS. 1 credit per name the registry answers for; invalid names,

        duplicates and names the registry does not answer for are free.'
    DomainRequest:
      properties:
        domain:
          type: string
          title: Domain
          description: A domain, or any URL on it. `https://www.example.com/a` and `example.com` are the same request.
        registration:
          type: boolean
          title: Registration
          description: Registration and expiry dates, age, registrar and nameservers.
          default: true
        dns:
          type: boolean
          title: Dns
          description: A, AAAA, MX, NS and TXT records.
          default: true
        backlinks:
          type: boolean
          title: Backlinks
          description: Domains known to link to this one.
          default: true
        backlinkLimit:
          type: integer
          maximum: 1000.0
          minimum: 1.0
          title: Backlinklimit
          description: How many referring domains to list, busiest first.
          default: 100
      additionalProperties: false
      type: object
      required:
      - domain
      title: DomainRequest
      description: Look up a domain's registration, DNS and backlinks. All three are on by default.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DomainReportRequest:
      properties:
        domain:
          type: string
          title: Domain
          description: A domain, or any URL on it. `https://www.example.com/a` and `example.com` are the same request.
        depth:
          type: string
          enum:
          - quick
          - buyer
          - deep
          title: Depth
          description: '`quick` for registration, DNS and today''s site; `buyer` adds history, backlinks and link checks; `deep` uses larger samples.'
          default: buyer
        snapshots:
          anyOf:
          - type: integer
            maximum: 24.0
            minimum: 0.0
          - type: 'null'
          title: Snapshots
          description: How many archived homepage snapshots to read, one per year at most. Defaults to 6 for `buyer` and 12 for `deep`.
        verifyLinks:
          anyOf:
          - type: integer
            maximum: 100.0
            minimum: 0.0
          - type: 'null'
          title: Verifylinks
          description: How many linking pages to check for the link. Defaults to 20 for `buyer` and 50 for `deep`.
      additionalProperties: false
      type: object
      required:
      - domain
      title: DomainReportRequest
      description: 'A buyer''s report on a domain. Each depth includes the one before it.


        `quick`: registration, DNS, mail records and today''s website. `buyer`: adds

        archive history, known backlinks and a check that a sample of linking pages

        still link. `deep`: the buyer report with larger samples. One flat price per

        depth, with archived snapshots included (6 for `buyer`, 12 for `deep`);

        each snapshot beyond those costs 1 credit.'