{
 "openapi": "3.1.0",
 "info": {
  "title": "Website Contact Extractor",
  "description": "Twenty-five data, validation and utility APIs served from one server at separate path prefixes.",
  "version": "0.1.0"
 },
 "paths": {
  "/contacts/v1/site": {
   "get": {
    "tags": [
     "Website Contact Extractor"
    ],
    "summary": "Find a website's emails, phone numbers and social profiles",
    "description": "Reads the page given, then the site's likely contact pages (contact, imprint, about, team, support, in several languages), and returns the emails, phone numbers, social profiles, postal addresses and contact forms it finds, each with the pages it was seen on. Emails hidden with mailto links, Cloudflare obfuscation or \"name [at] domain [dot] com\" are decoded. robots.txt is honoured and JavaScript is not run.",
    "operationId": "Find a website's emails, phone numbers and social profiles",
    "parameters": [
     {
      "name": "url",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "minLength": 4,
       "maxLength": 2000,
       "description": "A domain such as example.com, or a full URL starting with http:// or https://.",
       "examples": [
        "https://www.python.org/"
       ],
       "title": "Url"
      },
      "description": "A domain such as example.com, or a full URL starting with http:// or https://."
     },
     {
      "name": "max_pages",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 10,
       "minimum": 1,
       "description": "Pages to read, counting the one given. Extra pages are the site's own contact, imprint, about and team pages.",
       "default": 5,
       "title": "Max Pages"
      },
      "description": "Pages to read, counting the one given. Extra pages are the site's own contact, imprint, about and team pages."
     },
     {
      "name": "default_country",
      "in": "query",
      "required": false,
      "schema": {
       "anyOf": [
        {
         "type": "string",
         "pattern": "^[A-Za-z]{2}$"
        },
        {
         "type": "null"
        }
       ],
       "description": "Two-letter country for phone numbers written without a + country code. Guessed from the site when left out.",
       "title": "Default Country"
      },
      "description": "Two-letter country for phone numbers written without a + country code. Guessed from the site when left out."
     },
     {
      "name": "validate_emails",
      "in": "query",
      "required": false,
      "schema": {
       "type": "boolean",
       "description": "Also look up each email domain's mail servers (adds up to a few seconds).",
       "default": false,
       "title": "Validate Emails"
      },
      "description": "Also look up each email domain's mail servers (adds up to a few seconds)."
     }
    ],
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "type": "object",
         "additionalProperties": true,
         "title": "Response Site Contacts V1 Site Get"
        }
       }
      }
     },
     "422": {
      "description": "Validation Error",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/HTTPValidationError"
        }
       }
      }
     }
    }
   }
  },
  "/contacts/v1/page": {
   "get": {
    "tags": [
     "Website Contact Extractor"
    ],
    "summary": "Extract contact details from one page",
    "description": "Reads only the page given and returns its emails, phone numbers, social profiles, addresses and contact form, plus the links on it that most likely lead to more contact details.",
    "operationId": "Extract contact details from one page",
    "parameters": [
     {
      "name": "url",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "minLength": 4,
       "maxLength": 2000,
       "description": "A domain such as example.com, or a full URL starting with http:// or https://.",
       "examples": [
        "https://www.python.org/"
       ],
       "title": "Url"
      },
      "description": "A domain such as example.com, or a full URL starting with http:// or https://."
     },
     {
      "name": "default_country",
      "in": "query",
      "required": false,
      "schema": {
       "anyOf": [
        {
         "type": "string",
         "pattern": "^[A-Za-z]{2}$"
        },
        {
         "type": "null"
        }
       ],
       "description": "Two-letter country for phone numbers written without a + country code. Guessed from the site when left out.",
       "title": "Default Country"
      },
      "description": "Two-letter country for phone numbers written without a + country code. Guessed from the site when left out."
     },
     {
      "name": "validate_emails",
      "in": "query",
      "required": false,
      "schema": {
       "type": "boolean",
       "description": "Also look up each email domain's mail servers.",
       "default": false,
       "title": "Validate Emails"
      },
      "description": "Also look up each email domain's mail servers."
     }
    ],
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "type": "object",
         "additionalProperties": true,
         "title": "Response Page Contacts V1 Page Get"
        }
       }
      }
     },
     "422": {
      "description": "Validation Error",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/HTTPValidationError"
        }
       }
      }
     }
    }
   }
  },
  "/contacts/v1/site/batch": {
   "post": {
    "tags": [
     "Website Contact Extractor"
    ],
    "summary": "Find contact details for up to 10 websites",
    "description": "Runs the site lookup for each domain, three at a time. A site that fails gets an error entry instead of stopping the batch.",
    "operationId": "Find contact details for up to 10 websites",
    "requestBody": {
     "content": {
      "application/json": {
       "schema": {
        "$ref": "#/components/schemas/app__routers__contacts__BatchBody"
       }
      }
     },
     "required": true
    },
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "additionalProperties": true,
         "type": "object",
         "title": "Response Site Batch Contacts V1 Site Batch Post"
        }
       }
      }
     },
     "422": {
      "description": "Validation Error",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/HTTPValidationError"
        }
       }
      }
     }
    }
   }
  }
 },
 "components": {
  "schemas": {
   "AgentsIn": {
    "properties": {
     "user_agents": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "title": "User Agents",
      "description": "Up to 200 User-Agent strings."
     }
    },
    "type": "object",
    "required": [
     "user_agents"
    ],
    "title": "AgentsIn"
   },
   "Ats": {
    "type": "string",
    "enum": [
     "greenhouse",
     "lever",
     "ashby",
     "workable",
     "smartrecruiters",
     "recruitee",
     "personio",
     "rippling",
     "workday"
    ],
    "title": "Ats"
   },
   "BoardRef": {
    "properties": {
     "ats": {
      "$ref": "#/components/schemas/Ats"
     },
     "board": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$",
      "title": "Board"
     }
    },
    "type": "object",
    "required": [
     "ats",
     "board"
    ],
    "title": "BoardRef"
   },
   "CardBody": {
    "properties": {
     "number": {
      "type": "string",
      "maxLength": 40,
      "minLength": 12,
      "title": "Number",
      "examples": [
       "4111 1111 1111 1111"
      ]
     }
    },
    "type": "object",
    "required": [
     "number"
    ],
    "title": "CardBody"
   },
   "Ecc": {
    "type": "string",
    "enum": [
     "L",
     "M",
     "Q",
     "H"
    ],
    "title": "Ecc"
   },
   "HTTPValidationError": {
    "properties": {
     "detail": {
      "items": {
       "$ref": "#/components/schemas/ValidationError"
      },
      "type": "array",
      "title": "Detail"
     }
    },
    "type": "object",
    "title": "HTTPValidationError"
   },
   "HashIn": {
    "properties": {
     "text": {
      "type": "string",
      "maxLength": 1000000,
      "title": "Text"
     },
     "algorithms": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "title": "Algorithms",
      "default": [
       "md5",
       "sha1",
       "sha256",
       "sha512"
      ]
     }
    },
    "type": "object",
    "required": [
     "text"
    ],
    "title": "HashIn"
   },
   "PasswordIn": {
    "properties": {
     "password": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1,
      "title": "Password"
     },
     "user_inputs": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "maxItems": 10,
      "title": "User Inputs",
      "description": "Optional words tied to the user (name, email, site name) that should count as guessable."
     }
    },
    "type": "object",
    "required": [
     "password"
    ],
    "title": "PasswordIn"
   },
   "QrFormat": {
    "type": "string",
    "enum": [
     "png",
     "svg",
     "json"
    ],
    "title": "QrFormat"
   },
   "SearchBody": {
    "properties": {
     "boards": {
      "items": {
       "$ref": "#/components/schemas/BoardRef"
      },
      "type": "array",
      "maxItems": 20,
      "minItems": 1,
      "title": "Boards",
      "description": "The company boards to search."
     },
     "q": {
      "anyOf": [
       {
        "type": "string",
        "maxLength": 100
       },
       {
        "type": "null"
       }
      ],
      "title": "Q"
     },
     "location": {
      "anyOf": [
       {
        "type": "string",
        "maxLength": 100
       },
       {
        "type": "null"
       }
      ],
      "title": "Location"
     },
     "remote": {
      "anyOf": [
       {
        "type": "boolean"
       },
       {
        "type": "null"
       }
      ],
      "title": "Remote"
     },
     "posted_after": {
      "anyOf": [
       {
        "type": "string",
        "format": "date-time"
       },
       {
        "type": "null"
       }
      ],
      "title": "Posted After",
      "description": "Keep jobs posted at or after this time (ISO 8601)."
     },
     "limit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1,
      "title": "Limit",
      "default": 50
     }
    },
    "type": "object",
    "required": [
     "boards"
    ],
    "title": "SearchBody"
   },
   "Sort": {
    "type": "string",
    "enum": [
     "most_recent",
     "most_helpful"
    ],
    "title": "Sort"
   },
   "Symbology": {
    "type": "string",
    "enum": [
     "code128",
     "code39",
     "ean13",
     "ean8",
     "upca",
     "isbn13",
     "itf"
    ],
    "title": "Symbology"
   },
   "TextIn": {
    "properties": {
     "text": {
      "type": "string",
      "maxLength": 100000,
      "minLength": 1,
      "title": "Text",
      "description": "The text to analyse (up to 100,000 characters)."
     }
    },
    "type": "object",
    "required": [
     "text"
    ],
    "title": "TextIn"
   },
   "TextsIn": {
    "properties": {
     "texts": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "title": "Texts",
      "description": "Up to 100 texts of at most 5,000 characters each."
     }
    },
    "type": "object",
    "required": [
     "texts"
    ],
    "title": "TextsIn"
   },
   "TokenIn": {
    "properties": {
     "token": {
      "type": "string",
      "maxLength": 8192,
      "minLength": 5,
      "title": "Token"
     }
    },
    "type": "object",
    "required": [
     "token"
    ],
    "title": "TokenIn"
   },
   "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"
   },
   "app__routers__contacts__BatchBody": {
    "properties": {
     "urls": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "maxItems": 10,
      "minItems": 1,
      "title": "Urls",
      "description": "Domains or URLs, one per site."
     },
     "max_pages": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "title": "Max Pages",
      "description": "Pages to read per site.",
      "default": 3
     },
     "default_country": {
      "anyOf": [
       {
        "type": "string",
        "pattern": "^[A-Za-z]{2}$"
       },
       {
        "type": "null"
       }
      ],
      "title": "Default Country"
     },
     "validate_emails": {
      "type": "boolean",
      "title": "Validate Emails",
      "default": false
     }
    },
    "type": "object",
    "required": [
     "urls"
    ],
    "title": "BatchBody"
   },
   "app__routers__email__BatchBody": {
    "properties": {
     "emails": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "maxItems": 50,
      "minItems": 1,
      "title": "Emails"
     },
     "check_mx": {
      "type": "boolean",
      "title": "Check Mx",
      "default": true
     }
    },
    "type": "object",
    "required": [
     "emails"
    ],
    "title": "BatchBody"
   },
   "app__routers__ip__BatchBody": {
    "properties": {
     "ips": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "maxItems": 100,
      "minItems": 1,
      "title": "Ips"
     }
    },
    "type": "object",
    "required": [
     "ips"
    ],
    "title": "BatchBody"
   },
   "app__routers__phone__BatchBody": {
    "properties": {
     "numbers": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "maxItems": 100,
      "minItems": 1,
      "title": "Numbers"
     },
     "default_country": {
      "anyOf": [
       {
        "type": "string",
        "pattern": "^[A-Za-z]{2}$"
       },
       {
        "type": "null"
       }
      ],
      "title": "Default Country"
     }
    },
    "type": "object",
    "required": [
     "numbers"
    ],
    "title": "BatchBody"
   },
   "app__routers__vin__BatchBody": {
    "properties": {
     "vins": {
      "items": {
       "type": "string"
      },
      "type": "array",
      "maxItems": 50,
      "minItems": 1,
      "title": "Vins"
     }
    },
    "type": "object",
    "required": [
     "vins"
    ],
    "title": "BatchBody"
   }
  }
 }
}
