Copy page

Documentation

Models

A model is a car line within a make, such as the Toyota RAV4.

Get a model

Code
GET /api/models/{modelId}

Returns the model with a summary for each model year.

Path parameters

Name	Type	Description
modelId	integer	Model ID

Example

Code
curl http://localhost:3000/api/models/2

Code
{
  "id": 2,
  "name": "Integra",
  "make_id": 1,
  "make": "Acura",
  "trim_count": 9,
  "min_msrp": 31300,
  "max_msrp": 51800,
  "years": [
    {
      "year": 2023,
      "trim_count": 4,
      "min_msrp": 31300,
      "max_msrp": 36300
    },
    {
      "year": 2024,
      "trim_count": 5,
      "min_msrp": 31800,
      "max_msrp": 51800
    }
  ]
}

Fields

Field	Type	Description
id	integer	Model ID
name	string	Model name
make_id	integer	Make ID
make	string	Make name
trim_count	integer	Number of trims, all years
min_msrp / max_msrp	integer	Base price range, all years
years	object[]	One entry per model year, each with year, trim_count, min_msrp and max_msrp

Returns 404 if the model does not exist.

List trims of a model

Code
GET /api/models/{modelId}/trims

Returns the model's trims, newest year first, then cheapest first. The list is not paged.

Parameters

Name	In	Type	Description
modelId	path	integer	Model ID
year	query	integer	Optional. Only trims of this model year

Example

Code
curl "http://localhost:3000/api/models/2/trims?year=2024"

Code
{
  "data": [
    {
      "id": 401983654,
      "make": "Acura",
      "model": "Integra",
      "year": 2024,
      "trim": "(base)",
      "trim_description": "4dr Hatchback (1.5L 4cyl Turbo CVT)",
      "body_type": "Hatchback",
      "base_msrp": 31800,
      "horsepower_hp": 200,
      "engine_type": "gas",
      "fuel_type": "premium unleaded (recommended)",
      "drive_type": "front wheel drive",
      "transmission": "continuously variable-speed automatic",
      "total_seating": 5,
      "epa_combined_mpg": 33,
      "epa_combined_mpge": null,
      "epa_electricity_range_mi": null,
      "image_urls": [
        "https://media.ed.edmunds-media.com/acura/integra/2024/oem/2024_acura_integra_4dr-hatchb..."
      ]
    }
  ],
  "count": 5
}

Long text and arrays are shortened in these examples.

Each item is a trim summary.

Returns 404 if the model does not exist.