GuidesAPI Reference

Points Attributes

Suggest Edits

In this section you will find the available attributes for our Points data set only.
To see the available attributes for other data sets, read:

As of API V1, we use our new, coherent data attribute naming convention.
Attribute names are determined according to three tiers:

Category – the frame of reference. For example: Vehicle, Mobility, Environment, Driver
Element – a component of the category. For example: Engine (in the Vehicle category), Speed (in the Mobility category)
Specific - a description of the element. For example: Temperature (of the Engine), Average (of the Speed)
Each data attribute is a unique trio, separated by two underscores ("__").

Some examples:
VehicleEngineTemperature - The current temperature of the vehicle's engine
EnvironmentExternalTemperature - The current air temperature level outside of the vehicle (ODB-II-PID:46) in celsius.
MobilitySpeedValue - The vehicle's current speed in Km/h (ODB-II-PID:0D)

attribute_name description type unit_name
environment__external__pressure The current barometric pressure outside of the vehicle (OBD-II-PID:33) Float kPa
environment__external__temperature The current air temperature level outside of the vehicle (ODB-II-PID:46) in celsius. Float celsius
environment__internal__temperature The current air temperature inside a vehicle in celsius. Float celsius
environment__road__temperature The temperature of the road in celsios Float celsius
location__altitude__value The current elevation above sea level of a given point in meters. Float meter
location__city__block_name The name of the city block a vehicle was on during a given point String string
location__city__name The name of the city a vehicle was located in for a given point String deg
location__continent__name The name of the continent a vehicle was located in during a given point String string
location__country__code The name of the country a vehicle was located in for a given point String deg
location__country__code_provided The country code a vehicle is located at for a given point. This attribute is reported directly by the vehicle. String  
location__country__name The name of the country a vehicle was located in during a given point String string
location__county__name The name of the county a vehicle was located in during a given point String string
location__district__name The name of the district a vehicle was located during a given point String string
location__farm__name The name of the farm a vehicle was located in during a given point String string
location__gps__hdop Horizontal Dilution Of Precision - GPS quality standard. Float ratio
location__gps__satellites_count The amount of GPS satellites available. Long number
location__gps__source The GPS source. Possible values:

gps

vehicle estimation

otonomo duplication

extrapolation

