CarMax API endpoint
Returns autocomplete suggestions for a partial search term (make/model/trim), typo-tolerant by default.
/carmax/search/suggestionsQuery parameters:
search (required) — free-text partial search term to get autocomplete
suggestions for (e.g. civ). Omitting or leaving this blank returns
400 before any upstream request is made.exact_match (optional) — disable fuzzy/typo-tolerant matching, i.e.
require an exact prefix match. Defaults to false (fuzzy matching on).Notable response behavior:
civik
still resolves to Honda Civic-family suggestions; with
exact_match=true, the same misspelled term returns an empty list.category on each suggestion is CarMax's own classification, e.g.
MakeModel or MakeModelTrim.| Field | Filled in, of 10 checked | Values in the sample |
|---|---|---|
| term | 10 | “Honda Civic” and 9 other values |
| category | 10 | MakeModelTrim (9), MakeModel (1) |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| search | string | Yes | Free-text partial search term to get autocomplete suggestions for | civ | |
| exact_match | boolean | No | false | Disable fuzzy/typo-tolerant matching -- require an exact prefix match. Defaults to false | false |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/carmax/search/suggestions?search=civ&exact_match=true" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"suggestions": [
{
"term": "Honda Civic",
"category": "MakeModel"
},
{
"term": "Honda Civic Sport",
"category": "MakeModelTrim"
},
{
"term": "Honda Civic LX",
"category": "MakeModelTrim"
},
{
"term": "Honda Civic Type R",
"category": "MakeModelTrim"
}
],
"source_url": "https://mobileapps-afd-prod-endpoint-drgsgffchcfkbmg4.z01.azurefd.net/api/search/suggestions?isFuzzy=true&search=civ"
}
}Request schema
No body schema
Response schema
#/definitions/carmax.searchSuggestionsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | carmax.SearchSuggestionsResponse | No | ||||
| data.source_url | string | No | ||||
| data.suggestions | array | No | ||||
| data.suggestions[].category | string | No | MakeModel | |||
| data.suggestions[].term | string | No | Honda Civic | |||
| 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/search/suggestions?search=civ&exact_match=true" \
-H "x-api-key: $CRAWLORA_API_KEY"