{
 "openapi": "3.1.0",
 "info": {
  "title": "Postal Codes",
  "description": "Twenty-five data, validation and utility APIs served from one server at separate path prefixes.",
  "version": "0.1.0"
 },
 "paths": {
  "/postal/v1/countries": {
   "get": {
    "tags": [
     "Postal Codes"
    ],
    "summary": "List covered countries",
    "operationId": "List covered countries",
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "additionalProperties": true,
         "type": "object",
         "title": "Response Countries Postal V1 Countries Get"
        }
       }
      }
     }
    }
   }
  },
  "/postal/v1/{country}/{code}": {
   "get": {
    "tags": [
     "Postal Codes"
    ],
    "summary": "Look up a postal code",
    "description": "Returns the place names, state or region, county and approximate centre coordinates for a postal code.",
    "operationId": "Look up a postal code",
    "parameters": [
     {
      "name": "country",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z]{2}$",
       "examples": [
        "US"
       ],
       "title": "Country"
      }
     },
     {
      "name": "code",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z0-9][A-Za-z0-9 \\-]{1,9}$",
       "examples": [
        "94105"
       ],
       "title": "Code"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "type": "object",
         "additionalProperties": true,
         "title": "Response Get Code Postal V1  Country   Code  Get"
        }
       }
      }
     },
     "422": {
      "description": "Validation Error",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/HTTPValidationError"
        }
       }
      }
     }
    }
   }
  },
  "/postal/v1/{country}/{code}/nearby": {
   "get": {
    "tags": [
     "Postal Codes"
    ],
    "summary": "Find postal codes within a radius",
    "operationId": "Find postal codes within a radius",
    "parameters": [
     {
      "name": "country",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z]{2}$",
       "examples": [
        "US"
       ],
       "title": "Country"
      }
     },
     {
      "name": "code",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z0-9][A-Za-z0-9 \\-]{1,9}$",
       "examples": [
        "94105"
       ],
       "title": "Code"
      }
     },
     {
      "name": "radius_km",
      "in": "query",
      "required": false,
      "schema": {
       "type": "number",
       "maximum": 200,
       "exclusiveMinimum": 0,
       "default": 10,
       "title": "Radius Km"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 200,
       "minimum": 1,
       "default": 25,
       "title": "Limit"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "type": "object",
         "additionalProperties": true,
         "title": "Response Nearby Postal V1  Country   Code  Nearby Get"
        }
       }
      }
     },
     "422": {
      "description": "Validation Error",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/HTTPValidationError"
        }
       }
      }
     }
    }
   }
  },
  "/postal/v1/distance": {
   "get": {
    "tags": [
     "Postal Codes"
    ],
    "summary": "Distance between two postal codes",
    "description": "Straight-line distance between the approximate centres of two postal codes.",
    "operationId": "Distance between two postal codes",
    "parameters": [
     {
      "name": "from_country",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z]{2}$",
       "examples": [
        "US"
       ],
       "title": "From Country"
      }
     },
     {
      "name": "from_code",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z0-9][A-Za-z0-9 \\-]{1,9}$",
       "examples": [
        "94105"
       ],
       "title": "From Code"
      }
     },
     {
      "name": "to_country",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z]{2}$",
       "examples": [
        "US"
       ],
       "title": "To Country"
      }
     },
     {
      "name": "to_code",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z0-9][A-Za-z0-9 \\-]{1,9}$",
       "examples": [
        "10001"
       ],
       "title": "To Code"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "type": "object",
         "additionalProperties": true,
         "title": "Response Distance Postal V1 Distance Get"
        }
       }
      }
     },
     "422": {
      "description": "Validation Error",
      "content": {
       "application/json": {
        "schema": {
         "$ref": "#/components/schemas/HTTPValidationError"
        }
       }
      }
     }
    }
   }
  },
  "/postal/v1/{country}/search/place": {
   "get": {
    "tags": [
     "Postal Codes"
    ],
    "summary": "Find postal codes by place name",
    "operationId": "Find postal codes by place name",
    "parameters": [
     {
      "name": "country",
      "in": "path",
      "required": true,
      "schema": {
       "type": "string",
       "pattern": "^[A-Za-z]{2}$",
       "examples": [
        "DE"
       ],
       "title": "Country"
      }
     },
     {
      "name": "q",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string",
       "minLength": 2,
       "maxLength": 60,
       "examples": [
        "Heidelberg"
       ],
       "title": "Q"
      }
     },
     {
      "name": "state_code",
      "in": "query",
      "required": false,
      "schema": {
       "anyOf": [
        {
         "type": "string",
         "maxLength": 10
        },
        {
         "type": "null"
        }
       ],
       "title": "State Code"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "schema": {
       "type": "integer",
       "maximum": 200,
       "minimum": 1,
       "default": 25,
       "title": "Limit"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Successful Response",
      "content": {
       "application/json": {
        "schema": {
         "type": "object",
         "additionalProperties": true,
         "title": "Response By Place Postal V1  Country  Search Place Get"
        }
       }
      }
     },
     "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"
   }
  }
 }
}
