Find a business on Apple Maps
Searches Apple Maps for `business.name` near `location` and answers its listings in Apple's order.
Searches Apple Maps for business.name near location and answers its listings in
Apple's order. With no coordinates the search is made from the middle of the United
States and the words decide, so name the town in location.name.
X-API-Key<token>Your API key.
cancel_token?stringA 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.
1 <= length <= 128business*location?Where to look. Coordinates centre the search; both are needed together.
max_results?integerListings to answer with at most.
1 <= value <= 205details?booleanBing only. Open each candidate's card after the list, so it carries its address in parts, international phone, claim status and week of hours. false answers the list alone. No effect on Apple.
trueapi_version?"v1"Only v1 exists; anything else is a 400.
"v1"country?stringThe country the request is made from; location.country when not sent, else us.
^[A-Za-z]{2}$The listings found, in the directory's order (find_status is not_found and candidates [] when none).
application/json- response
The first three keys of every parsed 200 (the answer is the document itself, no success/data
envelope): what the search was (search_metadata), what it asked (search_parameters), the
parser's own search_information ({} when it has none). The engine's blocks follow, at the same
level. An engine whose answer is a list puts it under results.
search_metadata*search_parameters*The request's own fields as sent, engine first, without cancel_token.
search_information*The parser's own, e.g. yelp_search's; otherwise {}.
candidates*array<>items <= 20find_status*stringfound when at least one candidate has name_match: true, else not_found (the candidates are still returned, in the directory's order).
"found""not_found"curl -X GET 'https://api.justserp.com/v1/apple/maps/place/find?business%5Bname%5D=Franklin+Barbecue&location%5Bname%5D=Austin%2C+TX&location%5Blatitude%5D=30.2672&location%5Blongitude%5D=-97.7431&max_results=3'{ "search_metadata": { "id": "string", "status": "Success", "created_at": "string", "request_url": "string", "html_url": "string" }, "search_parameters": {}, "search_information": {}, "candidates": [ { "source": "apple_maps", "place_id": "string", "url": "string", "name": "string", "categories": [ "string" ], "address": { "street": "string", "city": "string", "region": "string", "postal_code": "string", "country": "string", "country_code": "string", "formatted": "string" }, "phone": "string", "phone_e164": "string", "website": "string", "coordinates": { "latitude": 0, "longitude": 0 }, "hours": { "weekly": [ { "day": "monday", "open": "string", "close": "string" } ], "text": [ "string" ], "status_text": "string" }, "status": "open", "rating": { "value": 0, "scale": 0, "count": 0, "source": "string" }, "claimed": true, "name_match": true, "claim_url": "string", "description": "string", "price": "string", "amenities": [ "string" ], "timezone": "string", "extra": {} } ], "find_status": "found"}Apple Maps listing GET
One business' listing on Apple Maps, by `place_id` (Apple's id, `IAA409CDF9D3555A9`) or `profile_url` (`maps.apple.com/place?place-id=...`), in the citation shape: the same fields as `/v1/bing/maps/place`, so listings on two directories can be compared.
Apple Maps search GET
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.