openapi: 3.1.0
info:
  title: Interzoid State Data Standardization API
  description: This API provides the two-letter state abbreviation (or the province abbreviation for Canada) for the purposes of standardizing state name data, improving query results, analytics, and data merging.
  contact:
    name: API Support
    url: https://www.interzoid.com
    email: support@interzoid.com
  version: '1.0.0'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://api.interzoid.com
  variables: {}
paths:
  /getstateabbreviation:
    get:
      tags:
      - State Data Standardization
      summary: getstateabbreviation
      description: Gets a two-letter abbreviation for a state or province given a permutation of state or province data.
      operationId: getstateabbreviation
      parameters:
      - name: license
        in: query
        description: Your Interzoid license API key. Register at www.interzoid.com/register-api-account
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: State (or province) name from which to retrieve the two letter abbreviation.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: State (or province) standardized two-letter abbreviation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetstateabbreviationResponse'
        '400':
          description: bad request - insufficient parameters
          headers: {}
          content: {}
        '402':
          description: credits exhausted
          headers: {}
          content: {}
        '403':
          description: invalid license API key
          headers: {}
          content: {}
        '405':
          description: method not allowed
          headers: {}
          content: {}
        '500':
          description: internal server error
          headers: {}
          content: {}
      deprecated: false
    parameters: []
components:
  schemas:
    GetstateabbreviationResponse:
      title: GetstateabbreviationResponse
      type: object
      properties:
        State:
          type: string
        Abbreviation:
          type: string
        Code:
          type: string
        Credits:
          type: string
tags:
- name: State Data Standardization
  description: ''
externalDocs:
  description: API home page and documentation
  url: https://www.interzoid.com/apis/standardize-state-province-data