/ironplanet/auctions/items

POST /api/ironplanet/auctions/items

Price: 10 credits

List the lots in one IronPlanet group online auction: title, photo, meter reading, location, buying format and the price shown on the auction card.

How to use it

Browse what is being sold in a specific IronPlanet, TruckPlanet or GovPlanet auction. Take auction_id from ironplanet/auctions and pass an item id to ironplanet/items for the full inspection record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• auction_id string required — Auction id from ironplanet/auctions (examples: "117099"; pattern: ^\d{3,9}$)
• count integer required — Max number of items to return (min: 1; max: 500)
• sort_by string — Result ordering (default: "best_match"; one of: "best_match", "price_lowest", "price_highest", "ending_soonest", "ending_latest", "year_newest")

Response

• @type string (default: "IronplanetAuctionItem")
• id string required
• url string nullable
• image string nullable
• auction_id string nullable
• buying_format string nullable
• price_text string nullable
• price number nullable
• currency string nullable
• meter_text string nullable
• meter_value number nullable
• meter_unit string nullable
• location string nullable
• country string nullable
• date_text string nullable
• has_ironclad_assurance boolean 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 catalogue with this id, including calendar auctions with has_item_list false 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.