Optional Responses

In addition to getting a placekey and a query_id, you can request as many of these additional fields as you would like within the fields parameter of the request. Full queries with these included are in the example queries section. For now:

"options":{"fields":["building_placekey","address_placekey", "confidence_score", "gers"]

address_placekey

An address_placekey is a subcomponent of a Placekey that has the location_name.

For the query: Starbucks, 48750 Seminole Dr Ste 105, Cabazon, CA, 92230, the address_placekey represets just the placekey for the address (with no location_name): 48750 Seminole Dr Ste 105, Cabazon, CA, 92230

The response will either start with 0kiksjkpg4@5vg-7gq-tvz

building_placekey

A building_placekey is a subcomponent of the address_placekey. It represents the query that goes into the address_placekey without the suite or apartment number.

Note: it does not necessary represent the "building" but just the postal address.

For the query: Starbucks, 48750 Seminole Dr Ste 105, Cabazon, CA, 92230, the building_placekey represets just the placekey for the address with the suite number stripped out: 48750 Seminole Dr, Cabazon, CA, 92230

confidence_score

A confidence_score reflects the level of confidence in the accuracy of the assigned Placekey. Various factors such as the quality of input data, the precision of geographical coordinates and address information, and the comprehensiveness of available reference data all contribute to this score.

The more input paramaters used will likely lead to higher confidence.

gers

A gers is an id provided by Overture Maps. Overture Overture has some super cool data on places in the US. You can return gers along with a placekey to make it easy to join other datasets to the Overture Maps open datasets.