JustSERPDocs
Apple

Apple Maps search

A search on Apple Maps under the Apple Maps parameters (`q`; `center` or `location`; `zoom` or `span`; `country`, `lang`, `sort_by`, `filters`, `open_at`) and answered as the document: `search_metadata`, `search_parameters` (with `location_used` and `center_used` for a `location`), `search_information` (`query_displayed`, `total_results`), `local_results`, `guide_results`, `filters` and `error` when there are no results.

GET
/v1/apple/maps

A search on Apple Maps under the Apple Maps parameters (q; center or location; zoom or span; country, lang, sort_by, filters, open_at) and answered as the document: search_metadata, search_parameters (with location_used and center_used for a location), search_information (query_displayed, total_results), local_results, guide_results, filters and error when there are no results. location is looked up by searching Apple for it. filters are Apple's refinement keys from a previous answer's filters (at most 25). sort_by distance / ratings and open_at are applied to the places Apple returned (Apple's own sort could not be driven; open_at drops places with no hours). With no anchor the search is of the whole world. Not available: is_claimed (Apple never says), user_reviews.source_logo and .link, a guide's direct_link. For one business in the citation shape use /v1/apple/maps/place.

Authorization

headerX-API-Key<token>

Your API key.

Query Parameters

cancel_token?string

A name you make up for this request (a UUID is fine), so you can later GET /v1/cancel with it. Only you know it, so only you can cancel. Use a new one for every request, retries included: a cancelled token stays cancelled for a few minutes.

Length1 <= length <= 128
q*string
Length1 <= length <= 1000
center?string

"lat,lng".

location?string

A place name, looked up by searching Apple for it.

zoom?integer
Range1 <= value <= 20
span?string

"ns,ew" degrees; wins over zoom.

country?string

Two letters; the country the request is made from.

Default"us"
lang?string

Sent as Accept-Language.

Default"en"
sort_by?string

distance and ratings are applied to the places Apple returned.

Value in"best_match""distance""ratings"
filters?string

Comma-separated values of a previous answer's filters (at most 25): Apple's refinement keys (OPEN_NOW, PRICE_RANGE_MODERATE), chain:<token>. Unmatched values are ignored.

open_at?string

Drops places with no hours.

Response Body

The places, as the document. When the page could not be parsed, the usual envelope.

application/json
  1. response

The first keys of a document-form answer. Unlike DocumentHead there is no search_information unless the engine has one (there is none for the AI engines, Events, Events Details, Facebook, Tripadvisor Place, Trending Now and the Apple engines' places).

search_metadata*
search_parameters*

Also location_used and center_used for a location.

search_information?
local_results?array<>
guide_results?array<>
filters?array<>
error?string

Present when there are no results.

Example Request
curl -X GET 'https://api.justserp.com/v1/apple/maps?q=coffee&center=30.2672%2C-97.7431&zoom=14'
Example Response
{  "search_metadata": {    "id": "string",    "status": "Success",    "created_at": "string",    "request_url": "string",    "html_url": "string"  },  "search_parameters": {},  "search_information": {    "query_displayed": "string",    "total_results": 0  },  "local_results": [    {      "position": 0,      "place_id": "string",      "title": "string",      "link": "string",      "address": "string",      "phone": "string",      "website": "string",      "rating": 0,      "reviews": 0,      "gps_coordinates": {        "latitude": 0,        "longitude": 0      },      "open_state": "string",      "open_hours": {}    }  ],  "guide_results": [    {}  ],  "filters": [    {}  ],  "error": "string"}