/auction_kr/products/search

POST /api/auction_kr/products/search

Price: 20 credits

Search Auction (auction.co.kr) products by keyword with sort, tab, category, brand and delivery filters: price, discount, seller, rating, purchase count, shipping and delivery badges

How to use it

Returns organic results by default; include_sponsored adds ad and featured cards, marked by is_ad and placement. Pass a returned id to auction_kr/products, auction_kr/products/reviews or auction_kr/products/questions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "반팔티", "노트북"; minLength: 1)
• sort string — Result order (default: "ranking"; one of: "ranking", "best_selling", "price_low", "price_high", "rating", "newest")
• tab string — Result tab (default: "all"; one of: "all", "department_store", "star_delivery")
• category string nullable — Auction category code (examples: "13290100"; pattern: ^\d{8}$)
• brand_id integer nullable — Auction brand id (examples: 31215; min: 1)
• free_shipping boolean — Only items with free shipping (default: false)
• today_dispatch boolean — Only items that ship today (default: false)
• rental_only boolean — Only rental items (default: false)
• gift_only boolean — Only items that come with a free gift (사은품) (default: false)
• bulk_discount_only boolean — Only items with a multi-purchase discount (복수구매할인) (default: false)
• include_sponsored boolean — Also return sponsored and featured cards (default: false)
• count integer required — Max number of results (min: 1; max: 900)

Response

• @type string (default: "AuctionKrSearchItem")
• id string required
• url string required
• name string nullable
• image string nullable
• currency string (default: "KRW")
• price number nullable
• original_price number nullable
• discount_rate integer nullable
• price_prefix string nullable
• price_suffix string nullable
• brand string nullable
• seller object nullable
  • @type string (default: "AuctionKrSearchSeller")
  • name string nullable
  • store_alias string nullable
  • store_url string nullable
  • id string nullable
• category object nullable
  • @type string (default: "AuctionKrSearchCategory")
  • large_code string nullable
  • medium_code string nullable
  • small_code string nullable
  • detail_code string nullable
• rating number nullable
• satisfaction_rate integer nullable
• review_count integer nullable
• purchase_count integer nullable
• reward_points number nullable
• is_free_shipping boolean (default: false)
• shipping_tags array (default: [])
• delivery_badges array (default: [])
• arrival_info array (default: [])
• benefit_tags array (default: [])
• event_tags array (default: [])
• event_badge string nullable
• seller_grade_tags array (default: [])
• seller_official_tags array (default: [])
• hot_signal string nullable
• customs_info string nullable
• bidder_count integer nullable
• auction_end_at integer nullable
• is_star_delivery boolean (default: false)
• is_used boolean (default: false)
• is_new boolean (default: false)
• is_official boolean (default: false)
• is_ad boolean (default: false)
• placement string (default: "organic")

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.