/ximalaya/albums

POST /api/ximalaya/albums

Price: 1 credit

Get a Ximalaya album (audiobook, podcast or radio drama show) by id or album link

How to use it

Album, sound and anchor ids share one numeric range on Ximalaya and the source cannot tell them apart, so a sound or anchor id passed here resolves to an unrelated album under a normal 200 - pass the /album/{id} link whenever you have it and a wrong-type value is rejected instead of silently answered. The episode list is not part of this response, so fetch it separately when you need it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• album string required — Album id, or an album link of the form /album/{id} (examples: "81519744", "https://www.ximalaya.com/album/40121646"; minLength: 1)

Response

• @type string (default: "XimalayaAlbum")
• id integer required
• url string required
• album_title string nullable
• tagline string nullable
• description string nullable
• image string nullable
• badge string nullable
• anchor_id integer nullable
• anchor_name string nullable
• anchor_url string nullable
• category_id integer nullable
• category_title string nullable
• tags array (default: [])
• created_date string nullable
• updated_date string nullable
• play_count integer nullable
• subscribe_count integer nullable
• track_count integer nullable
• last_track_id integer nullable
• last_track_title string nullable
• score number nullable
• review_count integer nullable
• is_paid boolean nullable
• is_finished boolean nullable
• is_public boolean nullable
• price object nullable
  • @type string (default: "XimalayaAlbumPrice")
  • track_price number nullable
  • track_discounted_price number nullable
  • album_price number nullable
  • album_remaining_price number 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 album exists with this id. 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.