snoopscan-com Leads API

openapi: 3.2.0
info:
  title: SnoopScan Leads 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: Leads
paths:
  /v1/leads:
    post:
      tags:
      - Leads
      summary: Start Leads
      operationId: start_leads_v1_leads_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Start Leads V1 Leads Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/leads/sources:
    get:
      tags:
      - Leads
      summary: Leads Sources
      description: 'List the sources a Find Leads search covers for a country. Free.


        Pass `country` as a two-letter code (`US`, `GB`), or `where` as a place

        ("Houston, TX"). Returns the country used (null if it could not be

        determined) and, for each source, its `key`, `label` and `countries`

        (a list of codes, or "*" for everywhere).'
      operationId: leads_sources_v1_leads_sources_get
      parameters:
      - name: country
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
      - name: where
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Where
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Leads Sources V1 Leads Sources Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/leads/{job_id}:
    get:
      tags:
      - Leads
      summary: Leads Status
      description: 'Get a Find Leads run: its status, its leads and a summary.


        While `status` is `running`, `partial` is true and `leads` holds the leads

        found so far, without contacts yet. Once `completed`, the leads are final.

        A run stopped with DELETE is `cancelled` and keeps the leads it had,

        charged as usual. `summary.attribution` lists any license notices the

        leads carry: show each one with the results and in every export.'
      operationId: leads_status_v1_leads__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Leads Status V1 Leads  Job Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Leads
      summary: Cancel Leads
      description: 'Stop a Find Leads run.


        A queued run never starts and costs nothing. A running one stops within a

        few seconds and keeps the leads it had, charged per lead as usual. Its

        status becomes `cancelled`. A finished run is not changed.'
      operationId: cancel_leads_v1_leads__job_id__delete
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Cancel Leads V1 Leads  Job Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError