Optional Responses
In addition to getting a placekey and a query_id, you can request additional fields by including them in the options.fields parameter. See the Example Queries section for full request examples.
"options": {"fields": ["address_placekey", "building_placekey", "confidence_score", "normalized_address", "geocode", "upi", "geoid", "parcel", "gers"]}address_placekey
string
Placekey for the address without location_name
building_placekey
string
Placekey for the address without suite or apartment number
confidence_score
string
Match confidence: HIGH, MEDIUM, or LOW
normalized_address
object
Structured parsed address components
geocode
object
Geographic coordinates and precision
upi
string
RESO Universal Parcel Identifier
parcel
string
Local parcel number
geoid
string
Census geographic identifier
gers
string
Overture Maps identifier (null if unavailable)
address_placekey
An address_placekey is a subcomponent of a Placekey that has the location_name not included in the request.
For the query: Starbucks, 48750 Seminole Dr Ste 105, Cabazon, CA, 92230, the address_placekey represents just the Placekey for the address (with no location_name): 48750 Seminole Dr Ste 105, Cabazon, CA, 92230
building_placekey
A building_placekey is a subcomponent of the address_placekey. It represents the Placekey for the address without the suite or apartment number.
For the query: Starbucks, 48750 Seminole Dr Ste 105, Cabazon, CA, 92230, the building_placekey represents just the Placekey for: 48750 Seminole Dr, Cabazon, CA, 92230
confidence_score
A confidence_score reflects the level of confidence in the accuracy of the assigned Placekey. Factors such as the quality of input data, the precision of geographical coordinates, and the comprehensiveness of available reference data all contribute to this score. Possible values are HIGH, MEDIUM, and LOW.
Providing more input parameters will generally lead to higher confidence.
normalized_address
A normalized_address is a structured and parsed representation of an address, ensuring consistency across datasets. It breaks down the address into key components for easier matching and integration with other data sources.
Example response:
geocode
Requesting geocode returns geographic coordinates for the matched address. This is useful when you need to place a result on a map or perform spatial analysis. Note that the geocode response uses lng (not longitude) for the longitude value.
Each geocode request counts as an additional lookup. For example, if your plan includes 10k lookups per day and each request includes a geocode, you can make 5k requests (each consuming 2 lookups).
Example response:
The location_type field indicates the precision of the geocode:
ROOFTOP: Located within the polygon of the corresponding building at the address.
PARCEL: Located within 20 meters of the corresponding building at the address.
APPROXIMATE: Located at the address but greater than 20 meters from a structure.
RANGE_INTERPOLATED: Inferred from surrounding addresses on the street.
Universal Parcel Identifier (UPI)
Universal Parcel Identifier (upi) developed by RESO is a standard for a single identifier that includes both parcel numbers and the geographies of the authorities that created them.
Example: "urn:reso:upi:2.0:US:06075:3511080"
Parcel Number
A parcel is a unique identifier assigned to a specific piece of land by a local government or tax authority, used to track property ownership, taxation, and legal descriptions.
Example: "3511080"
GEOID
A geoid (Geographic Identifier) is a code that uniquely identifies a specific geographic area, such as a census block, tract, county, or state. It is used to link geographic areas to census data or other geographic datasets.
Example: "06075"
GERS
A gers is an identifier provided by Overture Maps. You can return gers along with a Placekey to join datasets with the Overture Maps open datasets. This field returns null if no Overture Maps identifier is available for the location.
Last updated