/yahoo/auctions/items

POST /api/yahoo/auctions/items

Price: 20 credits

Get full Yahoo! Auctions Japan (Yahoo!オークション) listing details by auction id or URL, for both live and completed auctions: current or winning price, start price, buy-it-now price, bid and bidder counts, watch count, start and end time, item condition, category path, brand, description, photo gallery, shipping terms and methods, accepted payment methods, question counts, highest bidders and the seller profile with rating.

How to use it

Fetch a single Yahoo! Auctions Japan listing by auction id (e.g. 'd1236130164') or a full auction URL. Works for live auctions (status 'open', price = current bid) and finished ones (status 'closed', price = the winning bid). Returns name, price, start_price, buy_now_price, bid_count, bidder_count, watch_count, quantity, start_at/end_at (unix seconds), condition and condition_name, category and category_path, brand, description and description_html, image/images, shipping_paid_by ('seller' or 'winner'), shipping_schedule, shipping_methods, accepts_credit_card/accepts_paypay/accepts_bank_transfer, answered_question_count, highest_bidders and seller. price, buy_now_price and start_price include consumption tax (tax_rate is the percentage applied).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• item string required — Yahoo! Auctions Japan auction id or a full auction URL (examples: "d1236130164", "https://page.auctions.yahoo.co.jp/jp/auction/d1236130164"; minLength: 1)

Response

• @type string (default: "YahooAuctionsItem")
• id string required
• url string required
• name string required
• status string nullable
• price integer nullable
• start_price integer nullable
• buy_now_price integer nullable
• tax_rate integer nullable
• bid_count integer nullable
• bidder_count integer nullable
• watch_count integer nullable
• quantity integer nullable
• start_at integer nullable
• end_at integer nullable
• condition string nullable
• condition_name string nullable
• category object nullable
  • @type string (default: "YahooAuctionsCategoryRef")
  • id string required
  • name string required
• category_path array (default: [])
  • @type string (default: "YahooAuctionsCategoryRef")
  • id string required
  • name string required
• brand object nullable
  • @type string (default: "YahooAuctionsCategoryRef")
  • id string required
  • name string required
• marketplace string nullable
• description string nullable
• description_html string nullable
• image string nullable
• images array (default: [])
• shipping_paid_by string nullable
• shipping_schedule string nullable
• shipping_methods array (default: [])
• is_worldwide_delivery boolean nullable
• is_anonymous_delivery boolean nullable
• is_automatic_extension boolean nullable
• is_early_closing boolean nullable
• is_offer_accepted boolean nullable
• is_returnable boolean nullable
• return_policy string nullable
• accepts_credit_card boolean nullable
• accepts_paypay boolean nullable
• accepts_bank_transfer boolean nullable
• answered_question_count integer nullable
• unanswered_question_count integer nullable
• highest_bidders array (default: [])
  • @type string (default: "YahooAuctionsBidder")
  • display_name string required
  • rating_count integer nullable
• seller object nullable
  • @type string (default: "YahooAuctionsSeller")
  • id string required
  • url string required
  • display_name string nullable
  • image string nullable
  • rating_count integer nullable
  • good_rating number nullable
  • is_store boolean nullable
  • is_best_store boolean nullable
  • is_excellent_seller boolean nullable
  • is_verified boolean nullable
  • is_speed_shipping boolean nullable
  • region string nullable
  • region_code integer nullable
  • profile_message string nullable
  • store_licenses array (default: [])
    • @type string (default: "YahooAuctionsStoreLicense")
    • name string required
    • code 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 — Auction not found (well-formed id but no such auction on Yahoo! Auctions Japan) 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.