/yahoo/auctions/items/search

POST /api/yahoo/auctions/items/search

Price: 20 credits

Search live Yahoo! Auctions Japan (Yahoo!オークション) listings by keyword and/or category, with filters for current-price range, buy-it-now price range, item condition, shipping-from prefecture, seller type, brand, listing type (bidding or fixed price), authenticity appraisal, free shipping, photo presence, newly listed items, auctions ending within the hour, convenience-store pickup and anonymous shipping, plus sorting by recency, remaining time, price, buy-it-now price, bid count, popularity or featured rank. Returns listing cards with current price, buy-it-now price, start price, bid count, end time, category path and seller id.

How to use it

Search currently running Yahoo! Auctions Japan listings. Provide keyword and/or category plus count. Filters: keyword_exclude, price_min/price_max, buy_now_price_min/buy_now_price_max (JPY), condition (new/like_new/no_visible_damage/slight_damage/damaged/poor/used), region (tokyo/osaka/...), seller_type (store/individual), brand_id, listing_type (auction/fixed_price), marketplace (yahoo_auctions/yahoo_flea), authenticated, free_shipping, has_image, new_arrival, ending_within_hour, konbini_pickup, anonymous_shipping, sort (newest/ending_soonest/ending_latest/price_asc/price_desc/buy_now_price_asc/buy_now_price_desc/bids_desc/bids_asc/popular/featured). Each result has id, url, name, image, price (current bid), buy_now_price, start_price, bid_count, end_at (unix seconds), category_path_ids, marketplace, is_free_shipping and seller_id/seller_url (call yahoo/auctions/sellers for the full seller profile). price and buy_now_price include consumption tax; start_price is the pre-tax opening bid. For prices items actually sold at, use yahoo/auctions/items/closed/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category integer nullable — Category id to search in, as returned by yahoo/auctions/categories (min: 0)
• price_min integer nullable — Minimum price (JPY) (min: 0)
• price_max integer nullable — Maximum price (JPY) (min: 0)
• condition string nullable — Item condition (one of: "new", "used", "like_new", "no_visible_damage", "slight_damage", "damaged", "poor")
• region string nullable — Prefecture the item is shipped from (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "yamanashi", "nagano", "niigata", "toyama", "ishikawa", "fukui", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa", "overseas")
• brand_id integer nullable — Brand id, as returned in item brand_id (min: 0)
• free_shipping boolean — Only items shipped free of charge (default: false)
• has_image boolean — Only items that have a photo (default: false)
• keyword string nullable — Search keyword; may be omitted when a category is given (examples: "ロレックス")
• keyword_exclude string nullable — Space-separated words that must not appear in the item name
• buy_now_price_min integer nullable — Minimum buy-it-now price (JPY) (min: 0)
• buy_now_price_max integer nullable — Maximum buy-it-now price (JPY) (min: 0)
• seller_type string nullable — Restrict to store or private sellers (one of: "store", "individual")
• listing_type string nullable — Restrict to bidding auctions or to fixed-price listings (one of: "auction", "fixed_price")
• marketplace string nullable — Keep only listings from this marketplace (yahoo_auctions or the mixed-in yahoo_flea) (one of: "yahoo_auctions", "yahoo_flea")
• authenticated boolean — Only items that come with an authenticity appraisal (default: false)
• new_arrival boolean — Only newly listed items (default: false)
• ending_within_hour boolean — Only auctions ending within the next hour (default: false)
• konbini_pickup boolean — Only items collectable at a convenience store (default: false)
• anonymous_shipping boolean — Only items shipped anonymously (default: false)
• sort string — Sort order (default: "newest"; one of: "newest", "ending_soonest", "ending_latest", "price_asc", "price_desc", "buy_now_price_asc", "buy_now_price_desc", "bids_desc", "bids_asc", "popular", "featured")
• count integer required — Max number of results to return (examples: 20; min: 1)

Response

• @type string (default: "YahooAuctionsSearchItem")
• id string required
• url string required
• name string required
• image string nullable
• price integer nullable
• buy_now_price integer nullable
• start_price integer nullable
• bid_count integer nullable
• end_at integer nullable
• category_id string nullable
• category_path_ids array (default: [])
• marketplace string nullable
• is_free_shipping boolean nullable
• accepts_easy_payment boolean nullable
• seller_id string nullable
• seller_url 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 — 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.