/ctrip/destinations

POST /api/ctrip/destinations

Price: 20 credits

Get a Ctrip destination guide by alias: name, parent region, cover image, the must-see attractions, must-eat restaurants and must-shop places with ratings, and featured travel journals.

How to use it

Use for a quick overview of a Chinese or overseas destination. The alias is the you.ctrip.com URL segment, such as shanghai2, and is also what ctrip/attractions/search and ctrip/journals/search take.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• alias string required — Ctrip destination alias as used in you.ctrip.com URLs (examples: "shanghai2"; maxLength: 60; pattern: ^[A-Za-z]+\d+$)

Response

• @type string (default: "CtripDestination")
• id string required
• alias string required
• name string nullable
• name_en string nullable
• city_id integer nullable
• is_in_china boolean nullable
• is_overseas boolean nullable
• parent_id string nullable
• parent_name string nullable
• image string nullable
• must_see array (default: [])
  • @type string (default: "CtripDestinationCollection")
  • category string nullable
  • places array (default: [])
    • @type string (default: "CtripDestinationPlace")
    • id string nullable
    • poi_id string nullable
    • name string required
    • place_type string nullable
    • rating number nullable
    • review_count integer nullable
    • feature string nullable
    • image string nullable
    • url string nullable
• journals array (default: [])
  • @type string (default: "CtripDestinationJournal")
  • id string required
  • snippet string nullable
  • author_name string nullable
  • image_count integer nullable
  • reply_count integer nullable
  • view_count integer nullable
  • image string nullable
  • url string nullable
• url 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 — No Ctrip destination exists for this alias 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.