Docs
  • 👋Welcome
    • Overview
    • Placekey Design
    • Placekey Types
  • API Overview
    • Authentication
    • Usage Limits
    • Error Codes
    • Supported Countries
  • Placekey API
    • Quick Start
    • Input Parameters
      • Minimum Inputs
      • Optional Parameters
    • Response
      • Optional Responses
    • Bulk API
    • Example Queries
    • Placekey Lineage File
  • Geocoder
    • Introduction
    • Usage Limit
    • Status Descriptions
    • Example
  • Join Data Product
    • Join Data
  • Libraries
    • Python
    • Javascript
  • Integrations
    • Google Sheets Add On
Powered by GitBook
On this page
  1. Placekey API

Input Parameters

PreviousQuick StartNextMinimum Inputs

Last updated 8 months ago

A general Placekey API request body is a JSON object with the following possible parameters:

Field
Description
Type
Example

query.latitude

The latitude of the place in WGS-84 coordinates

double

37.371

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

This 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

"

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"

📘 In order to return a placekey some paramaters are required

https://www.walmart.com/store/3114-saugus-ma/
"