/juejin/users/search

POST /api/juejin/users/search

Price: 5 credits

Search Juejin users by name or text: name, job title, company, bio, level, follower and article counts, likes and views received

How to use it

A full profile with badges comes from juejin/users with the row's `id`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search text (examples: "python", "前端"; minLength: 1)
• count integer required — Max number of users to return (min: 1; max: 250)

Response

• @type string (default: "JuejinUser")
• id string required
• name string nullable
• url string nullable
• image string nullable
• job_title string nullable
• company string nullable
• description string nullable
• blog_url string nullable
• university string nullable
• major string nullable
• tech_team string nullable
• level integer nullable
• power integer nullable
• score number nullable
• score_level integer nullable
• score_title string nullable
• vip_level integer nullable
• follower_count integer nullable
• following_count integer nullable
• article_count integer nullable
• pin_count integer nullable
• booklet_count integer nullable
• likes_received integer nullable
• views_received integer nullable
• liked_article_count integer nullable
• liked_pin_count integer nullable
• read_article_count integer nullable
• comment_count integer nullable
• pin_comment_count integer nullable
• followed_tag_count integer nullable
• followed_column_count integer nullable
• followed_topic_count integer nullable
• followed_collection_count integer nullable
• created_collection_count integer nullable
• purchased_booklet_count integer nullable
• badge_count integer nullable
• badges array (default: [])
  • @type string (default: "JuejinBadge")
  • id string required
  • name string nullable
  • image string nullable
  • requirement string nullable
  • is_worn boolean nullable
• is_favorable_author boolean nullable
• is_book_author boolean nullable
• is_vip boolean nullable
• is_deactivated boolean nullable
• github_name string nullable
• weibo_name string nullable
• weibo_id string nullable
• wechat_name string nullable
• registered_at integer nullable
• updated_at integer 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.