Example: Key Lookup Address JSON POST Request & 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

Lookup Request

{
  "type": "PB_KEY",
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "clientLocale": "",
    "clientCoordSysName": "",
    "distance": {
      "value": 150,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "customPreferences": {}
  },
  "keys": [
    {
      "keyValues": [
        {
          "key": "PBKEY",
          "value": "P0000GL638OL"
        },
        {
          "key": "country",
          "value": "USA"
        }
      ]
    }
  ]
} 

Lookup Response

{
  "responses": [
    {
      "status": "OK",
      "results": [
        {
          "score": 0,
          "address": {
            "formattedAddress": "350 JORDAN RD, TROY NY 12180-8352, United States",
            "formattedStreetAddress": "350 JORDAN RD",
            "formattedLocationAddress": "TROY, NY  12180-8352",
            "addressNumber": "350",
            "country": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "isoAlpha3Code": "USA",
              "isoNumericCode": "840"
            },
            "admin1": {
              "longName": "NY",
              "shortName": "NY"
            },
            "admin2": {
              "longName": "RENSSELAER COUNTY",
              "shortName": "RENSSELAER COUNTY"
            },
            "city": {
              "longName": "TROY",
              "shortName": "TROY"
            },
            "postalCode": "12180",
            "postalCodeExt": "8352",
            "street": "JORDAN"
          },
          "addressLines": [
            "350 JORDAN RD",
            "TROY NY 12180-8352",
            "United States"
          ],
          "location": {
            "explanation": {
              "type": "ADDRESS_POINT",
              "description": "BUILDING",
              "designation": "CENTROID"
            },
            "feature": {
              "type": "Feature",
              "properties": {
                "crsName": "epsg:4326"
              },
              "geometry": {
                "type": "Point",
                "coordinates": [
                  -73.699929,
                  42.678129
                ]
              }
            }
          },
          "explanation": {
            "addressMatch": {
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "NONE"
                },
                {
                  "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": "EXACT"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "EXACT"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "RESBUS": "X",
            "LOTSIZE_METERS": "16179",
            "CSA_NUMBER": "104",
            "TYPE_SHORT": "RD",
            "THOROUGHFARE_TYPE": "RD",
            "PARCEN_ELEVATION_METERS": "69.8",
            "ROAD_CLASS": "01",
            "MATCH_CODE": "V001",
            "DFLT": "Y",
            "COUNTY": "36083",
            "PB_KEY": "P0000GL638OL",
            "LANGUAGE": "en",
            "ADDRTYPE": "X",
            "INC_IND": "N",
            "POINT_ID": "108535989",
            "CHECK_DIGIT": "2",
            "METRO_FLAG": "Y",
            "BLOCK": "360830523011022",
            "POST_THOROUGHFARE_TYPE": "RD",
            "QCITY": "361303000",
            "ZIP_FACILITY": "P",
            "TFID": "264657610",
            "APN_ID": "383200 122.-1-4.92",
            "LOT_CODE": "A",
            "LOT_NUM": "0055",
            "GEOHASH": "dredfcm655vg",
            "CTYST_KEY": "V16572",
            "UACEPOP": "594962",
            "NAME": "JORDAN",
            "ZIP_CARRTSORT": "D",
            "LORANGE": "350",
            "CLOSE_MATCH": "T",
            "STREET_SIDE": "L",
            "MEC_LAT": "42678192",
            "DATATYPE": "12",
            "INTERSECTION": "F",
            "ZIP_CITY_DELV": "Y",
            "LOC_CODE": "AP05",
            "MEC_RAD": "361",
            "CART": "C099",
            "NAME_CITY": "TROY",
            "BLOCK_LEFT": "360830523011022",
            "COUNTY_FIPS": "36083",
            "HIRANGE": "350",
            "UACE": "970",
            "MEC_RAD_METERS": "110.1",
            "REC_TYPE": "H",
            "HI_RISE_DFLT": "Y",
            "URBANICITY": "L",
            "MEC_LON": "-73700378",
            "RESOLVED_LINE": "0",
            "PARCEN_ELEVATION": "229",
            "PREF_CITY": "TROY",
            "CBSA_NUMBER": "10580",
            "ALT_FLAG": "B",
            "SEGMENT_DIRECTION": "F",
            "ADDRLINE_SHORT": "350 JORDAN RD",
            "LOTSIZE": "174150",
            "CONFIDENCE": "96",
            "HIZIP4": "8352",
            "DATATYPE_NAME": "MASTER LOCATION",
            "SEGMENT_PARITY": "R",
            "LOZIP4": "8352",
            "CSA_NAME": "ALBANY-SCHENECTADY, NY COMBINED STATISTICAL AREA",
            "DPBC": "99",
            "LASTLINE_SHORT": "TROY, NY  12180-8352",
            "CITY_SHORT": "TROY",
            "NAME_SHORT": "JORDAN",
            "ZIP9": "121808352",
            "IS_ALIAS": "N01",
            "PRECISION_CODE": "S8H------A",
            "ZIP10": "12180-8352",
            "CBSA_NAME": "ALBANY-SCHENECTADY-TROY, NY METROPOLITAN STATISTICAL AREA",
            "RANGE_PARITY": "E"
          }
        }
      ]
    }
  ]
}