/ironplanet/items/search

POST /api/ironplanet/items/search

Price: 20 credits

Search open IronPlanet equipment items by keyword, category, manufacturer, year, usage, region, buying format or auction.

How to use it

Find used equipment listed on IronPlanet's online auctions. Pass a result id to ironplanet/items for the inspection report.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of listings to return (min: 1; max: 1200)
• query string nullable — Free-text search over listing titles and descriptions (examples: "excavator")
• categories array — Category slugs from rbauction.com URLs or category_id values from results (default: []; examples: ["excavators"])
• asset_types array — Asset type slugs from rbauction.com URLs (default: []; examples: ["mini-excavator-6-6t"])
• manufacturers array — Manufacturer names as shown in results (default: []; examples: ["Cat","Volvo"])
• models array — Model names as shown in results (default: []; examples: ["320"])
• buying_formats array — How the item is sold (default: []; one of: "Timed Auction", "Live Auction", "Make Offer", "Sealed Bid", "Buy Now")
• regions array — Region where the item is located (default: []; one of: "USA", "CAN", "EUR", "AUO", "MEX", "MID", "CSA", "ASI", "AFR")
• listing_statuses array — Listing statuses to include; empty keeps the site's default set (default: []; one of: "Open", "New", "Preview", "BuyNowPending", "SALE_PENDING")
• auction_id string nullable — Auction id from the auctions endpoint; returns only that auction's lots (examples: "10B92FFB-878F-44A3-9210-A8EBB936BD91"; pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)
• year_min integer nullable — Earliest manufacture year (min: 1900; max: 2100)
• year_max integer nullable — Latest manufacture year (min: 1900; max: 2100)
• usage_hours_max integer nullable — Maximum meter hours (min: 0)
• usage_miles_max integer nullable — Maximum odometer miles (min: 0)
• unused_only boolean — Only items marked unused (default: false)
• in_yard_only boolean — Only items already at an auction yard (default: false)
• ironclad_assurance_only boolean — Only items with IronClad Assurance (default: false)
• sort_by string — Result ordering (default: "relevance"; one of: "relevance", "ending_soonest", "newly_listed", "year_newest", "year_oldest", "usage_hours_lowest", "usage_miles_lowest", "auction_date_earliest", "auction_date_latest", "manufacturer", "lot_number")

Response

• @type string (default: "RitchiebrosListing")
• id string required
• url string required
• listing_id string nullable
• asset_id string nullable
• manufacturer string nullable
• model string nullable
• manufacture_year integer nullable
• serial_number string nullable
• features string nullable
• catalog_notes string nullable
• image string nullable
• industry string nullable
• category string nullable
• category_id string nullable
• asset_type string nullable
• asset_type_id string nullable
• usage_hours number nullable
• usage_miles number nullable
• usage_kilometers number nullable
• listing_status string nullable
• buying_platform string nullable
• buying_format string nullable
• buying_format_label string nullable
• selling_method string nullable
• lot_number string nullable
• ring_number integer nullable
• quick_response_id string nullable
• start_price number nullable
• currency string nullable
• inspection_status string nullable
• is_unused boolean nullable
• is_inoperable boolean nullable
• is_parts boolean nullable
• is_in_yard boolean nullable
• has_photo boolean nullable
• has_ironclad_assurance boolean nullable
• is_extended_warranty_eligible boolean nullable
• is_available_for_online_bidding boolean nullable
• is_buy_now_available boolean nullable
• is_make_offer_available boolean nullable
• is_reserve_revealed boolean nullable
• preview_starts_at integer nullable
• preview_ends_at integer nullable
• bidding_opens_at integer nullable
• bidding_ends_at integer nullable
• first_indexed_at integer nullable
• indexed_at integer nullable
• site_id string nullable
• site_name string nullable
• location_city string nullable
• location_state string nullable
• location_country string nullable
• location_region string nullable
• location_region_name string nullable
• location_country_name string nullable
• location_state_name string nullable
• latitude number nullable
• longitude number nullable
• auction object nullable
  • @type string (default: "RitchiebrosListingAuction")
  • id string required
  • sale_number string nullable
  • name string nullable
  • classification string nullable
  • scheduling_status string nullable
  • starts_at integer nullable
  • ends_at integer nullable
  • time_zone string nullable
  • total_days integer nullable
  • day integer nullable
  • locality string nullable
  • region string nullable
  • country string nullable
  • is_online_bidding_enabled boolean nullable
  • is_marketplace_enabled 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 — 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.