/xianyu/users

POST /api/xianyu/users

Price: 1 credit

Get one Xianyu (Goofish) user profile by its id or profile URL. Returns the display name, bio, avatar and IP-based region, follower and following counts, the number of listings and reviews, the seller shop level, score and praise rate, the credit level and the identity verification flags.

How to use it

The id is the numeric one in goofish.com/personal?userId= links and in `seller.id` of /xianyu/items. `item_count` counts both on-sale and sold listings; /xianyu/users/items lists them.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Xianyu user id or profile URL (examples: "2880885203", "https://www.goofish.com/personal?userId=2880885203"; minLength: 1)

Response

• @type string (default: "XianyuUser")
• id string required
• url string nullable
• name string nullable
• bio string nullable
• image string nullable
• ip_location string nullable
• follower_count integer nullable
• following_count integer nullable
• item_count integer nullable
• review_count integer nullable
• shop_level string nullable
• shop_score integer nullable
• shop_next_level_score integer nullable
• shop_review_count integer nullable
• praise_rate number nullable
• business_qualification_type string nullable
• business_qualification_urls array (default: [])
• credit_level string nullable
• is_real_name_verified boolean nullable
• is_real_person_verified boolean nullable
• is_zhima_verified boolean nullable
• is_pro boolean nullable
• user_type string nullable
• encrypted_id 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 user 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.