Example: Address Autocomplete JSON POST Request & Response

Autocomplete Request

{
  "preferences": {
    "maxResults": 5,
    "originXY": [-73.875149,42.816381],
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "clientLocale": "",
    "clientCoordSysName": "",
    "distance": {
      "value": 25,
      "distanceUnit": "MILE"
    },
    "streetOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "customPreferences": {
        
    }
  },
  "address": {
    "addressLines": [
      "global"
    ],
    "country": "",
    "addressNumber": "",
    "admin1": "",
    "admin2": "",
    "city": "",
    "borough": "",
    "neighborhood": "",
    "suburb": "",
    "postalCode": "",
    "postalCodeExt": "",
    "placeName": "",
    "building": "",
    "floor": "",
    "room": "",
    "unit": "",
    "unitType": ""
  }
}

Autocomplete Response

{
  "status": "OK",
  "predictions": [
    {
      "prediction": "Global Vw, Troy, NY 12180",
      "distance": {
        "value": 12.727196089352999,
        "distanceUnit": "MILE"
      },
      "address": {
        "formattedAddress": "Global Vw, Troy NY 12180",
        "formattedStreetAddress": "Global Vw",
        "formattedLocationAddress": "Troy, NY 12180",
        "country": {
          "isoAlpha3Code": "USA"
        },
        "admin1": {
          "longName": "NY",
          "shortName": "NY"
        },
        "admin2": {},
        "city": {
          "longName": "Troy",
          "shortName": "Troy"
        },
        "neighborhood": {},
        "postalCode": "12180",
        "street": "Global Vw"
      },
      "addressLines": [
        "Global Vw",
        "Troy NY 12180"
      ],
      "location": {
        "feature": {
          "type": "Feature",
          "properties": {
            "crsName": "epsg:4326"
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -73.701415,
              42.682815
            ]
          }
        }
      },
      "explanation": {
        "addressMatch": {
          "description": [
            {
              "label": "placeName",
              "matchType": "NONE"
            },
            {
              "label": "addressNumber",
              "matchType": "NONE"
            },
            {
              "label": "admin1",
              "matchType": "NONE"
            },
            {
              "label": "admin2",
              "matchType": "NONE"
            },
            {
              "label": "city",
              "matchType": "NONE"
            },
            {
              "label": "neighborhood",
              "matchType": "NONE"
            },
            {
              "label": "suburb",
              "matchType": "NONE"
            },
            {
              "label": "street",
              "matchType": "PARTIAL",
              "matchedSubstring": "GLOBAL"
            },
            {
              "label": "postalCode",
              "matchType": "NONE"
            },
            {
              "label": "streetType",
              "matchType": "NONE"
            },
            {
              "label": "postalCodeExt",
              "matchType": "NONE"
            },
            {
              "label": "streetDirectional",
              "matchType": "NONE"
            }
          ]
        },
        "source": {
          "label": "ggs"
        }
      },
      "customFields": {
        "FORMATTED_STRING": "Global Vw, Troy, NY 12180",
        "DISTANCE": "12.727196089352999",
        "RECORD_TYPE": "2",
        "FEATUREID": "0000554e-3100-0400-0000-0000000d1361",
        "FROM_CUSTOM_DATASET": "false",
        "MATCHED_FROM_STREETNAME": "GLOBAL",
        "DISTANCE_UNIT": "MILES"
      }
    }
  ]
}