---
title: "Facet vehicle listings dataset"
method: GET
path: "/datasets/vehicle-listings/facets"
tags: ["Datasets"]
---

# Facet vehicle listings dataset

`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`

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`.

## Query parameters

- `facet` 'source' | 'make' | 'model' | 'trim' | 'body_style' | 'transmission' | 'drive_type' | 'fuel_type' | 'seller_type' | 'state' | 'run_id', required
- `q` string
- `source` 'carmax' | 'autotrader' | 'carsdotcom'
- `make` string
- `model` string
- `trim` string
- `body_style` string
- `transmission` string
- `drive_type` string
- `fuel_type` string
- `seller_type` 'retailer' | 'dealer' | 'private'
- `state` string
- `vin` string
- `run_id` string
- `is_price_reduced` boolean
- `min_year` integer
- `max_year` integer
- `min_price` number
- `max_price` number
- `max_mileage` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- DatasetsVehicleListingsFacetResponseDoc
  - `code` integer
  - `data` DatasetsVehicleListingFacetResponse
    - `dataset` string
    - `facet` string
    - `items` EsVehicleListingDatasetFacetItem[]
      - `count` integer
      - `value` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)