Copy page

Documentation

Errors

The API uses standard HTTP status codes. Errors always return a JSON body.

Code
{
  "error": "bad_request",
  "message": "A short explanation of what went wrong"
}

Field	Description
error	Error code, stable and safe to check in code
message	Human-readable explanation. The text may change

Status codes

Status	error	When
200		Success
400	bad_request	A parameter is invalid, such as a non-numeric ID, an unknown sort field or limit over 100
404	not_found	The make, model or trim does not exist, or the URL is not an API route
500	internal_error	Unexpected server error

Examples

Unknown sort field:

Code
curl "http://localhost:3000/api/trims?sort=bogus"

Code
{
  "error": "bad_request",
  "message": "'sort' must be one of: price, year, make, model, horsepower, torque, mpg, range, weight, towing, seats (prefix '-' for descending)"
}

ID that is not a number:

Code
curl http://localhost:3000/api/trims/abc

Code
{
  "error": "bad_request",
  "message": "'id' must be an integer >= 1"
}

Trim that does not exist:

Code
curl http://localhost:3000/api/trims/1

Code
{
  "error": "not_found",
  "message": "Trim 1 not found"
}

Unknown route:

Code
curl http://localhost:3000/api/nope

Code
{
  "error": "not_found",
  "message": "No route for GET /api/nope"
}

A search that matches nothing is not an error. It returns 200 with an empty data array.