{
  "openapi": "3.0.4",
  "info": {
    "title": "CDXGeoData REST API",
    "description": "GeoData API v2",
    "version": "v2"
  },
  "paths": {
    "/api/v2/geocode": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "address",
            "in": "query",
            "description": "Full street address",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "city",
            "in": "query",
            "description": "City",
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "state",
            "in": "query",
            "description": "State",
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "zipCode",
            "in": "query",
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "country",
            "in": "query",
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/geocode/single": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query",
            "in": "query",
            "description": "Full or partial address",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/geocode/reverse": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "latitude",
            "in": "query",
            "description": "Latitude Coordinate",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "longitude",
            "in": "query",
            "description": "LongitudeCoordinate",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/georoute": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Calculate travel (driving) distance and time using routing data from HERE Technologies with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "transportMode",
            "in": "query",
            "description": "Transportation Mode",
            "schema": {
              "type": "string",
              "default": "car"
            }
          },
          {
            "name": "routingMode",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "fast"
            }
          },
          {
            "name": "origin",
            "in": "query",
            "description": "Starting point, landmark, or address",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "destination",
            "in": "query",
            "description": "Ending point, landmark, or address",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "wayPoints",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/geoverify": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Perform address verification and correction using U.S. Postal Service databases. Get address data in standard format and find ZIP+4 Codes even for addresses with missing data.",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "address",
            "in": "query",
            "description": "Street Address",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "cityStateZip",
            "in": "query",
            "description": "City, State and optional Zip code (separated by commas)",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/geoverifysingle": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Perform address verification and correction using U.S. Postal Service databases. Get address data in standard format and find ZIP+4 Codes even for addresses with missing data.",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "address",
            "in": "query",
            "description": "Street Address",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "name": "delimiter",
            "in": "query",
            "description": "Character used to concatenate full address data into address,city,state,zip",
            "schema": {
              "type": "string",
              "default": ","
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/utility/tokenusage": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Returns token usage for the specified Api key",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/v2/utility/servicelist": {
      "get": {
        "tags": [
          "CDXGeoData V2"
        ],
        "summary": "Returns a complete list of available Api services",
        "parameters": [
          {
            "name": "cdx-api-key",
            "in": "header",
            "description": "Your API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "serviceCallName",
            "in": "query",
            "description": "When specified only details of the named service will be returned",
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": { }
}