Aggregate available inventory across the network in ONE call: counts, effective-price min/median/max and the top values per facet. Example: {"dimensions": ["make_model", "body_style"], "condition": "used", "rooftop_slugs": ["mms"]}. Geo (latitude and longitude, optional radius_miles) and oem_program_slug scope exactly as network_search. Pivot mode (group_by, up to 2 of the facets plus state, dealer_group, price_band, age_band) returns one row per group with count and medians; dimensions and group_by are mutually exclusive; format csv returns the rows as CSV. Pass country=CA for Canadian dealers.
View input schema
{
"type": "object",
"properties": {
"country": {
"type": "string",
"enum": [
"US",
"CA"
],
"default": "US",
"description": "Market to search; rooftops in the other country are excluded. Prices are in that country's currency; the radius stays in miles."
},
"condition": {
"enum": [
"new",
"used"
]
},
"make": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"model": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"body_style": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"fuel_type": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"drivetrain": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"exterior_color": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"interior_color": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"transmission": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "array",
"minItems": 1,
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
]
},
"trim": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"model_year_min": {
"type": "integer",
"minimum": 1950,
"maximum": 2100
},
"model_year_max": {
"type": "integer",
"minimum": 1950,
"maximum": 2100
},
"price_min": {
"type": "number",
"minimum": 0,
"maximum": 99999999.99,
"description": "Minimum expiry-gated effective price."
},
"price_max": {
"type": "number",
"minimum": 0,
"maximum": 99999999.99,
"description": "Maximum expiry-gated effective price."
},
"odometer_max": {
"type": "integer",
"minimum": 0
},
"passenger_capacity_min": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"is_certified": {
"type": "boolean"
},
"listed_only": {
"type": "boolean",
"description": "When true, only units with at least one stored photo and a vehicle detail page (vdp_url). Absent or false returns every available unit, including stock the dealer has not merchandised yet."
},
"oem_program_slug": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"radius_miles": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 500
},
"dimensions": {
"type": "array",
"minItems": 1,
"maxItems": 4,
"uniqueItems": true,
"description": "One to four unique facets. make_model values join nonblank make and model with one space; rooftop values are rooftop slugs.",
"items": {
"enum": [
"make",
"model",
"make_model",
"condition",
"body_style",
"fuel_type",
"drivetrain",
"exterior_color",
"model_year",
"rooftop"
]
}
},
"group_by": {
"type": "array",
"minItems": 1,
"maxItems": 2,
"uniqueItems": true,
"items": {
"enum": [
"make",
"model",
"make_model",
"condition",
"body_style",
"fuel_type",
"drivetrain",
"exterior_color",
"model_year",
"rooftop",
"state",
"dealer_group",
"price_band",
"age_band"
]
}
},
"format": {
"enum": [
"json",
"csv"
]
},
"rooftop_slugs": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"uniqueItems": true,
"description": "Restrict the single-snapshot aggregation to these network rooftops.",
"items": {
"type": "string",
"pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$"
}
}
},
"additionalProperties": false,
"description": "Categorical arrays are ORed within their field; separate filter fields are ANDed together. Aggregation has no pagination or sorting input. Server-enforced: latitude requires longitude; longitude requires latitude; radius_miles requires latitude and longitude. Exactly one of dimensions | group_by is required. Additional argument rules are enforced server-side."
}