back

Search Address

Scope: get_addresses
App Type: Agency
Authorization Type: Access token
Url: v3/addresses?lang={lang}&offset={offset}&limit={limit}&houseNumber={houseNumber}&houseNumberFraction={houseNumberFraction}&streetDirection={streetDirection}&streetName={streetName}&streetSuffixDirection={streetSuffixDirection}&streetSuffix={streetSuffix}&unitStart={unitStart}&unitEnd={unitEnd}&unitType={unitType}&city={city}&state={state}&zipCode={zipCode}&includeDisabled={includeDisabled}
HTTP Method: GET

Response Information

application/json

{
  "addresses": [
    {
      "id": "sample string 1",
      "display": "sample string 2",
      "addressFormat": "sample string 3",
      "houseNumber": "sample string 4",
      "houseNumberFraction": "sample string 5",
      "streetDirection": "sample string 6",
      "streetName": "sample string 7",
      "streetSuffix": "sample string 8",
      "streetSuffixDirection": "sample string 9",
      "unit": "sample string 10",
      "unitEnd": "sample string 11",
      "unitType": "sample string 12",
      "state": "sample string 13",
      "postalCode": "sample string 14",
      "city": "sample string 15",
      "county": "sample string 16",
      "country": "sample string 17",
      "isPrimary": "sample string 18",
      "xCoordinate": "sample string 19",
      "yCoordinate": "sample string 20",
      "enabled": true,
      "entityState": "sample string 22"
    }
  ],
  "page": {
    "totalRows": 1,
    "hasMore": true
  }
}