Datasets

Search vehicle listings dataset

Searches the crawled used-vehicle listings index. source enum: carmax, autotrader, carsdotcom. CarMax's own national inventory is fully enumerable (re-crawled on a standing schedule); Autotrader/Cars.com coverage is a best-effort zip-code sweep, not exhaustive, and their rows approximate city/state from the searched area rather than the seller's exact location. seller_type enum: retailer, dealer, private (not populated for every row -- see the dataset markdown). Sort enum: relevance, recently_updated, newly_listed, price_asc, price_desc, mileage_asc, mileage_desc, year_desc, year_asc. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).

get/datasets/vehicle-listings/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/vehicle-listings/search
  • Auth: API key in header x-api-key

Query parameters

qstring

Full-text query over make, model and trim, max 256 characters

source'carmax' | 'autotrader' | 'carsdotcom'

Exact source marketplace filter: carmax, autotrader, carsdotcom

makestring

Exact make filter (e.g. Honda, Toyota), max 128 characters

modelstring

Exact model filter (e.g. Civic), max 128 characters

trimstring

Exact trim filter, max 128 characters

body_stylestring

Exact body style filter (e.g. Sedan, SUV), max 128 characters

transmissionstring

Exact transmission filter, max 128 characters

drive_typestring

Exact drivetrain filter, max 128 characters

fuel_typestring

Exact fuel type filter (e.g. Gas, Hybrid, Electric), max 128 characters

seller_type'retailer' | 'dealer' | 'private'

Exact seller type filter: retailer, dealer, private

statestring

Exact US state abbreviation filter (e.g. CA), max 8 characters

vinstring

Exact VIN filter. Best-effort: not guaranteed on every listing

run_idstring

Exact crawl run-id filter, max 128 characters

is_price_reducedboolean

Filter for listings currently marked down from a previous price

min_yearinteger

Minimum model year

max_yearinteger

Maximum model year

min_pricenumber

Minimum price in US dollars

max_pricenumber

Maximum price in US dollars

max_mileageinteger

Maximum odometer mileage

sort'relevance' | 'recently_updated' | 'newly_listed' | 'price_asc' | 'price_desc' | 'mileage_asc' | 'mileage_desc' | 'year_desc' | 'year_asc'

Sort enum: relevance, recently_updated, newly_listed, price_asc, price_desc, mileage_asc, mileage_desc, year_desc, year_asc

pageinteger

Page number, defaults to 1

page_sizeinteger

Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.