Anymail Finder Domain API

openapi: 3.2.0
info:
  title: Anymail finder Domain API
  description: ''
  version: '5.1'
  contact: {}
servers:
- url: https://api.anymailfinder.com
tags:
- name: Domain
paths:
  /v5.1/domain/{domain}/email/download:
    get:
      description: Please note that the file should have been paid previously using the payment endpoint. After the payment the file will be processed asynchronously, you have the option to receive a webhook once the file is ready.
      operationId: download
      parameters:
      - name: domain
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          content:
            text/csv: {}
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
      security:
      - api_key: []
      summary: Download a CSV file containing all the emails of a domain
      tags:
      - Domain
  /v5.1/domain/{domain}/email/order:
    post:
      description: The payment will happen asynchronously, you can specify a url where we will send a webhook once the file is ready to be downloaded. Please note that emails provided in this file are not verified for accuracy.
      operationId: domainEmailOrder
      parameters:
      - name: domain
        required: true
        in: path
        schema:
          type: string
      - name: x-webhook-url
        in: header
        description: If provided, the result will be POSTed to this URL instead of waiting for the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Payment started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51SuccessResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
        '402':
          description: Upgrade needed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
      security:
      - api_key: []
      summary: Pay to download the file containing all the emails of a domain
      tags:
      - Domain
  /v5.1/domain/{domain}/email:
    get:
      description: This endpoint will return the number of emails available and the price to download the whole file.
      operationId: domainEmailInfo
      parameters:
      - name: domain
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Domain infos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51DomainEmailDownloadInfoDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api51ErrorResponseDto'
      security:
      - api_key: []
      summary: Get the number of emails we have for a specified domain
      tags:
      - Domain
components:
  schemas:
    Api51SuccessResponseDto:
      type: object
      properties:
        input:
          type: object
          description: Your request original input.
      required:
      - input
    Api51DomainEmailDownloadInfoDto:
      type: object
      properties:
        credits_required:
          type: number
          description: The number of credits required to download all emails for the domain.
          example: 123
        domain:
          type: string
          description: The requested domain.
          example: anymailfinder.com
        email_count:
          type: number
          description: The total number of emails available in the database for this domain.
          example: 123
        status:
          enum:
          - queued
          - ready
          - null
          type:
          - string
          - 'null'
          description: The status of the requested file (null = file not yet ordered, queued = file being prepared, ready = file ready to download).
          example: null
      required:
      - credits_required
      - domain
      - email_count
      - status
    Api51ErrorResponseDto:
      type: object
      properties:
        error:
          type: string
          description: Error code
          example: no_result
        message:
          type: string
          description: Detailed explanation of the error
          example: We could not find an email for this person. Sorry.
      required:
      - error
      - message
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization