Vehicles

Finds vehicles based on input search parameters defined by requestDto.

get/{dataset}/v4/vehicles

Dataset description:

Vehicles dataset lists individual vehicles from the national registration authority and includes their technical parameters, model, roadworthiness inspections. Vehicles are linked to operator and owner company. BizMachine computes several metrics and estimates about the individual vehicle's lifetime.

WARNING: Vehicles registered before 2014 may be missing or have a limited coverage of operator and owner data.

Availability:

cz

Dataset updates:

Vehicle data is updated on a monthly basis. Basic registration data is available at on the 6th day of month. Related datasets such as operator changes, inspections and metrics follow in the 15-18th day.

Endpoint variables description:

Item commercial name Path Item description Example Always populated
Vehicle unique ID data/ data/ uniqueId BizMachine ID unique across countries cz-vehicle-17336428 Yes
Vehicle VIN data/data/vin 17-digit alphanumeric VIN code unique for each vehicle 4Y1SL65848Z411439 No
Vehicle long name data/data/name Long name as described in vehicle registry ŠKODA ENYAQ 80 D0ON1AA ACEBJAL1FX2 NY No
Vehicle technical certificate number data/data/certificateNumber "Technicky prukaz" in Czech UL969804 No
Vehicle category (code) data/data/category/code Enumeration code for /api/v3/vehicles/enums/categories M1 Inherited
Vehicle category (label) data/data/category/name Passenger vehicles with no more than eight seats and mass not exceeding 3.5 tons No
Vehicle make (code) data/data/make/code Enumeration code for /api/v3/vehicles/enums/makes V0031 No
Vehicle make (text) data/data/make/text Vehicle make as gathered on the source ŠKODA No
Vehicle make (label) data/data/make/name Vehicle make processed ŠKODA No
Vehicle make logo URL data/data/make/icon/url https://cdn.bizmachine.com/images/icons/car_brands/Skoda.png Inherited
Vehicle model (code) data/data/model/code Enumeration code for /api/v3/vehicles/enums/models V1241 No
Vehicle model (text) data/data/model/text Vehicle model as gathered on the source ENYAQ 80 No
Vehicle model (label) data/data/model/name Vehicle model processed ENYAQ 80 No
Vehicle type (code) data/data/type/code Enumeration code for /api/v3/vehicles/enums/types truck-van No
Vehicle type (text) data/data/type/text Vehicle model as gathered on the source Nákladní automobil skříňový No
Vehicle type (label) data/data/type/name Vehicle model processed truck-van No
Vehicle status when registered data/data/status New/ used New Yes
Vehicle weight unit data/data/weight/total/unit kg No
Vehicle weight data/data/weight/total/value 2090 No
Vehicle height unit data/data/height/total/unit cm No
Vehicle height data/data/height/total/value 1511 No
Vehicle length unit data/data/length/total/unit cm No
Vehicle length data/data/length/total/value 4862 No
Vehicle width unit data/data/width/total/unit cm No
Vehicle width data/data/width/total/value 1864 No
Vehicle transmission type data/data/transmissionType Automatic No
Vehicle axle count data/data/axleCount 2 No
Vehicle max passenger capacity data/data/maxPassengers 5 No
Vehicle chassis type code data/data/chassisType/code Enumeration code for /api/v4/vehicles/enums/chassis-types other Inherited
Vehicle chassis type label data/data/chassisType/name Bodywork that is not included in this list No
Vehicle max speed unit data/data/maxSpeed/unit km/h No
Vehicle max speed value data/data/maxSpeed/value 236 No
Vehicle engine power unit data/data/engine/power/unit kW No
Vehicle engine power value data/data/engine/power/value 147 No
Vehicle fuel type code data/data/fuel/type/code Enumeration code for /api/v4/vehicles/enums/fuel-types dies No
Vehicle fuel type label data/data/fuel/type/value Diesel No
Vehicle fuel consumption category code data/data/consumption/category/code Enumeration code for /api/v4/vehicles/enums/fuel-consumption-categories 1 No
Vehicle fuel consumption category label data/data/consumption/category/name Less than 5 l/100km No
Vehicle fuel consumption unit data/data/consumption/unit l/100km No
Vehicle emissions unit data/data/emissions/unit g/km No
Vehicle emissions value data/data/emissions/value 146 No
Vehice color as on source data/data/body/text Color as recorded on source BÍLÁ No
Vehicle first globally registered operator type data/data/registrations/international/type Currently not used unknown Inherited
Vehicle first global registration validity start date data/data/registrations/international/validFrom Can be the same as first domestic registration if the first registration was domestic 2019-07-17 Inherited
Vehicle first global registration validity end date data/data/registrations/international/validTo Currently not used null No
Vehicle first domestic registrant unique entity ID data/data/registrations/domestic/uniqueId Registering operator BizMachine entity ID unique across countries cz-company-01759299 Inherited
Vehicle first domestic registrant national entity ID data/data/registrations/domestic/nationalIn Registering operator national ID 01759299 No
Vehicle first domestic registrant type data/data/registrations/domestic/type Registering operator company/ person Company Inherited
Vehicle first domestic registration validity start date data/data/registrations/domestic/validFrom 2022-03-31 Inherited
Vehicle first domestic registration validity end date data/data/registrations/domestic/validTo Currently not used null No
Vehicle exact mileage unit data/data/metrics/mileage/timeline/value/unit km No
Vehicle exact mileage value data/data/metrics/mileage/timeline/value/value 62848 No
Vehicle guaranteed mileage category code data/data/metrics/mileage/timeline/category/code Enumeration code for /api/v4/vehicles/enums/fuel-consumption-categories mil21_100 Inherited
Vehicle guaranteed mileage category label data/data/metrics/mileage/timeline/category/name 21-100 ths. Km No
Vehicle guaranteed mileage metric type data/data/metrics/mileage/timeline/type What type of value should I expect for this metric (e.g., value with units) ValueUnit Inherited
Vehicle guaranteed mileage period start date data/data/metrics/mileage/timeline/validFrom 2021-03-08T00:00:00+00:00 Inherited
Vehicle guaranteed mileage period end date data/data/metrics/mileage/timeline/validTo 2021-03-08T00:00:00+00:00 No
Vehicle estimated mileage category code data/data/metrics/estMileage/timeline/category/code Enumeration code for /api/v4/vehicles/enums/fuel-consumption-categories mil21_100 Inherited
Vehicle estimated mileage category label data/data/metrics/estMileage/timeline/category/name 21-100 ths. Km No
Vehicle estimated mileage metric type data/data/metrics/estMileage/timeline/type What type of value should I expect for this metric (e.g., value with units) ValueUnit Inherited
Vehicle estimated mileage period start date data/data/metrics/estMileage/timeline/validFrom 2021-03-08T00:00:00+00:00 Inherited
Vehicle estimated mileage period end date data/data/metrics/estMileage/timeline/validTo 2021-03-08T00:00:00+00:00 No
Vehicle inspection type code data/data/inspections/code Enumeration code for /api/v4/vehicles/enums/inspections reg Inherited
Vehicle inspection type label data/data/inspections/name Emissions, roadworthiness, registration or other types of inspections Registration Inspection No
Vehicle inspection validity start date data/data/inspections/validFrom 2021-03-08T00:00:00 Inherited
Vehicle inspection validity end date data/data/inspections/validTo 2021-12-17T00:00:00 No
Vehicle inspection result code data/data/inspections/result/code Enumeration code for /api/v4/vehicles/enums/inspection-results rw Inherited
Vehicle inspection result label data/data/inspections/result/name Roadworthy No
Vehicle inspection protocol ID data/data/inspections/protocolId CZ-3843-21-09-1497 No
Vehicle inspection identified issues data/data/inspections/issues Currently not used NULL No
Vehicle registered owner type data/data/owners/type Company/ person Company Inherited
Vehicle registered owner entity unique ID data/data/owners/uniqueId BizMachine entity ID unique across countries cz-company-15886492 Inherited
Vehicle registered owner entity national ID data/data/owners/nationalIn 15886492 Inherited
Vehicle registered owner entity name data/data/owners/name UniCredit Leasing CZ, a.s. No
Vehicle registered owner registration start date data/data/owners/validFrom 2018-03-31 Inherited
Vehicle registered owner registration end date data/data/owners/validTo 2022-03-31 No
Vehicle and registered owner attributes code data/data/owners/attributes/code Enumeration code for /api/v3/vehicles/enums/attributes NEW Inherited
Vehicle and registered owner attributes label data/data/owners/attributes/name Attributes of the relationship between the owner and the vehicle (e.g., acquired new) NEW No
Vehicle registered operator type data/data/operators/type Company Inherited
Vehicle registered operator entity unique ID data/data/operators/uniqueId BizMachine entity ID unique across countries cz-company-06618286 Inherited
Vehicle registered operator entity national ID data/data/operators/nationalIn 06618286 Inherited
Vehicle registered operator entity name data/data/operators/name Účetnictví B i S s.r.o. No
Vehicle registered operator registration start date data/data/operators/validFrom 2020-03-31 Inherited
Vehicle registered operator registration end date data/data/operators/validTo 2022-05-15 No
Vehicle and registered operator attributes code data/data/operators/attributes/code Enumeration code for /api/v3/vehicles/enums/attributes LEASED Inherited
Vehicle and registered operator attributes label data/data/operators/attributes/name Attributes of the relationship between the operator and the vehicle (e.g., leased) Leased No
Vehicle attribute (code) data/data/attributes/code Enumeration code for /api/v3/vehicles/enums/attributes LEASED Inherited
Vehicle attribute (label) data/data/attributes/name Describe various "qualities" of the vehicle, or of the relationship vehicle - company Leased No
SecurityApiKey
Request
path Parameters
dataset
required
string
query Parameters
Tag.Uid
string or null <uuid>

