/youku/users

POST /api/youku/users

Price: 1 credit

Get one Youku creator channel by its id or profile URL. Returns the display name, self-description, avatar and channel background, gender, follower, following and like counts, the verified-star flag and the account status.

How to use it

Both id forms work and both are returned: `id` is the encoded `U…==` form used in profile URLs, `numeric_id` is the plain integer. They are not convertible into one another — the encoded form is not a base64 of the number — so carry whichever you were given. This covers creator channels, including the official channels studios and broadcasters run; it is not a viewer-account lookup and it exposes no email, phone or real name. For what the creator has published use /youku/users/videos.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Creator id — the encoded id, the numeric id, or an i.youku.com profile URL (examples: "UMTcyMDUxMDI5Ng==", "430127574", "https://i.youku.com/u/UMTcyMDUxMDI5Ng=="; minLength: 1)

Response

• @type string (default: "YoukuUser")
• id string required
• numeric_id string nullable
• name string nullable
• description string nullable
• url string nullable
• image string nullable
• background string nullable
• gender string nullable
• follower_count integer nullable
• following_count integer nullable
• like_count integer nullable
• is_star boolean (default: false)
• status 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 creator channel 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.