/netease/users/search

POST /api/netease/users/search

Price: 5 credits

Search NetEase Cloud Music listeners by display name

How to use it

Display names are not unique on NetEase, so a query commonly returns many unrelated listeners with the same name — `follower_count` and `playlist_count` are what separate an active account from an empty one. The listening level and track total only come from the user endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — A listener's display name, or part of one (examples: "binaryify", "音乐"; minLength: 1)
• count integer required — Max number of listeners to return (min: 1)

Response

• @type string (default: "NeteaseUser")
• id string required
• name string nullable
• url string nullable
• image string nullable
• banner string nullable
• signature string nullable
• description string nullable
• gender_code string nullable
• province_code string nullable
• city_code string nullable
• follower_count integer nullable
• following_count integer nullable
• playlist_count integer nullable
• playlist_subscriber_count integer nullable
• event_count integer nullable
• created_at integer nullable
• born_at integer nullable
• vip_type integer nullable
• user_type integer nullable
• auth_status integer nullable
• expert_tags array (default: [])
• artist_id string nullable
• artist_name string nullable
• artist_identity_codes array (default: [])
• identities array (default: [])
  • @type string (default: "NeteaseUserIdentity")
  • type_code string required
  • description string nullable
  • tags array (default: [])
• is_podcaster 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.