/xianyu/items

POST /api/xianyu/items

Price: 10 credits

Get one Xianyu (Goofish) second-hand listing by its id or URL. Returns the title and description, the asking price with any original, promotion and per-variant prices, the shipping fee, the listing status, want, view and collect counts, the creation time, the category, photos and video, the seller-filled attributes and product specifications, and the seller's profile with ratings, response stats and other listings.

How to use it

Sold listings stay reachable: `is_sold` is true and `status` reads 卖掉了. Text fields are in Simplified Chinese as the seller wrote them, and prices are in CNY. `seller.id` is the id /xianyu/users and /xianyu/users/items take.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — Xianyu item id or item URL (examples: "767613559273", "https://www.goofish.com/item?id=767613559273&categoryId=50023914"; minLength: 1)

Response

• @type string (default: "XianyuItem")
• id string required
• url string nullable
• description string nullable
• price number nullable
• original_price number nullable
• min_price number nullable
• max_price number nullable
• promotion_price number nullable
• promotion_max_price number nullable
• promotion_price_sku_id string nullable
• promotion_name string nullable
• shipping_fee number nullable
• currency string nullable
• status string nullable
• status_code string nullable
• is_sold boolean nullable
• item_type string nullable
• quantity integer nullable
• want_count integer nullable
• view_count integer nullable
• collect_count integer nullable
• favorite_count integer nullable
• sold_count integer nullable
• created_at integer nullable
• category string nullable
• category_id string nullable
• channel_category_id string nullable
• root_channel_category_id string nullable
• taobao_category_id string nullable
• image string nullable
• images array (default: [])
• video object nullable
  • @type string (default: "XianyuVideo")
  • id string required
  • url string nullable
  • url_320p string nullable
  • url_480p string nullable
  • image string nullable
  • width integer nullable
  • height integer nullable
• attributes array (default: [])
  • @type string (default: "XianyuAttribute")
  • name string required
  • value string required
• specifications array (default: [])
  • @type string (default: "XianyuAttribute")
  • name string required
  • value string required
• skus array (default: [])
  • @type string (default: "XianyuSku")
  • id string required
  • inventory_id string nullable
  • price number nullable
  • quantity integer nullable
  • out_of_stock_date integer nullable
  • image string nullable
  • options array (default: [])
    • @type string (default: "XianyuAttribute")
    • name string required
    • value string required
• topics array (default: [])
• tags array (default: [])
• badges array (default: [])
• resale_label string nullable
• resale_discount_text string nullable
• community object nullable
  • @type string (default: "XianyuCommunity")
  • id string required
  • name string nullable
  • description string nullable
  • member_count integer nullable
• seller object nullable
  • @type string (default: "XianyuItemSeller")
  • id string required
  • url string nullable
  • name string nullable
  • bio string nullable
  • image string nullable
  • city string nullable
  • publish_city string nullable
  • registered_at integer nullable
  • sold_count integer nullable
  • listing_count integer nullable
  • good_rating_rate number nullable
  • good_review_count integer nullable
  • neutral_review_count integer nullable
  • bad_review_count integer nullable
  • reply_rate_24h number nullable
  • reply_time_text string nullable
  • average_reply_minutes integer nullable
  • last_seen_text string nullable
  • is_zhima_verified boolean nullable
  • credit_level string nullable
  • credit_level_code string nullable
  • is_pro boolean nullable
  • summary string nullable
  • verification_tags array (default: [])
  • tags array (default: [])
  • other_items array (default: [])
    • @type string (default: "XianyuItemPreview")
    • id string required
    • url string nullable
    • price number nullable
    • image string nullable
    • place_name string nullable
    • area_name string nullable
    • division_code string nullable
    • is_pickup_only boolean nullable
    • last_sold_at integer nullable
    • refreshed_at integer nullable
    • origin_price number nullable
    • origin_title string nullable
    • origin_shop_name string nullable
    • origin_purchase_date 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 — No listing with this id, or the listing was deleted 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.