Alternative Columns - Stage 2

The Batch API currently accepts a wide range of alternative names for output columns.

These alternative names are undocumented and do not adhere to the official schema for output column names
(See Reading batch request output). We plan to deprecate their usage.

The following list outlines values that will be deprecated and replaced with a camel-case concatenation of the corresponding property values from the dedicated field.

To ensure clarity, all deprecated properties are presented in lowercase.

Understanding the Deprecation Table

The deprecation table lists all alternative column names currently accepted by the API. The API is lenient and accepts many different deprecated names for the same data property.

How to read the table:

  • When a row has a value in the "Valid property name" column, that deprecated name maps to the valid property name shown
  • Blank cells in the "Valid property name" column indicate that row also maps to the valid property shown in the nearest row above with a filled value
  • Multiple different deprecated names can map to the same valid property (e.g., displaylatitude and positionlatitude map to positionLat)
  • These aren't necessarily just formatting variations—they can be completely different names that the API accepts as aliases for the same property

Example: Both locationlabel and address map to addressLabel (blank cell in row for address means it maps to the valid name shown in the row above). Similarly, displaylatitude and positionlatitude map to positionLat.

Alternative property values

📘

Note

Effective starting October 2026.

DEPRECATED Column names

Deprecated property nameValid property name
labeltitle
name
displaycoordinateposition
displaylatitudepositionLat
positionlatitude
displaylongitudepositionLng
positionlongitude
navigationlatitudeaccessLat
accesslatitude
latitude
lat
navigationlongitudeaccessLng
accesslongitude
longitude
locationtyperesultType
matchtypehouseNumberType
locationlabeladdressLabel
address
countrycodeaddressCountryCode
country
countrynameaddressCountryName
statecodeaddressStateCode
statenameaddressState
state
countycodeaddressCountyCode
countynameaddressCounty
county
cityaddressCity
districtaddressDistrict
subdistrictnameaddressSubdistrict
subdistrict
streetnameaddressStreet
street
postalcodeaddressPostalCode
housenumberaddressHouseNumber
buildingaddressBuilding
mapReferencesPointAddressmapReferencesPointAddressHmcid
queryscorescoringQueryScore
relevance
matchqualitystreetscoringFieldScoreStreets
streetfieldscore
streetscore
matchqualityhousenumberscoringFieldScoreHouseNumber
housenumberfieldscore
housenumberscore
matchqualitybuildingscoringFieldScoreBuilding
buildingscore
matchqualitysubblockscoringFieldScoreSubblock
placenamefieldscorescoringFieldScorePlacename
matchqualitydistrictscoringFieldScoreDistrict
districtscore
matchqualitycityscoringFieldScoreCity
cityfieldscore
cityscore
matchqualitycountyscoringFieldScoreCounty
countyfieldscore
countyscore
matchqualitystatescoringFieldScoreState
statefieldscore
statescore
matchqualitycountryscoringFieldScoreCountry
countryfieldscore
countryscore
postalcodescorescoringFieldScorePostalCode
matchqualitypostalcode

Did this page help you?