/xianyu/users/items

POST /api/xianyu/users/items

Price: 5 credits

List a Xianyu (Goofish) seller's listings by user id or profile URL, optionally only the ones on sale or only the ones sold, and optionally only one of the seller's own listing groups. Each row carries the item id and URL, the title, the asking price, the sold flag, whether the listing has variants, the category, the shipping note, the photos and the listing labels.

How to use it

With `status` all, on-sale listings come before sold ones. `group` takes a group name exactly as the seller wrote it on their profile page, or its id; a name the seller does not have returns an empty list. Take `id` to /xianyu/items for the description, counters and attributes of a listing.

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)
• count integer required — Max number of listings to return (examples: 40; min: 1; max: 1000)
• status string — Which of the seller's listings to return (default: "all"; one of: "all", "on_sale", "sold"; examples: "on_sale")
• group string nullable — Name or numeric id of one of the seller's own listing groups; `status` then filters its rows (examples: "玩具早教类", "79348539"; minLength: 1)

Response

• @type string (default: "XianyuUserItem")
• id string required
• url string nullable
• price number nullable
• currency string nullable
• status_code string nullable
• is_sold boolean nullable
• category_id string nullable
• shipping_text string nullable
• has_video boolean nullable
• has_variants boolean nullable
• image string nullable
• images array (default: [])
• tags array (default: [])
• user_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.