get
/api/v2/filters/vehicle-classes
Python SDK method:
client.filters.get_vehicle_classes()

Get vehicle classes

Returns the list of vehicle classes for the specified vehicle class scheme. Pass the filter IDs returned here in the vehicleClassIds field of analysis requests.

Altitude Help Center — getVehicleClasses

Input Parameters

NameLocationTypeValuesDescriptionValue Required
vehicleClassSchemeIdqueryVehicleClassSchemeID1, 2, 3, 4, 5Vehicle class scheme ID (1–5). Defaults to 2 (FHWA/GVWR) when omitted. See GET /api/v2/filters/vehicle-class-schemes.N

Success Responses

200 response: object

OK.

NameTypeDescription
categoryDescriptionstringVehicle class category description.
categoryIndexinteger (int64)Vehicle category index within the scheme.
idstringStable vehicle class identifier.
maxWeightKilogramsinteger (int64)Maximum weight in kilograms.
maxWeightPoundsinteger (int64)Maximum weight in pounds.
minWeightKilogramsinteger (int64)Minimum weight in kilograms.
minWeightPoundsinteger (int64)Minimum weight in pounds.
schemeIdinteger (int64)Vehicle class scheme identifier.
vehicleClassstringVehicle class label.
vehicleClassIndexinteger (int64)Vehicle class index within the scheme.
vehicleTypestringVehicle type label.
weightClassGroupingstringWeight class grouping label.
weightClassesarray<WeightClass>Included weight-class labels.

Response Errors

HTTP Status CodeReason
400The request body or parameters are invalid.
401Authentication is required or the provided credentials are invalid.
403The authenticated user lacks permission to perform this operation.
404The requested resource does not exist.
422The request is syntactically valid but semantically cannot be processed.
429The request rate limit has been exceeded.
500An unexpected server error occurred.