/mascus/listings/search

POST /api/mascus/listings/search

Price: 20 credits

Search Mascus used machinery and vehicle listings in a category, optionally narrowed to one brand or one country: price, year, meter reading, location, dealer and auction details.

How to use it

Compare used equipment for sale on Mascus across dealers and countries. Take the category path from a mascus.com category URL; pass a result mascus_id to mascus/listings for specifications and seller contacts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — Catalog and category path from a mascus.com listing page URL (examples: "construction/excavators", "construction/crawler-excavators"; minLength: 3)
• count integer required — Max number of listings to return (min: 1; max: 800)
• brand string nullable — Brand slug as it appears in mascus.com URLs (examples: "volvo")
• country string nullable — Two-letter country code of the listing location (examples: "us"; pattern: ^[A-Za-z]{2}$)

Response

• @type string (default: "MascusListing")
• id string required
• mascus_id string nullable
• url string nullable
• brand string nullable
• model string nullable
• manufacture_year integer nullable
• catalog string nullable
• category string nullable
• meter_readout number nullable
• meter_readout_unit string nullable
• location_country_code string nullable
• location_city string nullable
• price number nullable
• price_currency string nullable
• price_eur number nullable
• price_converted number nullable
• converted_currency string nullable
• rental_price_daily number nullable
• rental_price_weekly number nullable
• rental_price_monthly number nullable
• rental_currency string nullable
• rental_vat_rate number nullable
• auction_name string nullable
• auction_starts_at integer nullable
• auction_ends_at integer nullable
• auction_url string nullable
• auction_country string nullable
• auction_city string nullable
• marketplace_e_url string nullable
• rb_listing_id string nullable
• image string nullable
• image_count integer nullable
• video_count integer nullable
• is_featured boolean nullable
• is_highlighted boolean nullable
• is_new_last_24h boolean nullable
• is_rental boolean nullable
• is_auction boolean nullable
• is_marketplace_e boolean nullable
• created_at integer nullable
• dealer object nullable
  • @type string (default: "MascusListingDealer")
  • id string nullable
  • name string nullable
  • url string nullable
  • country string nullable
  • phone 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 Mascus category at this path 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.