CarMax API endpoint
Returns CarMax's own similar-vehicle recommendations for a listing: stock number, description, display mileage/price, store location, and image, for vehicles CarMax considers comparable. An empty list is a normal result, not an error.
/carmax/vehicle/{stock_number}/recommendationsPath parameters:
stock_number (required) — the CarMax stock number to find similar
vehicles for, the numeric path segment of a /car/{stock_number} URL.Query parameters:
store_id (required) — a CarMax store id used as the recommendation's
location context. Any search, vehicle-detail, or store response's store
id field is a valid input here.Notable response behavior:
mileage_display/price_display as CarMax's own rounded strings, e.g.
"78K"/"$22,998", not exact numeric values) — fetch
/carmax/vehicle/{stock_number} for the full record on any recommended
stock number.recommendations list is a normal result (CarMax has no
similar vehicles to suggest for that listing/location), not an error.
A malformed request (e.g. a missing store_id) still returns 400.| Field | Filled in, of 10 checked | Values in the sample |
|---|---|---|
| stock_number | 10 | 27,928,757 to 70,298,849, median 70,205,143 |
| description | 10 | “2016 Honda Civic EX” and 9 other values |
| mileage_display | 10 | “107K” and 9 other values |
| price_display | 10 | $15,998 (5), $16,998 (4), $18,998 (1) |
| location | 10 | “San Gabriel Valley/Duarte” and 7 other values |
| vehicle_caption | 10 | “Only available at CarMax San Gabriel Valley/Duarte, CA” and 7 other values |
| hero_image_url | 10 | img2.carmax.com |
| url | 10 | carmax.com |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| stock_number (path) | string | Yes | CarMax stock number to find similar vehicles for, the numeric path segment of a /car/{stock_number} URL | 28187774 | |
| store_id | string | Yes | CarMax store id used as the recommendation's location context. See any search/vehicle/store response's store id field | 7124 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/carmax/vehicle/28187774/recommendations?store_id=7124" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"stock_number": 28187774,
"recommendations": [
{
"stock_number": 70078825,
"description": "2022 Honda Civic Sport",
"mileage_display": "78K",
"price_display": "$22,998",
"location": "San Gabriel Valley/Duarte",
"vehicle_caption": "Only available at CarMax San Gabriel Valley/Duarte, CA",
"hero_image_url": "https://img2.carmax.com/assets/70078825/hero.jpg?width=400&height=225",
"url": "https://www.carmax.com/car/70078825"
}
],
"source_url": "https://mobileapps-afd-prod-endpoint-drgsgffchcfkbmg4.z01.azurefd.net/api/vehicles/recommendations?locationId=7124&stockNumber=28187774"
}
}Request schema
No body schema
Response schema
#/definitions/carmax.vehicleRecommendationsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | carmax.VehicleRecommendationsResponse | No | ||||
| data.recommendations | array | No | ||||
| data.recommendations[].description | string | No | 2022 Honda Civic Sport | |||
| data.recommendations[].hero_image_url | string | No | ||||
| data.recommendations[].location | string | No | San Gabriel Valley/Duarte | |||
| data.recommendations[].mileage_display | string | No | 78K | |||
| data.recommendations[].price_display | string | No | $22,998 | |||
| data.recommendations[].stock_number | integer | No | 70078825 | |||
| data.recommendations[].url | string | No | https://www.carmax.com/car/70078825 | |||
| data.recommendations[].vehicle_caption | string | No | Only available at CarMax San Gabriel Valley/Duarte, CA | |||
| data.source_url | string | No | ||||
| data.stock_number | integer | No | 28187774 | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/carmax/vehicle/28187774/recommendations?store_id=7124" \
-H "x-api-key: $CRAWLORA_API_KEY"