Example: Geocode JSON Request and Response - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

JSON Request

Using the Addressing API, the following is an example of a JSON request for the Geocode Service. In this example, Delivery Point Validation (DPV) and SuiteLink processing are enabled in customPreferences.

{
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "customPreferences": {
     "FIND_DPV": "true",
     "FIND_SUITELINK": "true"
    }
  },
  "addresses": [
    {
      "addressLines": [
        "2502 N ROCKY POINT DR"
      ],
      "country": "USA",
      "addressNumber": "",
      "admin1": "FL",
      "admin2": "",
      "city": "Tampa",
      "postalCode": "33607",
      "postalCodeExt": "",
      "placeName": "DRAKE BEAM"
    }
  ]
}

JSON Response

The following shows the JSON response returned by the previous request.

{
  "responses": [
    {
      "status": "OK",
      "results": [
        {
          "score": 100,
          "address": {
            "formattedAddress": "DRAKE BEAM, 2502 ROCKY POINT DR STE 890, TAMPA FL 33607-5994",
            "formattedStreetAddress": "2502 N ROCKY POINT DR STE 890",
            "formattedLocationAddress": "TAMPA, FL  33607-5994",
            "addressNumber": "2502",
            "country": {
              "isoAlpha3Code": "USA"
            },
            "admin1": {
              "longName": "FL",
              "shortName": "FL"
            },
            "admin2": {
              "longName": "HILLSBOROUGH COUNTY",
              "shortName": "HILLSBOROUGH COUNTY"
            },
            "city": {
              "longName": "TAMPA",
              "shortName": "TAMPA"
            },
            "neighborhood": {},
            "postalCode": "33607",
            "postalCodeExt": "5994",
            "placeName": "DRAKE BEAM",
            "unit": "890",
            "unitType": "STE",
            "street": "ROCKY POINT"
          },
          "addressLines": [
            "DRAKE BEAM",
            "2502 ROCKY POINT DR STE 890",
            "TAMPA FL 33607-5994"
          ],
          "location": {
            "explanation": {
              "type": "ADDRESS_POINT"
            },
            "feature": {
              "type": "Feature",
              "properties": {
                "crsName": "epsg:4326"
              },
              "geometry": {
                "type": "Point",
                "coordinates": [
                  -82.571057,
                  27.962831
                ]
              }
            }
          },
          "explanation": {
            "addressMatch": {
              "type": "ADDRESS",
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "EXACT"
                },
                {
                  "label": "admin1",
                  "matchType": "EXACT"
                },
                {
                  "label": "admin2",
                  "matchType": "NONE"
                },
                {
                  "label": "city",
                  "matchType": "EXACT"
                },
                {
                  "label": "neighborhood",
                  "matchType": "NONE"
                },
                {
                  "label": "suburb",
                  "matchType": "NONE"
                },
                {
                  "label": "street",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCode",
                  "matchType": "EXACT"
                },
                {
                  "label": "streetType",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "NONE"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "EXACT"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "RESBUS": "B",
            "LOTSIZE_METERS": "21522",
            "TYPE_SHORT": "DR",
            "DPV_VACANT": "N",
            "THOROUGHFARE_TYPE": "DR",
            "DPV_NO_STAT": "N",
            "HIUNIT": "890",
            "PARCEN_ELEVATION_METERS": "1.6",
            "ROAD_CLASS": "01",
            "RDI_RETCODE": "N",
            "MATCH_CODE": "S800",
            "DPV_CONFIRM": "Y",
            "COUNTY": "12057",
            "PB_KEY": "P00005K7PTFV",
            "LANGUAGE": "en",
            "UNIT_TYPE": "STE",
            "INC_IND": "I",
            "ADDRTYPE": "M",
            "POINT_ID": "106197067",
            "CHECK_DIGIT": "8",
            "METRO_FLAG": "Y",
            "BLOCK": "120570117081024",
            "POST_THOROUGHFARE_TYPE": "DR",
            "QCITY": "120410000",
            "ZIP_FACILITY": "P",
            "TFID": "262540600",
            "UNIT_RANGE_PARITY": "E",
            "APN_ID": "172914ZZZ000005347100A",
            "LOT_CODE": "A",
            "LOT_NUM": "0122",
            "GEOHASH": "dhvr143x6ct2",
            "PREDIR": "N",
            "CTYST_KEY": "Y23079",
            "UACEPOP": "2441770",
            "ZIP_CARRTSORT": "D",
            "NAME": "ROCKY POINT",
            "SUITELINK_RET_CODE": "A",
            "CLOSE_MATCH": "T",
            "LORANGE": "2502",
            "MEC_LAT": "27962769",
            "STREET_SIDE": "L",
            "DPV_CMRA": "N",
            "DATATYPE": "12",
            "ZIP_CITY_DELV": "Y",
            "INTERSECTION": "F",
            "LOUNIT": "890",
            "LOC_CODE": "AP02",
            "MEC_RAD": "385",
            "CART": "C034",
            "NAME_CITY": "TAMPA",
            "BLOCK_LEFT": "120570117081024",
            "VALIDATION_CONFIDENCE": "97",
            "COUNTY_FIPS": "12057",
            "HIRANGE": "2502",
            "UACE": "86599",
            "MEC_RAD_METERS": "117.2",
            "REC_TYPE": "H",
            "HI_RISE_DFLT": "N",
            "URBANICITY": "L",
            "MEC_LON": "-82571091",
            "MATCH_TYPE": "ADDRESS",
            "RESOLVED_LINE": "0",
            "PARCEN_ELEVATION": "5",
            "ADDRESS_LINE1": "DRAKE BEAM",
            "ADDRESS_LINE2": "2502 ROCKY POINT DR STE 890",
            "ADDRESS_LINE3": "TAMPA FL 33607-5994",
            "PREF_CITY": "TAMPA",
            "CBSA_NUMBER": "45300",
            "ALT_FLAG": "B",
            "SEGMENT_DIRECTION": "F",
            "ADDRLINE_SHORT": "2502 N ROCKY POINT DR STE 890",
            "LOTSIZE": "231662",
            "CONFIDENCE": "100",
            "HIZIP4": "5994",
            "DATATYPE_NAME": "MASTER LOCATION",
            "SEGMENT_PARITY": "R",
            "LOZIP4": "5994",
            "PREDIR_SHORT": "N",
            "PLACE": "1271000",
            "DPBC": "15",
            "LASTLINE_SHORT": "TAMPA, FL  33607-5994",
            "DPV_SHUTDOWN": "N",
            "DPV_FOOTNOTE2": "BB",
            "DPV_FOOTNOTE1": "AA",
            "CITY_SHORT": "TAMPA",
            "NAME_SHORT": "ROCKY POINT",
            "ZIP9": "336075994",
            "IS_ALIAS": "N01",
            "PRECISION_CODE": "S8HPNTSCZA",
            "ZIP10": "33607-5994",
            "CBSA_NAME": "TAMPA-ST. PETERSBURG-CLEARWATER, FL METROPOLITAN STATISTICAL AREA",
            "RANGE_PARITY": "E"
          }
        }
      ]
    }
  ]
}