interpolation		 String  
location__house__address The address of the house a vehicle was located near during a given point String string
location__house__number The numerical address of the house a vehicle was located near during a given point String string
location__island__name The name of the island a vehicle was located in during a given point String string
location__latitude__blurred_value The blurred GPS latitude location (1 decimal, large city/district) Float deg
location__latitude__duplicated Duplication of GPS latitude to the latest known value (5 decimal). Float deg
location__latitude__value The GPS latitudinal location of a given vehicle in decimal degrees (WGS 84). Float deg
location__longitude__blurred_value The blurred GPS longitude location (1 decimal, large city/district) Float deg
location__longitude__duplicated duplication of GPS longitude to the latest known value (5 decimal) Float deg
location__longitude__value The GPS longitudinal location of a given vehicle in decimal degrees (WGS 84). Float deg
location__municipality__name The name of the municipality a vehicle was located near during a given point String string
location__neighbourhood__name The name of the neighborhood a vehicle was located in during a given point String string
location__polygon__geohash A geographic location shortened into letters and digits that represent a specific area. String string
location__quarter__name The name of the quarter a vehicle was located in during a given point String string
location__region__name The name of the region a vehicle was located in during a given point String string
location__road__name The name of the road a vehicle was on during a given point String string
location__square__name The name of the square a vehicle was on during a given point String string
location__state__name The name of the state a vehicle was located in during a given point String string
location__suburb__name The name of the suburb a vehicle was located in during a given point String string
location__town__name The name of the town a vehicle was located in during a given point String string
location__village__name The name of the village a vehicle was located in during a given point String string
maintenance__dtc__current_diagnostics The current defined Diagnostic Trouble Codes String comma-separated string
maintenance__service__days_to_next The number of days remaining before the next vehicle service is due. Integer days
maintenance__service__distance_to_next The remaining distance until next vehicle service is due Integer km
manufacturer__category__decoded The vehicle's category, decoded from VIN. String string
manufacturer__category__value The classification of a given vehicle String string
manufacturer__color__value The color of a vehicle String string
manufacturer__fuel__combined_consumption fuel average consumption declared by the carmaker, in liters per 100 km, for a combined use case. Float liters/100km
manufacturer__fuel__extra_urban_consumption fuel average consumption declared by the carmaker, in liters per 100 km, for an extra-urban use case. Float liters/100km
manufacturer__fuel__urban_consumption fuel average consumption declared by the carmaker, in liters per 100 km, for an urban use case. Float liters/100km
manufacturer__fuel_type__decoded The vehicle's primary fuel type, decoded from VIN. String string
manufacturer__fuel_type__value A manufacturer definition of the vehicle's type of fuel String string
manufacturer__make__decoded The vehicle's make or brand, decoded from VIN String string
manufacturer__make__value The vehicle's make or brand name. String string
manufacturer__model__decoded The vehicle's model, decoded from VIN String string
manufacturer__model__value The vehicle's model. String string
manufacturer__purchase__country The car's purchase country code. String  
manufacturer__tire__front_pressure The manufacturer's recommended front tires pressure. Float psi
manufacturer__tire__rear_pressure The manufacturer's recommended rear tires pressure. Float psi
manufacturer__year__decoded The year the vehicle was manufactured, decoded from VIN Integer year
manufacturer__year__value The year the vehicle was manufactured. Integer year
metadata__anonymization__type_name The type of anonymization preformed on the data String string
metadata__dataset__name The ID of the policy (usually the provider's name) String string
metadata__dataset__ramp16_provider The name of the data supplier for messages via Ramp16 String string
metadata__dataset__version The version of the gatekeeper running the policy. String string
metadata__description__device_id An identifier of the vehicle's OBD (On-Board Diagnostics) system String string
metadata__ingress_time__aggregator The timestamp added by PointsAggregator Long epoch
metadata__ingress_time__gatekeeper The GK timestamp Long epoch
metadata__ingress_time__mcdonalds The timestamp added by McDonald's Long epoch
metadata__ingress_time__ramp16 The timestamp added by Ramp16 Long epoch
metadata__ingress_time__shuttle The timestamp added by Shuttle Long epoch
metadata__parking__last_reported_time The last reported parking start time Long epoch milliseconds
metadata__provider__name The name of the provider String string
metadata__provider__vehicle_id The provider’s unique identification of the vehicle String string
metadata__service_name__first_received The first Otonomo service processing incoming data String  
metadata__source_attributes__invalid A value that was deemed invalid by the NormValuesValidator String string
metadata__static_data__policy_id The ID of the policy (usually the provider's name) from static data String  
metadata__static_data__policy_version The version of the static data running the policy String  
metadata__time__epoch The exact time of a given point (UTC) in Epoch format Long epoch milliseconds
metadata__time__static_data The ingress time of the static data Long epoch
metadata__time__zone The name of the timezone that data was transmitted from String epoch
mobility__acceleration__lateral The right (positive value) -and-left (negative value) acceleration of a vehicle in g. Float g
mobility__acceleration__value The forward (positive value) -and-backward (negative value) acceleration of a vehicle in g. Float g
mobility__acceleration__vertical The up (positive value) -and-down (negative value) acceleration of a vehicle. Float g
mobility__heading__angle The angle between the vehicle's direction in comparison to the north in degrees Float deg
mobility__hybrid_power__remaining_range The approximated distance an electric vehicle can drive before all of its power sources shut down Float km
mobility__odometer__value The accumulated distance traveled by a vehicle in km Float km
mobility__pitch__rate The vehicle's angular velocity around its lateral axis in rad/s Float rad/s
mobility__roll__angle Current degrees from flat Float deg
mobility__roll__rate The vehicle's angular velocity around its longitudinal axis in rad/s. Float rad/s
mobility__speed__value The vehicle's current speed in Km/h (ODB-II-PID:0D) Float km/h
vehicle__abs__status An indication of the ABS (Anti-lock Braking System) status.

0 - disabled

1 - enabled - nonactive

2 - active		 Integer  
vehicle__accelerator__status Accelerator status.

0 - not pressed

1 - pressed		 Integer  
vehicle__air_conditioner__target_temperature The current temperature set in the AC system Float celsius
vehicle__airbag__status Vehicle's airbag status.

0 - not inflated

1- inflated		 Integer  
vehicle__alternator__voltage The voltage of the vehicle's alternator Float volt
vehicle__battery__level The vehicle's battery power level (state of charge) Float percentage
vehicle__battery__voltage The current measurement of a  vehicle's battery voltage. Float volt
vehicle__brake__status Determines whether the brake pedal is being pressed. Integer  
vehicle__coolant__temperature The temperature of the engine coolant  (OBD-II-PID:05) in celsius. Float celsius
vehicle__cruise_control__status The status of the cruise control system.

0 - not active

1 - active		 Integer  
vehicle__door__1_1_status The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left. E.g. on a typical passenger vehicle, vehicle_door_1_1_status relates to the front-left door.   

0 - closed and locked

1 - closed and un-locked

2 - open		 Integer  
vehicle__door__1_2_status The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.    

0 - closed and locked

1 - closed and un-locked

2 - open		 Integer  
vehicle__door__2_1_status The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.

0 - closed and locked

1 - closed and un-locked

2 - open		 Integer  
vehicle__door__2_2_status The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left. E.g. on a typical passenger vehicle, vehicle_door_2_2_status relates to the right-back door.   

0 - closed and locked

1 - closed and un-locked

2 - open		 Integer  
vehicle__door__central_lock_status Status of the vehicle central lock.

0 - open

1 - locked

2 - vehicle locked internally

3 - vehicle locked externally

4 - vehicle selectively unlocked		 Integer  
vehicle__electrical_motor__temperature The temperature of the engine in an electric vehicle Float celsius
vehicle__emergency_brake_system__status The emergency braking system status.

0 - off

1- warning

2 - active

The following values are a summary of the last 20 seconds:

50 - off and warning

51 - off and active

52 - warning and active

53 - off, warning and active

54 - value not used

55 - value not used and off

56 - value not used and warning

57 - value not used, warning and off

58 - value not used and active

59 - value not used, off and active

60 - value not used, warning and active

61 - value not used, warning, active and off		 Integer  
vehicle__engine__fuel_injection_timing Crank Angle Degrees (CAD) relative to TDC of the compression stroke; OBD-II-PID: 5D Float degrees
vehicle__engine__intake_air_temperature The temperature of the air entering the vehicle Float celsius
vehicle__engine__intake_map The vehicle's intake manifold absolute pressure (OBD-II-PID:0B) Float kPa
vehicle__engine__load The calculated engine load of the vehicle (OBD-II-PID:04) Float percentage
vehicle__engine__mass_air_flow The mass of air flowing into the engine's air intake system (OBD-II-PID:10) in kg/s. Integer kg/s
vehicle__engine__oil_level The percentage of oil remaining in the engine's oil tank Float percentage
vehicle__engine__oil_temperature The measured temperature of the oil in the engine Float celsius
vehicle__engine__rpm The engine's revolutions per minute (OBD-II-PID:0C) Float r/m
vehicle__engine__run_duration The vehicle's run time since the engine was ignited (OBD-II-PID:1F) Float second
vehicle__engine__status Engine status.

0 - not running

1 - starting

2 - running

3 - Engine stopped by the start/stop system		 Integer  
vehicle__engine__temperature The current temperature of the vehicle's engine Float celsius
vehicle__engine__throttle_actuator The vehicle's commanded throttle actuator (OBD-II-PID:4C) Float percentage
vehicle__engine__throttle_position The vehicle's throttle position (OBD-II-PID:11) Float percentage
vehicle__engine__timing_advance The ignition timing advance for #1 cylinder (OBD-II-PID:0E) Float degrees
vehicle__esp__status An indication of the ESP (Electronic Stability Control) status.

0 - disables

1 - enabled - nonactive

2 - active		 Integer  
vehicle__evap__pressure The vehicle's evaporative system vapor pressure (OBD-II-PID: 54) Float Pa
vehicle__fog_light__front_status The status of a vehicle's front fog lamp

0 - off

1 - on		 Integer  
vehicle__fog_light__rear_status The status of a vehicle's rear fog lamp.

0 - off

1 - on		 Integer  
vehicle__fuel__amount The current amount of fuel available in the fuel tank in liters. Float liter
vehicle__fuel__avg_consumption The vehicle's calculated rate of fuel consumption in percentage/km Float percentage/km
vehicle__fuel__capacity The vehicle's fuel tank capacity in liters. Float liter
vehicle__fuel__level A vehicle's current fuel level expressed in percentages (OBD-II-PID:2F) Float percentage
vehicle__fuel__pressure The current fuel/gauge pressure within the vehicle (OBD-II-PID:0A) Float kPa
vehicle__fuel__pump_temperature The temperature of the fuel pump in Celsius Float Celsius
vehicle__fuel__remaining_range An approximated distance a vehicle can drive before running out of fuel in km Float km
vehicle__fuel__tank_door_status The status of a vehicle's fuel tank.

0 - locked

1 - unlocked		 Integer  
vehicle__gear__position The current position of the gear stick String string
vehicle__headlights__status The status of a vehicle's headlights.

0 - off

1 - on		 Integer  
vehicle__hood__status Indicates the engine's hood (bonnet) status.

0 - closed

1 - open		 Integer  
vehicle__horn__status An indication of whether the horn is being pressed

0 - not pressed

1 - pressesd		 Integer  
vehicle__hv_battery__ac_charging_current The maximum current of the last charging cycle (Alternating current). Float A
vehicle__hv_battery__ac_charging_voltage The Voltage of the last charging cycle (Alternating current). Float V
vehicle__hv_battery__capacity HV (high voltage) battery capacity in Wh Float Wh
vehicle__hv_battery__charging_duration HV (high voltage) battery charging duration Integer seconds
vehicle__hv_battery__charging_method Vehicle charging current (AC/DC) and plug type. 

0 - No Charging

1 - AC Type1 Plug

2 - AC Type2 Plug		 Integer  
vehicle__hv_battery__charging_status The charging status of a vehicle's (Hybrid or EV) high voltage battery

0 - not charging

1 - charging while driving  - regenerative brake

2 - charging at a charging station		 Integer  
vehicle__hv_battery__consumption An electric vehicle's current battery consumption Float km/kwh
vehicle__hv_battery__energy HV (high voltage) battery remaining energy in Wh Float  
vehicle__hv_battery__level HV (high voltage) battery level in percentage Float percentage
vehicle__hv_battery__remaining_range The approximated distance an electric vehicle can drive before running out of battery Float km
vehicle__hv_battery__voltage The voltage of the battery of an electric vehicle. Float volt
vehicle__identification__daily_id A vehicle's daily identification number created by otonomo String string
vehicle__identification__descriptor A portion of the vehicle identification number String string
vehicle__identification__otonomo_id A unique vehicle's identification number created by Otonomo String string
vehicle__identification__vin The vehicle's identification number String string
vehicle__ignition__status Ignition status. (state of the Ignition switch)

0 - Lock/Off turn the engine off, keys can be removed only in this state

1 - Accessory. The vehicle systems receive energy from the battery, the engine is off.

2 - On/Run - the engine is on

3 - start - ignition event (cranking the engine)

4 - initialization		 Integer  
vehicle__indication_light__coolant_temperature The status of a vehicle's coolant warning light.

0 - off

1 - on		 Integer  
vehicle__indication_light__low_fuel The status of the low fuel light.

0 - off

1 - on		 Integer  
vehicle__indication_light__mil The status of the check engine light (MIL alert).

0 - off

1 - on		 Integer  
vehicle__indication_light__mil_distance The total distance a vehicle has traveled with the malfunction indicator lamp on (OBD-II-PID:21) Float km
vehicle__indication_light__mil_duration The run time of a given vehicle with the malfunction indicator lamp on (OBD-II-PID:4D) Float minute
vehicle__indication_light__oil_level The status of a vehicle's oil level warning light.

0 - off

1 - on		 Integer  
vehicle__indication_light__oil_maintenance The status of a vehicle's oil maintenance warning light.

0 - off

1 - on		 Integer  
vehicle__indication_light__oil_pressure The status of a vehicle's oil pressure warning light

0 - off

1 - on		 Integer  
vehicle__indication_light__power_steering The status of a vehicle's electric power steering warning light.

0 - off

1 - on		 Integer  
vehicle__indication_light__tire_pressure The status of a vehicle's tire pressure warning light.

0 - off

1 - on		 Integer  
vehicle__infotainment__album_name current played song album name String string
vehicle__infotainment__artist_name current played song artist name String string
vehicle__infotainment__audio_status Vehicle infotainment audio status.

0 - off

1 - on		 Integer  
vehicle__infotainment__media_source Name of the currently active media source (AM, FM, SDARS, CD, MP3, Pandora, Spotify, iHeart, TuneIn, Aha, etc.) String string
vehicle__infotainment__radio_frequency Frequency of the radio station in the vehicle Float MHz
vehicle__infotainment__radio_station Name of the radio station currently played in the vehicle String string
vehicle__infotainment__song_name Current played song title String string
vehicle__infotainment__volume Audio Volume Level Integer integer
vehicle__lane_assist__left_status Left lane keep assist.

0 - Keep assist system is off

1 - Keep assist system is on, but unavailable (due to road condition for example)

2 - Keep assist system is on

3 - Active.  Correction in progress

The following values are a summary of the last 20 seconds:

50 - Keep assist was off and unavailable

51 - Keep assist was  on and off

52 - Keep assist was on, unavailable and on again

53 - Keep assist was on, unavailable and off

54 - Keep assist was off and active

55 - Keep assist was on, unavailable and active

56 - Keep assist was on, unavailable, active and off

57 - Keep assist was on and active

58 - Keep assist was off, on and active

59 - Keep assist was on, unavailable, on and active

60 - Keep assist was off, on, unavailable, on and active		 Integer  
vehicle__lane_assist__right_status Right lane keep assist.

0 - Keep assist system is off

1 - Keep assist system is on, but unavailable (due to road condition for example)

2 - Keep assist system is on

3 - Active.  Correction in progress

The following values are a summary of the last 20 seconds:

50 - Keep assist was off and unavailable

51 - Keep assist was  on and off

52 - Keep assist was on, unavailable and on again

53 - Keep assist was on, unavailable and off

54 - Keep assist was off and active

55 - Keep assist was on, unavailable and active

56 - Keep assist was on, unavailable, active and off

57 - Keep assist was on and active

58 - Keep assist was off, on and active

59 - Keep assist was on, unavailable, on and active

60 - Keep assist was off, on, unavailable, on and active		 Integer  
vehicle__parking_brake__status The status of the hand/parking brake.

0 - off

1- on		 Integer  
vehicle__reading_light__1_1_status The status of a vehicle's reading lamp.  The (i_j) notation refers to the i-th row and j-th column starting from (1,1) for the top left.    

0 - off

1 - on		 Integer  
vehicle__reading_light__1_2_status The status of a vehicle's reading lamp.  The (i_j) notation refers to the i-th row and j-th column starting from (1,1) for the top left.    

0 - off

1 - on		 Integer  
vehicle__roof__convertible_status The status of a vehicle's convertible top.

0 - closed and locked

1 - unlocked

2 - open and locked		 Integer  
vehicle__roof__sunroof_status The status of a vehicle's sunroof.

0 - Closed

1 - Open

2 - Sunroof is tilted-open

3 - Sunroof is running

4 - Sunroof in anti-wobble position

5 - Sunroof in an intermediate sliding position

6 - Sunroof in an intermediate tilted position		 Integer  
vehicle__seat_belt__1_1_status An indication of whether the seat belt is fastened.

The (i_j) notation refers to the i-th row and the j-th column starting from (1,1) for the top left.

0 - not fastened

1 - fastened		 Integer  
vehicle__seat_belt__1_2_status An indication of whether the seat belt is fastened.

The (i_j) notation refers to the i-th row and the j-th column starting from (1,1) for the top left.

0 - not fastened

1 - fastened		 Integer  
vehicle__seat_belt__2_1_status An indication of whether the seat belt is fastened.

The (i_j) notation refers to the i-th row and the j-th column starting from (1,1) for the top left.

0 - not fastened

1 - fastened		 Integer  
vehicle__seat_belt__2_2_status An indication of whether the seat belt is fastened.

The (i_j) notation refers to the i-th row and the j-th column starting from (1,1) for the top left.

0 - not fastened

1 - fastened		 Integer  
vehicle__seat_belt__2_3_status An indication of whether the seat belt is fastened.

The (i_j) notation refers to the i-th row and the j-th column starting from (1,1) for the top left.

0 - not fastened

1 - fastened		 Integer  
vehicle__steering_wheel__angle The angle in which a steering wheel is currently placed (0 degrees means the vehicle is straight) Float deg
vehicle__steering_wheel__angular_velocity The speed in which the steering wheel rotates in deg/s. Float deg/s
vehicle__suspension__1_1_height Front Left Suspension Height Float mm
vehicle__suspension__1_2_height Front right Suspension Height Float mm
vehicle__suspension__2_1_height Rear left Suspension Height Float mm
vehicle__suspension__2_2_height Rear right Suspension Height Float mm
vehicle__tire__1_1_pressure The exact amount of tire pressure the vehicle's (i,j) wheel is experiencing.

The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.		 Float psi
vehicle__tire__1_2_pressure The exact amount of tire pressure the vehicle's (i,j) wheel is experiencing.

The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.		 Float psi
vehicle__tire__2_1_pressure The exact amount of tire pressure the vehicle's (i,j) wheel is experiencing.

The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.		 Float psi
vehicle__tire__2_2_pressure The exact amount of tire pressure the vehicle's (i,j) wheel is experiencing.

The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.		 Float psi
vehicle__trunk__status The status of a vehicle's trunk (boot).

0 - locked

1 - closed unlocked

2 - open		 Integer  
vehicle__turn_signals__status The status of the turn signal.

0 - off

1 - left

2 - right

3 - both on		 Integer  
vehicle__window__1_1_status The status of a vehicle's (i,j) window.

The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.    

0 - Intermediate position

1 - Opened

2 - Closed

3 - Airing position

4 - Intermediate, airing position

5 - Currently running		 Integer  
vehicle__window__1_2_status The status of a vehicle's (i,j) window.

The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.    

0 - Intermediate position

1 - Opened

2 - Closed

3 - Airing position

4 - Intermediate, airing position

5 - Currently running		 Integer  
vehicle__window__2_1_status The status of a vehicle's (i,j) window.

The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) top left.    

0 - Intermediate position

1 - Opened

2 - Closed

3 - Airing position

4 - Intermediate, airing position

5 - Currently running		 Integer  
vehicle__window__2_2_status The status of a vehicle's (i,j) window.

The vehicle door status. The (i_j) notation refers to the i-th row and j-th column starting from (1,1) for top left.    

0 - Intermediate position

1 - Opened

2 - Closed

3 - Airing position

4 - Intermediate, airing position

5 - Currently running		 Integer  

Updated over 3 years ago