evictionsapi-com Geo API

openapi: 3.2.0
info:
  title: Evictionsapi Com Geo API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Geo across 3 of this provider''s published API definitions: api.evictionsapi.com.json, evictionsapi-com-api-evictions-openapi.json, evictionsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.evictionsapi.com
tags:
- name: Geo
paths:
  /v1/geo/county:
    post:
      summary: Find the county of a street address, from the US Census geocoder.
      security:
      - ApiKey: []
      - SessionToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                line1:
                  type: string
                  minLength: 1
                  maxLength: 200
                unit:
                  type: string
                  minLength: 1
                  maxLength: 50
                city:
                  type: string
                  minLength: 1
                  maxLength: 100
                state:
                  type: string
                  pattern: ^[A-Za-z]{2}$
                zip:
                  type: string
                  pattern: ^\d{5}(-\d{4})?$
              required:
              - line1
              - state
              additionalProperties: false
      responses:
        '200':
          description: 'The address as sent, with `city` and `zip` filled in from the geocoder where they were missing, and the county as a case stores it: its short name in the US Census Bureau''s county list, without the word "County" or "Parish" (an independent city keeps "City", for example "Baltimore City"); or `{ "county": null }`, also when the geocoder names a county the list does not have.'
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  required:
                  - line1
                  - city
                  - state
                  - zip
                  - county
                  properties:
                    line1:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    zip:
                      type: string
                      description: Empty when neither the request nor the geocoder had one.
                    county:
                      type: string
                - type: object
                  required:
                  - county
                  properties:
                    county:
                      type: 'null'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person''s role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Geo
      operationId: postV1GeoCounty
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - details
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: An organization API key (`eak_test_...` or `eak_live_...`).
    SessionToken:
      type: http
      scheme: bearer
      description: 'A session token (`ess_...`) from `POST /v1/auth/signup` or `/v1/auth/login`, valid for 30 days. On the case, webhook, API key and organization routes it acts for the organization the session is in (`POST /v1/me/organization` switches it) in the mode named by the `X-Evictions-Mode` header: `test` (the default) or `live`.'
    AttorneyToken:
      type: http
      scheme: bearer
      description: A user token (`eut_...`) of a verified attorney.
externalDocs:
  url: https://evictionsapi.com/docs
x-refined-from:
- api.evictionsapi.com.json
- evictionsapi-com-api-evictions-openapi.json
- evictionsapi-com-openapi.json