Google Maps Search
Search Google Maps for places matching a query in a free-text location and get up to 20 normalised places with rating, address, phone, website and coordinates.
- Price per call
- 2 credits
- per successful call
- Price ceiling
- 75 credits
- if a call is retried elsewhere
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ maps. searchAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/maps.search with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/maps.search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"coffee shop","location":"New York, NY","limit":20}'const res = await fetch('https://api.primaryapi.com/v1/run/maps.search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'coffee shop',
location: 'New York, NY',
limit: 20,
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/maps.search",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"query": "coffee shop",
"location": "New York, NY",
"limit": 20,
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "maps.search",
"input": {
"query": "coffee shop",
"location": "New York, NY",
"limit": 20
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/maps.search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"coffee shop","location":"New York, NY","limit":20}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
querystringrequired- What you would type in the Google Maps search bar, for example "coffee shop".max 500 chars
locationstringrequired- Free-text location to search in, ideally city plus country, for example "Austin, USA" or "London, UK".max 200 chars
languagestringdefault"en"- Two-letter language code for the results, for example "en" (default) or "de".max 10 chars
limitintegerdefault20- Maximum number of results to return (1-20, default 20).1–20
categoryFilterWordsstring[]- Optional Google Maps category names to keep (lowercase, as shown on Google Maps, e.g. ["coffee shop", "cafe"]). A place matches when one of its categories equals a word or contains all of its words. Applied to the first page of up to 20 places, so fewer results may come back.max 20 items · items max 100 chars
placeMinimumStarsenum- Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+) or fourAndHalf (4.5+). Places without reviews are skipped.one of: two, twoAndHalf, three, threeAndHalf, four, fourAndHalf
websiteenum- Filter on whether a place lists a website: allPlaces (default), withWebsite or withoutWebsite.one of: allPlaces, withWebsite, withoutWebsite
Output
When output.found is true, output.data has these fields (a list under items, billed per item returned).
itemsobject[]items[].rankinteger | null- Position in the upstream result list (1-based).
items[].namestringitems[].placeIdstring | null- Google place id (ChIJ...).
items[].cidstring | null- Google customer id (CID), unsigned decimal string.
items[].dataIdstring | null- Google data id ("0x...:0x..."), accepted by some reviews endpoints.
items[].addressstring | nullitems[].streetstring | nullitems[].citystring | nullitems[].statestring | nullitems[].postalCodestring | nullitems[].countryCodestring | nullitems[].neighborhoodstring | nullitems[].latitudenumber | nullitems[].longitudenumber | nullitems[].ratingnumber | nullitems[].reviewCountinteger | nullitems[].categorystring | nullitems[].categoriesstring[]items[].phonestring | nullitems[].websitestring | nullitems[].domainstring | nullitems[].descriptionstring | nullitems[].hoursobject[] | nullitems[].hours[].daystringitems[].hours[].hoursstringitems[].priceLevelstring | nullitems[].permanentlyClosedboolean | nullitems[].imagestring | nullitems[].urlstring | nullnextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type MapsSearch = {
items: {
/** Position in the upstream result list (1-based). */
rank: number | null;
name: string;
/** Google place id (ChIJ...). */
placeId: string | null;
/** Google customer id (CID), unsigned decimal string. */
cid: string | null;
/** Google data id ("0x...:0x..."), accepted by some reviews endpoints. */
dataId: string | null;
address: string | null;
street: string | null;
city: string | null;
state: string | null;
postalCode: string | null;
countryCode: string | null;
neighborhood: string | null;
latitude: number | null;
longitude: number | null;
rating: number | null;
reviewCount: number | null;
category: string | null;
categories: string[];
phone: string | null;
website: string | null;
domain: string | null;
description: string | null;
hours: {
day: string;
hours: string;
}[] | null;
priceLevel: string | null;
permanentlyClosed: boolean | null;
image: string | null;
url: string | null;
}[];
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"items": [
{
"rank": 0,
"name": "string",
"placeId": "string",
"cid": "string",
"dataId": "string",
"address": "string",
"street": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"countryCode": "string",
"neighborhood": "string",
"latitude": 0,
"longitude": 0,
"rating": 0,
"reviewCount": 0,
"category": "string",
"categories": [
"string"
],
"phone": "string",
"website": "string",
"domain": "string",
"description": "string",
"hours": [
{
"day": "string",
"hours": "string"
}
],
"priceLevel": "string",
"permanentlyClosed": true,
"image": "string",
"url": "https://example.com"
}
],
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 2,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Google Maps terms forbid automated collection. Customers are responsible for lawful use.
More Google Maps endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/maps.search.