/openrice/landmarks

POST /api/openrice/landmarks

Price: 20 credits

Get an OpenRice landmark (shopping mall, station, hotel or complex) by landmark id or landmark page URL: name, address, district, geo coordinates and, for landmarks with a managed mall page, description, official website and Facebook page, parking information, bookmark counter and logo, cover and banner images.

How to use it

Fetch one OpenRice landmark (mall/station/hotel) by numeric id or page URL, e.g. 7 for Times Square in Hong Kong. Set region and lang to the landmark's market. Returns name, address, latitude/longitude, district_id and — for managed mall pages — parking_info, website, bookmark_count and images. Pair with openrice/landmarks/restaurants to list every restaurant inside.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string — OpenRice regional market the request is scoped to (default: "hongkong"; one of: "hongkong", "macau", "shenzhen", "guangzhou", "zhuhai", "dongguan", "foshan", "zhongshan", "taipei", "newtaipei-keelung", "taoyuan", "hsinchu-miaoli", "taichung", "changhua-nantou", "yunlin-chiayi", "tainan", "kaohsiung-pingtung", "eastern", "tokyo-kanto", "osaka-kobe", "kyoto-kinki", "nagoya-chubu", "hokkaido", "tohoku", "hiroshima-chugoku", "shikoku", "fukuoka-kyushu", "okinawa", "bangkok", "chonburi", "phuket", "prachuapkhirikhan", "chiangmai", "suratthani", "nakhonratchasima", "chiangrai", "others", "singapore", "manila")
• lang string — Content language for names, addresses and category labels (default: "en"; one of: "en", "tc", "sc", "tc-tw", "ja", "th", "id")
• landmark string required — Landmark id or landmark page URL (examples: "7", "https://www.openrice.com/en/hongkong/l-times-square-l7"; minLength: 1)

Response

• @type string (default: "OpenriceLandmark")
• id integer required
• url string required
• name string required
• address string nullable
• district_id integer nullable
• landmark_type_id integer nullable
• latitude number nullable
• longitude number nullable
• description string nullable
• landmark_title string nullable
• website string nullable
• facebook string nullable
• parking_info string nullable
• parking_url string nullable
• bookmark_count integer nullable
• restaurant_count integer nullable
• image string nullable
• cover string nullable
• banners array (default: [])
• is_mall boolean (default: false)

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 — Landmark not found in this region 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.