/ximalaya/albums/browse

POST /api/ximalaya/albums/browse

Price: 20 credits

Browse Ximalaya albums inside one category, optionally narrowed by the category's own filter tags

How to use it

Use this to walk a whole genre rather than to answer a phrase - there is no keyword here, only the category and its tags. Filter tags are the Chinese labels the category itself publishes; a tag belonging to another category, or an id copied out of a page URL, empties the result rather than widening it, so resolve tags for the category first. Several tags narrow together with AND, and one unrecognised tag among them empties the whole request.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id integer required — Ximalaya category id (examples: 3, 2, 1005; min: 1)
• count integer required — Max number of results (min: 1; max: 2100)
• sort string — Result ordering (default: "recommended"; one of: "recommended", "recently_updated", "most_played")
• filters array — Filter tag names, given exactly as the category publishes them, combined with AND. Tags from other categories match nothing (default: []; examples: ["盗墓"], ["男频","盗墓"])

Response

• @type string (default: "XimalayaCategoryAlbum")
• id integer required
• url string required
• album_title string nullable
• tagline string nullable
• image string nullable
• badge string nullable
• anchor_id integer nullable
• anchor_name string nullable
• anchor_url string nullable
• anchor_grade integer nullable
• play_count integer nullable
• track_count integer nullable
• is_paid boolean nullable
• is_finished boolean 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 — The entity was not found, or a precondition failed 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.