/auction_kr/sellers

POST /api/auction_kr/sellers

Price: 5 credits

Get an Auction (auction.co.kr) store by alias or URL: name, description, favorites, business details, store categories and the store's best items

How to use it

The alias is the path segment of a stores.auction.co.kr link, also returned as seller.store_alias by auction_kr/products and auction_kr/products/search. auction_kr/sellers/items lists the whole store.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• seller string required — Auction store alias or store URL (examples: "pwx", "https://stores.auction.co.kr/pwx"; minLength: 1)

Response

• @type string (default: "AuctionKrSeller")
• id string nullable
• store_alias string required
• url string required
• name string nullable
• description string nullable
• banner_image string nullable
• favorite_count integer nullable
• satisfaction_percent number nullable
• grade_badges array (default: [])
• company_name string nullable
• representative string nullable
• phone string nullable
• email string nullable
• business_number string nullable
• address string nullable
• categories array (default: [])
  • @type string (default: "AuctionKrStoreCategory")
  • code string required
  • name string nullable
• best_items array (default: [])
  • @type string (default: "AuctionKrStoreItem")
  • id string required
  • url string required
  • name string nullable
  • image string nullable
  • currency string (default: "KRW")
  • price number nullable
  • original_price number nullable
  • shipping string nullable
  • event_badge string nullable
  • discount_rate integer nullable
  • star_delivery_arrival 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 Auction store under that alias 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.