Unique identifier.

Company.UniqueId
string or null

Company unique identifier to search for.

Company.SearchScope
string (BizMachine.Prospector.Api.DataStructures.Dtos.Vehicles.v4.Params.OwnershipOperationSearchScopeDto)
Enum: "EverOwnedOrOperated" "CurrentlyOwnsAndOperates" "CurrentlyOwnsOrOperates" "CurrentlyOwns" "CurrentlyOperates" "EverOperated"
Vin
string or null

VIN number of the vehicle to search for.

FirstDomesticRegistration.From
string or null <date-time>

Bottom filtering bound to filter by. This lower bound is included in the results.

FirstDomesticRegistration.To
string or null <date-time>

Upper filtering bound to filter by. Upper bound is not included in the results.

FirstRegistration.From
string or null <date-time>

Bottom filtering bound to filter by. This lower bound is included in the results.

FirstRegistration.To
string or null <date-time>

Upper filtering bound to filter by. Upper bound is not included in the results.

Registered.From
string or null <date-time>

Bottom filtering bound to filter by. This lower bound is included in the results.

Registered.To
string or null <date-time>

Upper filtering bound to filter by. Upper bound is not included in the results.

Updated.From
string or null <date-time>

Search data by System.DateTimeOffset starting from this value.

Updated.To
string or null <date-time>

Search data by System.DateTimeOffset up to this value.

CategoryCodes
Array of strings or null

Search by vehicle categories codes.

MakeCodes
Array of strings or null

Search by vehicle make codes.

ModelCodes
Array of strings or null

Search by vehicle model codes.

TypeCodes
Array of strings or null

Search by vehicle type codes.

Statuses
Array of strings or null (BizMachine.Prospector.Modules.Vehicles.DataStructures.Enums.VehicleStatus)

Search by vehicle statuses.

Enum: "New" "Used" "Exported" "Removed"
AttributeCodes
Array of strings or null

Search by vehicle attribute codes.

Offset
integer <int32>

Allows to specify offset from where to start streaming results. Default value: 0

Limit
integer <int32>
Default: 200

Allows to specify limit of returned data.

SortBy
string or null

Sorting order and field to sort by in format sorting-order Valid orders: desc, asc.

Example: desc(createdAt)

Responses
200

Success

Response samples
{
  • "paging": {
    },
  • "data": [
    ]
}