Maps search (/maps)

Reference for /maps: maps search parameters, response fields, code in 5 languages, GET and POST forms, and a sample response.

Updated View as Markdown

Google Maps places with coordinates, place id and CID. Results are in places. The product page is Google Maps API.

Try in PlaygroundOpens the dashboard playground with this request filled in (sign in first).

Request

POST https://api.bestserp.com/maps with a JSON body, or GET https://api.bestserp.com/maps with the same parameters in the query string. The key goes in the X-API-KEY header either way (authentication).

POST
curl -X POST 'https://api.bestserp.com/maps' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"q":"pho restaurant hanoi"}'
GET
curl -G 'https://api.bestserp.com/maps' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  --data-urlencode 'q=pho restaurant hanoi'

Parameters

Unknown parameters are refused (unknown_parameter), so a typo never goes unnoticed.

ParameterTypeDefaultDescription
qrequiredstringSearch query (1–256 characters).
glstringusCountry, 2-letter code (us, gb, vn, de…). The search runs from an IP in that country when one is free, else from another one (see ipCountry).
hlstringenInterface language (en, vi, de…).
pagesinteger1Result pages or scroll loads to fetch, 1–5. Each costs 1 credit.
noCachebooleanfalseSkip the 1-hour result cache (5 minutes for news).
asyncbooleanfalseAnswer 202 immediately with a requestId to poll.
timeoutnumber60Seconds to wait before answering 202 (1–120).
autocorrectbooleanAccepted for compatibility; no effect.

Response fields

Empty fields are left out of each item.

places[]

FieldMeaning
positionRank of the place, from 1.
titleBusiness or place name.
addressAddress as shown.
categoryType of place as shown, e.g. Coffee shop.
ratingAverage rating out of 5.
ratingCountNumber of reviews.
priceLevelPrice range as shown, e.g. $$.
hoursOpening status as shown, e.g. Open · Closes 10 PM.
snippetShort description or review excerpt, when shown.
latitudeLatitude in decimal degrees.
longitudeLongitude in decimal degrees.
placeIdGoogle place ID.
cidGoogle Maps customer ID (CID).
linkLink shown for the place in the listing, when there is one.
thumbnailUrlThumbnail as an inline data: URI, only with includeThumbnails: true (about 20 KB each).

Every response

FieldMeaning
searchParametersYour request after validation, with defaults filled in (q, gl, hl, type, page or pages...).
requestIdID of this request. Poll GET /requests/{requestId} for async requests and for final links.
creditsCredits charged for this request (refunded automatically if it fails).
cachedtrue when the answer came from the recent-result cache (1 hour, 5 minutes for news).
linksPendingtrue while Google redirect links are being replaced by final URLs; poll the request to get them.
unresolvedLinksLinks that are still Google redirects: they work, but are not the final URL.
durationMsTime the search took, in milliseconds.
ipCountryCountry of the IP the search ran from (same code as gl). Another country than gl when no IP there was free: the search runs anyway instead of waiting. Missing when unknown.

Sample response

200 OK
{
  "searchParameters": {
    "q": "pho restaurant hanoi",
    "gl": "us",
    "hl": "en",
    "type": "maps",
    "pages": 1,
    "engine": "google"
  },
  "places": [
    {
      "position": 1,
      "title": "Pho Lantern",
      "address": "12 Hang Bac, Hoan Kiem, Hanoi",
      "category": "Pho restaurant",
      "rating": 4.7,
      "ratingCount": 2140,
      "priceLevel": "$",
      "hours": "Open · Closes 10 PM",
      "latitude": 21.0341,
      "longitude": 105.8519,
      "placeId": "ChIJlanternCoffee01",
      "cid": "4893217750012345678",
      "link": "https://maps.google.com/?cid=4893217750012345678"
    },
    {
      "position": 2,
      "title": "Pho Bat Dan 49",
      "address": "64 Luong Van Can, Hoan Kiem, Hanoi",
      "category": "Pho restaurant",
      "rating": 4.5,
      "ratingCount": 3890,
      "priceLevel": "$",
      "hours": "Open · Closes 11 PM",
      "latitude": 21.0322,
      "longitude": 105.8511,
      "placeId": "ChIJnoteCafeHanoi02",
      "cid": "1185342209876543210",
      "link": "https://maps.google.com/?cid=1185342209876543210"
    },
    {
      "position": 3,
      "title": "Pho Thin Lo Duc",
      "address": "152 Trieu Viet Vuong, Hai Ba Trung, Hanoi",
      "category": "Pho restaurant",
      "rating": 4.4,
      "ratingCount": 980,
      "priceLevel": "$",
      "hours": "Closed · Opens 7 AM",
      "latitude": 21.0145,
      "longitude": 105.8497,
      "placeId": "ChIJcongCorner00003",
      "cid": "7734001122334455667",
      "link": "https://maps.google.com/?cid=7734001122334455667"
    }
  ],
  "requestId": "5b0c8a52-3f0e-4d55-9a2a-0f3a8e2d1c11",
  "credits": 1,
  "cached": false,
  "linksPending": false,
  "unresolvedLinks": 0,
  "durationMs": 3120
}

Limits

  • Returns the places of the Maps results list, not their detail pages: no phone numbers, review text or photo galleries.
  • The search area follows the query and gl. Map coordinates, zoom level and radius are not supported yet.
  • Up to 5 scroll loads (pages) per request; each costs 1 credit.
  • Targeting is by country (gl) and interface language (hl). City-level location is not supported yet: a request with location is refused with an explicit error.
  • Results are what a desktop browser sees. There is no mobile SERP option yet.
  • 60 searches per minute per account by default; ask on Telegram for more.

Errors and their credit rules are on the errors page.