Datasets API endpoint
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`.
/datasets/vehicle-listings/facetsReturns terms aggregation counts for the vehicle listings dataset, honoring the same filters as search.
Query parameters:
facet — required. One of source, make, model, trim, body_style, transmission, drive_type, fuel_type, seller_type, state, run_id.q, source (carmax, autotrader, carsdotcom), make, model, trim, body_style, transmission, drive_type, fuel_type, seller_type (retailer, dealer, private), state, vin, run_id, is_price_reduced, min_year, max_year, min_price, max_price, max_mileage — same filters as the search endpoint.Returns {dataset, facet, items[]}, where each item is {value, count}.
| Field | Filled in, of 3 checked | Values in the sample |
|---|---|---|
| value | 3 | |
| count | 3 | 97,970 to 176,750, median 170,804 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| facet | string | Yes | Facet enum: source, make, model, trim, body_style, transmission, drive_type, fuel_type, seller_type, state, run_id Allowed values: source, make, model, trim, body_style, transmission, drive_type, fuel_type, seller_type, state, run_id. | source | |
| q | string | No | Full-text query over make, model and trim, max 256 characters | ||
| source | string | No | Exact source marketplace filter: carmax, autotrader, carsdotcom Allowed values: carmax, autotrader, carsdotcom. | ||
| make | string | No | Exact make filter, max 128 characters | ||
| model | string | No | Exact model filter, max 128 characters | ||
| trim | string | No | Exact trim filter, max 128 characters | ||
| body_style | string | No | Exact body style filter, max 128 characters | ||
| transmission | string | No | Exact transmission filter, max 128 characters | ||
| drive_type | string | No | Exact drivetrain filter, max 128 characters | ||
| fuel_type | string | No | Exact fuel type filter, max 128 characters | ||
| seller_type | string | No | Exact seller type filter: retailer, dealer, private Allowed values: retailer, dealer, private. | ||
| state | string | No | Exact US state abbreviation filter, max 8 characters | ||
| vin | string | No | Exact VIN filter | ||
| run_id | string | No | Exact crawl run-id filter, max 128 characters | ||
| is_price_reduced | boolean | No | Filter for listings currently marked down from a previous price | ||
| min_year | integer | No | Minimum model year | ||
| max_year | integer | No | Maximum model year | ||
| min_price | number | No | Minimum price in US dollars | ||
| max_price | number | No | Maximum price in US dollars | ||
| max_mileage | integer | No | Maximum odometer mileage | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/vehicle-listings/facets?facet=source&q=coffee&source=carmax&seller_type=retailer&is_price_reduced=true" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "vehicle-listings",
"facet": "make",
"items": [
{
"value": "Toyota",
"count": 4213
},
{
"value": "Honda",
"count": 3897
},
{
"value": "Ford",
"count": 3512
}
]
}
}Request schema
No body schema
Response schema
#/definitions/datasets.vehicleListingsFacetResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | datasets.VehicleListingFacetResponse | No | ||||
| data.dataset | string | No | ||||
| data.facet | string | No | ||||
| data.items | array | No | ||||
| data.items[].count | integer | No | ||||
| data.items[].value | string | No | ||||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/datasets/vehicle-listings/facets?facet=source&q=coffee&source=carmax&seller_type=retailer&is_price_reduced=true" \
-H "x-api-key: $CRAWLORA_API_KEY"