Datasets

Facet vehicle listings dataset

Returns terms aggregation counts for the vehicle listings dataset. Facet enum: source, make, model, trim, body_style, transmission, drive_type, fuel_type, seller_type, state, run_id.

get/datasets/vehicle-listings/facets

Request

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

Query parameters

facet'source' | 'make' | 'model' | 'trim' | 'body_style' | 'transmission' | 'drive_type' | 'fuel_type' | 'seller_type' | 'state' | 'run_id' required

Facet enum: source, make, model, trim, body_style, transmission, drive_type, fuel_type, seller_type, state, run_id

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, max 128 characters

modelstring

Exact model filter, max 128 characters

trimstring

Exact trim filter, max 128 characters

body_stylestring

Exact body style filter, max 128 characters

transmissionstring

Exact transmission filter, max 128 characters

drive_typestring

Exact drivetrain filter, max 128 characters

fuel_typestring

Exact fuel type filter, max 128 characters

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

Exact seller type filter: retailer, dealer, private

statestring

Exact US state abbreviation filter, max 8 characters

vinstring

Exact VIN filter

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

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.