Input Parameters
A general Placekey API request body is a JSON object with the following possible parameters:
query.latitude
The latitude of the place in WGS-84 coordinates
double
37.7371
query.longitude
The longitude of the place in WGS-84 coordinates
double
-122.44283
query.location_name
The name of the place
string
"Twin Peaks Petroleum"
query.street_address
The street address of the place
string
"1543 Mission Street"
query.city
The city where the place is located
string
"San Francisco"
query.region
The second-level administrative region below nation for the place. In the US, this is the state.
string
"California" or "CA"
query.postal_code
The postal code for the place
string
"94105"
query.iso_country_code
The ISO 2-letter Country Code for the place
string
"US"
query.place_metadata.phone_number
The phone number of the POI
string
"+14151234567"
query.place_metadata.naics_code
4-digit or 6-digit NAICS code describing the business
string
"441110"
query.place_metadata.website
The web URL for the POI's publicly available website
string
"https://www.walmart.com/store/3114-saugus-ma/"
query.place_metadata.mcc_code
The merchant category code. A four-digit number used by credit card companies to classify businesses.
string
"9399"
query.place_metadata.store_id
The unique ID associated with the store as provided and maintained by the store/brand itself
string
"36558"
query_id
A custom identifier for this query. Echoed back in the response. Auto-assigned if not provided.
string
"my-query-1"
options.fields
A list of additional fields to include in the response. See Optional Responses.
array
["address_placekey", "confidence_score"]
📘 In order to return a Placekey some parameters are required. See Minimum Inputs for details.
Last updated