The Batch Lookup query allows you to submit the Placekeys of a location and get responses back in a Basic Place Response. Use this to show details for multiple places.
Placekey is a unique and persistent identifier for any physical place in the world. Learn more at Placekey.io.
Argument | Description | Example |
---|---|---|
placekeys | Required. Array of Strings | "zzy-222@65z-z4g-gkz", "zzy-223@65y-x4x-4d9" |
In this example, we're requesting details about multiple POIs.
query {
batchLookup(placekeys: ["zzy-222@65z-z4g-gkz", "zzy-223@65y-x4x-4d9"]) {
locationName
address {
streetAddress
city
region
postalCode
}
}
}
{
"data": {
"batchLookup": [
{
"locationName": "Stewart's Shops",
"address": {
"streetAddress": "977 New York 149",
"city": "Queensbury",
"region": "NY",
"postalCode": "12804"
}
},
{
"locationName": "Stewart's Shops",
"address": {
"streetAddress": "504 New York 9p",
"city": "Saratoga Springs",
"region": "NY",
"postalCode": "12866"
}
}
]
},
"extensions": {
"row_count": 0
}
}