GET
Best We Hotel Search API
Find Best We and Jin Jiang properties in a Chinese destination.
Overview
Search dated Jin Jiang and Best We Hotel inventory by Best We city code, with property identifiers and lowest advertised nightly prices.
Scope
Search names come from the upstream Chinese search API. property_id is the stable identifier for Details and Rooms. Prices are anonymous web prices in CNY and may include publicly exposed club plans.
Authentication
Send your StayAPI key in the X-API-Key header. Successful requests return JSON; failures use RFC 7807 Problem Details.
Endpoint URL
GET https://api.stayapi.com/v1/bestwe/search
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| city_code | string | Required | Best We city identifier, 3 to 32 alphanumeric characters; AR04567 is Shanghai. |
| check_in | date | Required | Check-in date (YYYY-MM-DD). Cannot be in the past. |
| check_out | date | Required | Check-out date (YYYY-MM-DD), after check-in. |
| latitude | number | Optional | Optional search-center latitude (-90 to 90). Must be supplied with longitude. |
| longitude | number | Optional | Optional search-center longitude (-180 to 180). Must be supplied with latitude. |
| page | integer | Optional | Upstream page number, at least 1. Default: 1. |
| limit | integer | Optional | Results per page, 1 to 20. Default: 10. |
| sort | enum | Optional | recommended, distance, price_asc, or price_desc. Default: recommended. |
Response schema
| Field | Type | Description |
|---|---|---|
| hotels | array | Properties with property_id, hotel code, Chinese name, brand, address, coordinates, ratings, photo, room signal, labels, and lowest CNY price. |
| total | integer | Total upstream records for the city search. |
| page_info | object | Page, page size, total pages, and has_next_page. |
Errors and limitations
Errors use RFC 7807 Problem Details with provider: "bestwe", a product name, and a correlation id.
- 400: invalid dates, an incomplete coordinate pair, or child ages that do not match the child count.
- 404: the Best We property identifier is not recognized.
- 422: a parameter is outside its declared range or enum.
- 502: Best We rejected or failed the upstream request.
- 503: bounded scraper capacity is temporarily full; honor
Retry-After.