/applemaps/guides

POST /api/applemaps/guides

Price: 40 credits

Get an Apple Maps guide by id: title, description, publisher and every place in it as a full place card with the guide's note for that place

How to use it

One curated Apple Maps guide with its places. Find guide ids with applemaps/guides/search or in the guides field of a place.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• guide string required — Apple Maps guide id or guide URL (examples: "5336241915705172200", "https://maps.apple.com/guides?curated=5336241915705172200"; minLength: 1)

Response

• @type string (default: "ApplemapsGuide")
• id string required
• long_title string nullable
• description string nullable
• url string required
• image string nullable
• language string nullable
• place_count integer nullable
• publisher object nullable
  • @type string (default: "ApplemapsGuidePublisher")
  • id string nullable
  • name string nullable
  • subtitle string nullable
  • website string nullable
  • guide_count integer nullable
• updated_at integer nullable
• entries array (default: [])
  • @type string (default: "ApplemapsGuideItem")
  • note string nullable
  • place object nullable
    • @type string (default: "ApplemapsPlace")
    • id string required
    • muid string required
    • name string required
    • url string required
    • place_type string nullable
    • display_type string nullable
    • category string nullable
    • category_id string nullable
    • alt_category_ids array (default: [])
    • brand_id string nullable
    • description string nullable
    • summary string nullable
    • summary_source string nullable
    • summary_url string nullable
    • phone string nullable
    • alt_phones array (default: [])
    • fax string nullable
    • website string nullable
    • capacity integer nullable
    • address string nullable
    • address_lines array (default: [])
    • street string nullable
    • street_number string nullable
    • street_name string nullable
    • units array (default: [])
    • neighborhood string nullable
    • city string nullable
    • county string nullable
    • state string nullable
    • state_code string nullable
    • postal_code string nullable
    • country string nullable
    • country_code string nullable
    • latitude number nullable
    • longitude number nullable
    • timezone string nullable
    • containment string nullable
    • parent_place object nullable
      • @type string (default: "ApplemapsParentPlace")
      • id string required
      • name string nullable
    • rating integer nullable
    • rating_count integer nullable
    • aspect_ratings array (default: [])
    • provider_ratings array (default: [])
    • price_level integer nullable
    • price_level_max integer nullable
    • currency_symbol string nullable
    • reviews array (default: [])
    • tips array (default: [])
    • image string nullable
    • cover string nullable
    • icon string nullable
    • photo_categories array (default: [])
    • hours_type string nullable
    • hours array (default: [])
    • service_hours array (default: [])
    • amenities array (default: [])
    • links array (default: [])
    • guides array (default: [])
    • guide_ids array (default: [])
    • related_places array (default: [])
    • accolades array (default: [])
    • facts array (default: [])
    • transit_provider string nullable
    • transit_lines array (default: [])
    • departures array (default: [])
    • departure_frequencies array (default: [])
    • app_store_urls array (default: [])
    • is_claimable boolean nullable
    • has_business_chat boolean (default: false)
    • promotion string nullable
    • promotion_id string nullable
    • promotion_image string nullable
    • promotion_source string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Guide not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.