Skip to content

Data Dictionary

mavrovde edited this page Nov 1, 2026 · 1 revision

Data Dictionary

Part of the Data Model. Every field of the logical read model and every shared code list, in alphabetical order. A logical model for the API's read side, not a copy of any physical schema; storage names may differ. Types are those of Data Model section 5.1. Where one field name occurs in several entities with different meanings, each meaning is listed with its entity. The history entity traffic_event_observation repeats the fields of traffic_event with the same meaning; they are listed once.

This page is assembled from the field tables of the domain pages; when a domain page and this page differ, the domain page applies and this page is corrected (DM-021).

1. Entities

Entity Page
address [[Places
admin_region [[Places
alert_scope [[Transit
call_observation [[Transit
charge_point [[Energy
charge_point_state_observation [[Energy
charging_site [[Energy
connector [[Energy
event_extent [[Roads
facility_capacity [[Parking
facility_state_observation [[Accessibility
fuel_price_observation [[Energy
fuel_product [[Energy
fuel_station [[Energy
journey [[Transit
junction [[Roads
licence [[Provenance
occupancy_observation [[Parking
opening_period [[Energy
parking_facility [[Parking
path_facility [[Accessibility
place [[Places
place_alias [[Places
point_of_interest [[Places
publisher [[Provenance
punctuality_figure [[Transit
road [[Roads
road_weather_observation [[Weather
road_weather_station [[Weather
rule_statement [[Data Model
rule_topic [[Data Model
scheduled_call [[Transit
service_alert [[Transit
sharing_availability_observation [[Parking
sharing_station [[Parking
source [[Provenance
source_freshness [[Provenance
source_note [[Provenance
station_facility [[Accessibility
step_free_path [[Accessibility
stop_place [[Transit
stop_point [[Transit
text_variant [[Provenance
traffic_event [[Roads
traffic_event_observation [[Roads
transit_line [[Transit
transit_operator [[Transit
warning_area [[Weather
warning_coverage [[Weather
weather_warning [[Weather

2. Fields

Field Type Entity Definition
acceptance_required bool [[parking_facility Data-Model-Parking]], [[source
access enum<access> [[charging_site Data-Model-Energy]]
address_id id [[address Data-Model-Places]]
affected_length_m int [[traffic_event Data-Model-Roads]]
air_temp_c decimal(4,1) [[road_weather_observation Data-Model-Weather]]
alert_id id / id → service_alert [[service_alert Data-Model-Transit]], [[alert_scope
alert_severity enum<alert_severity> [[service_alert Data-Model-Transit]]
area_id id / id → warning_area [[warning_area Data-Model-Weather]], [[warning_coverage
area_kind enum<area_kind> [[warning_area Data-Model-Weather]]
area_name text [[warning_area Data-Model-Weather]]
attribution_required bool [[licence Data-Model-Provenance]]
attribution_text text [[source Data-Model-Provenance]]
availability enum<availability> [[charge_point_state_observation Data-Model-Energy]]
available_vehicles int [[sharing_availability_observation Data-Model-Parking]]
body ltext / text [[rule_statement Data-Model]], [[source_note
boundary polygon [[admin_region Data-Model-Places]], [[warning_area
brand text [[fuel_station Data-Model-Energy]]
cable enum<cable> [[connector Data-Model-Energy]]
call_order int / → scheduled_call [[scheduled_call Data-Model-Transit]], [[call_observation
call_status enum<call_status> [[call_observation Data-Model-Transit]]
category enum<poi_category> [[point_of_interest Data-Model-Places]]
cause enum<alert_cause> [[service_alert Data-Model-Transit]]
chainage_km decimal(6,1) [[junction Data-Model-Roads]]
changed_at instant [[record envelope Data-Model]]
changes_statement text [[source Data-Model-Provenance]]
closes_at time [[opening_period Data-Model-Energy]]
connector_type enum<connector_type> [[connector Data-Model-Energy]]
currency currency [[fuel_price_observation Data-Model-Energy]]
current_kind enum<current_kind> [[charge_point Data-Model-Energy]]
data_as_of instant [[source_freshness Data-Model-Provenance]]
delay_min int [[traffic_event Data-Model-Roads]]
description ltext [[traffic_event Data-Model-Roads]], [[service_alert
destination_label text [[journey Data-Model-Transit]]
dew_point_c decimal(4,1) [[road_weather_observation Data-Model-Weather]]
direction enum<direction> [[traffic_event Data-Model-Roads]], [[parking_facility
direction_label text [[traffic_event Data-Model-Roads]]
display_name text [[publisher Data-Model-Provenance]]
domain enum<domain> [[source Data-Model-Provenance]]
effect enum<alert_effect> [[service_alert Data-Model-Transit]]
event_id id / id → traffic_event [[traffic_event Data-Model-Roads]], [[event_extent
event_kind enum<event_kind> [[traffic_event Data-Model-Roads]]
evse_code key [[charge_point Data-Model-Energy]]
expected_arrival_at instant [[call_observation Data-Model-Transit]]
expected_back_at instant [[station_facility Data-Model-Accessibility]]
expected_departure_at instant [[call_observation Data-Model-Transit]]
expected_platform text [[call_observation Data-Model-Transit]]
extent polygon [[place Data-Model-Places]]
extra bool [[journey Data-Model-Transit]]
facility_id id / id → parking_facility / id → station_facility [[parking_facility Data-Model-Parking]], [[station_facility
facility_kind enum<facility_kind> [[station_facility Data-Model-Accessibility]]
facility_status enum<facility_status> [[station_facility Data-Model-Accessibility]], [[facility_state_observation
field text [[text_variant Data-Model-Provenance]]
free_spaces int [[occupancy_observation Data-Model-Parking]]
freshness_target_s int [[source Data-Model-Provenance]]
freshness_version text [[source_freshness Data-Model-Provenance]]
from_junction_id id → junction [[traffic_event Data-Model-Roads]]
from_km decimal(6,1) [[traffic_event Data-Model-Roads]], [[event_extent
from_label ltext [[step_free_path Data-Model-Accessibility]]
geometry line [[road Data-Model-Roads]]
hazard enum<hazard> [[weather_warning Data-Model-Weather]]
headline ltext [[traffic_event Data-Model-Roads]], [[service_alert
house_number text [[address Data-Model-Places]], [[point_of_interest
instruction ltext [[weather_warning Data-Model-Weather]]
issuer_name text [[weather_warning Data-Model-Weather]]
journey_id id / id → journey / → scheduled_call [[journey Data-Model-Transit]], [[scheduled_call
junction_id id [[junction Data-Model-Roads]]
junction_kind enum<junction_kind> [[junction Data-Model-Roads]]
label text / ltext [[place_alias Data-Model-Places]], [[fuel_product
lanes_closed int [[traffic_event Data-Model-Roads]]
lanes_total int [[traffic_event Data-Model-Roads]]
lang text [[place_alias Data-Model-Places]], [[source_note
legal_basis text [[rule_statement Data-Model]]
length_km decimal(6,1) [[road Data-Model-Roads]]
level_label ltext [[weather_warning Data-Model-Weather]]
licence_code key / key → licence [[licence Data-Model-Provenance]], [[source
licence_name text [[licence Data-Model-Provenance]]
licence_url text [[licence Data-Model-Provenance]]
line_id id / id → transit_line [[transit_line Data-Model-Transit]], [[journey
line_name text [[transit_line Data-Model-Transit]]
locality text [[address Data-Model-Places]], [[point_of_interest
location point [[place Data-Model-Places]], [[address
message_status enum<message_status> [[weather_warning Data-Model-Weather]]
modes list<enum<transport_mode>> [[stop_place Data-Model-Transit]]
name ltext / text [[admin_region Data-Model-Places]], [[place
name_kind enum<name_kind> [[place_alias Data-Model-Places]]
national_stop_code key [[stop_place Data-Model-Transit]]
note_kind enum<note_kind> [[source_note Data-Model-Provenance]]
number text [[junction Data-Model-Roads]]
number_fold text [[address Data-Model-Places]]
observed_at instant [[traffic_event_observation Data-Model-Roads]], [[fuel_price_observation
occupancy_status enum<occupancy_status> [[occupancy_observation Data-Model-Parking]]
official_key key [[place Data-Model-Places]]
on_time_share_pct decimal(5,2) [[punctuality_figure Data-Model-Transit]]
open_state enum<open_state> [[fuel_station Data-Model-Energy]]
open_state_at instant [[fuel_station Data-Model-Energy]]
opening_hours_text text [[point_of_interest Data-Model-Places]]
opens_at time [[opening_period Data-Model-Energy]]
operator_id id / id → transit_operator [[transit_operator Data-Model-Transit]], [[transit_line
operator_name text [[charging_site Data-Model-Energy]], [[parking_facility
origin_key key [[record envelope Data-Model]]
outline polygon [[parking_facility Data-Model-Parking]]
owner_entity text [[text_variant Data-Model-Provenance]]
owner_id id [[text_variant Data-Model-Provenance]]
parent_code key → admin_region [[admin_region Data-Model-Places]]
parent_id id → stop_place [[stop_place Data-Model-Transit]]
parking_kind enum<parking_kind> [[parking_facility Data-Model-Parking]]
path_id id / id → step_free_path [[step_free_path Data-Model-Accessibility]], [[path_facility
period_from instant [[punctuality_figure Data-Model-Transit]]
period_to instant [[punctuality_figure Data-Model-Transit]]
place_id id / id → place [[place Data-Model-Places]], [[place_alias
place_kind enum<place_kind> [[place Data-Model-Places]]
planned_arrival_at instant [[scheduled_call Data-Model-Transit]]
planned_departure_at instant [[scheduled_call Data-Model-Transit]]
planned_platform text [[scheduled_call Data-Model-Transit]]
platform_label text [[stop_point Data-Model-Transit]]
plug_standard enum<plug_standard> [[connector Data-Model-Energy]]
poi_id id [[point_of_interest Data-Model-Places]]
point_id id / id → charge_point [[charge_point Data-Model-Energy]], [[connector
position int [[rule_statement Data-Model]], [[event_extent
position_text ltext [[station_facility Data-Model-Accessibility]]
postcode text [[address Data-Model-Places]], [[point_of_interest
power_max_kw decimal(7,2) [[charge_point Data-Model-Energy]], [[connector
price decimal(6,3) [[fuel_price_observation Data-Model-Energy]]
price_unit enum<price_unit> [[fuel_product Data-Model-Energy]]
primary_event_id id → traffic_event [[traffic_event Data-Model-Roads]]
prior_status enum<facility_status> [[facility_state_observation Data-Model-Accessibility]]
product_code enum<fuel_type> / enum<fuel_type> → fuel_product [[fuel_product Data-Model-Energy]], [[fuel_price_observation
prominence int [[place Data-Model-Places]]
public_holiday bool [[opening_period Data-Model-Energy]]
published_at instant [[record envelope Data-Model]], [[weather_warning
publisher_id id / id → publisher [[publisher Data-Model-Provenance]], [[source
recorded_at instant [[record envelope Data-Model]]
region_code key / key → admin_region [[admin_region Data-Model-Places]], [[place
region_level enum<region_level> [[admin_region Data-Model-Places]]
register_version date [[source Data-Model-Provenance]]
review_signed_on date [[source Data-Model-Provenance]]
reviewed_on date [[rule_topic Data-Model]]
road_class enum<road_class> [[road Data-Model-Roads]], [[traffic_event
road_ref key / key → road [[road Data-Model-Roads]], [[junction
scope_kind enum<scope_kind> [[alert_scope Data-Model-Transit]]
search_fold text [[place_alias Data-Model-Places]], [[stop_place
service_date date [[journey Data-Model-Transit]]
severity enum<severity> [[traffic_event Data-Model-Roads]]
shape geometry [[traffic_event Data-Model-Roads]], [[event_extent
share_alike bool [[licence Data-Model-Provenance]]
share_alike_offer_url text [[source Data-Model-Provenance]]
site_id id / id → charging_site [[charging_site Data-Model-Energy]], [[charge_point
source_ref key → source / key [[record envelope Data-Model]], [[fuel_price_observation
stale_after_s int [[source Data-Model-Provenance]]
statement_id id [[rule_statement Data-Model]]
states list<key> [[road Data-Model-Roads]]
station_id id / id → fuel_station / id → sharing_station / id → road_weather_station [[fuel_station Data-Model-Energy]], [[sharing_station
status_changed_at instant [[station_facility Data-Model-Accessibility]]
status_note ltext [[station_facility Data-Model-Accessibility]], [[facility_state_observation
status_observed_at instant [[station_facility Data-Model-Accessibility]]
stop_place_id id / id → stop_place [[stop_place Data-Model-Transit]], [[stop_point
stop_point_id id / id → stop_point [[stop_point Data-Model-Transit]], [[scheduled_call
street text [[address Data-Model-Places]], [[point_of_interest
street_fold text [[address Data-Model-Places]]
successor_id id → place [[place Data-Model-Places]]
surface_state enum<surface_state> [[road_weather_observation Data-Model-Weather]]
surface_temp_c decimal(4,1) [[road_weather_observation Data-Model-Weather]]
terms_url text [[source Data-Model-Provenance]]
text_lang text [[traffic_event Data-Model-Roads]], [[service_alert
text_origin enum<text_origin> [[text_variant Data-Model-Provenance]]
title ltext [[rule_topic Data-Model]]
to_junction_id id → junction [[traffic_event Data-Model-Roads]]
to_km decimal(6,1) [[traffic_event Data-Model-Roads]], [[event_extent
to_label ltext [[step_free_path Data-Model-Accessibility]]
topic_code enum<rule_topic> [[rule_statement Data-Model]]
total_spaces int [[facility_capacity Data-Model-Parking]], [[occupancy_observation
transport_mode enum<transport_mode> [[transit_line Data-Model-Transit]], [[alert_scope
use_classes list<enum<use_class>> [[source Data-Model-Provenance]]
valid_from instant [[traffic_event Data-Model-Roads]], [[service_alert
valid_to instant [[traffic_event Data-Model-Roads]], [[service_alert
vehicle_class enum<vehicle_class> [[facility_capacity Data-Model-Parking]], [[sharing_station
vehicle_classes list<enum<vehicle_class>> [[rule_statement Data-Model]]
version_no int [[traffic_event_observation Data-Model-Roads]]
warning_id id / id → weather_warning [[weather_warning Data-Model-Weather]], [[warning_coverage
warning_level int [[weather_warning Data-Model-Weather]]
website text [[publisher Data-Model-Provenance]]
weekday int [[opening_period Data-Model-Energy]]
withdrawn_at instant [[record envelope Data-Model]]

3. Shared code lists

Every list is closed in storage and open in the API (DM-013, ENV-050): a client must tolerate a value it does not know. Unless stated, the stored code and the API value are the same string.

access

Value Meaning
public Anyone may use it
restricted Customers, residents, members or another limited group only
unknown Not published

alert_cause

accident, construction, weather, technical_problem, strike, police_activity, medical_emergency, demonstration, holiday, maintenance, other. The reason a service alert gives; null when none is published.

alert_effect

Value Meaning
no_service The affected lines or stops are not served
reduced_service Fewer journeys than planned
significant_delays Journeys run with large delays
detour Journeys run on another route
stop_moved A stop is served at another position
other Any other effect

alert_severity

Ordered info < minor < major < severe. The severity of a service alert as published or mapped.

area_kind

county, municipality, coast, lake, sea, other: the kind of area a weather warning is issued for.

availability

Value Meaning
available Free to start charging
occupied A vehicle is charging or connected
reserved Reserved for a user
out_of_order Not working, or not in operation
unknown No fresh state

cable

attached (the connector has its own cable), socket (bring a cable), unknown.

call_status

Value Meaning
scheduled Runs as planned as far as known
cancelled The call does not take place; it stays in the list (FR-TRANSIT-004)
extra An additional call not in the timetable
unknown No status

The API's status adds on_time and delayed, derived from delayMin by a documented threshold.

connector_type

The plug family the API speaks, mapped from plug_standard.

Value Meaning
type2 IEC 62196-2 Type 2 (AC)
ccs2 Combined Charging System, Combo 2 (DC)
chademo CHAdeMO (DC)
type1 SAE J1772 / IEC 62196-2 Type 1 (AC)
ccs1 Combined Charging System, Combo 1 (DC)
schuko Domestic socket CEE 7/4
nacs North American Charging Standard (SAE J3400)
other Any other plug

current_kind

ac (alternating current), dc (direct current).

direction

north, east, south, west, both, unknown: the carriageway of a road, by the general compass direction of travel on it. both affects both carriageways.

domain

places, roads, energy, parking, transit, accessibility, weather, rules: the domain a source belongs to.

event_kind

Value Meaning
closure The road or a part of it is closed
roadworks Works on or beside the road
jam Slow or stationary traffic
accident A collision or a broken-down vehicle
hazard An object, animal, person or condition on the road
restriction A restriction such as a weight, height or vehicle-class limit
weather Traffic affected by weather
other Anything else, including unmapped codes (ENV-051)

facility_kind

elevator, escalator, ramp, other: a station facility.

facility_status

Value Meaning
operative In service
inoperative Out of service
unknown Not known, or not confirmed within the stale threshold

fuel_type

Value Meaning Unit
e5 Petrol, up to 5 % ethanol (Super E5) litre
e10 Petrol, up to 10 % ethanol (Super E10) litre
diesel Diesel litre
lpg Liquefied petroleum gas litre
cng Compressed natural gas kilogram
lng Liquefied natural gas kilogram
h2 Hydrogen kilogram

hazard

thunderstorm, wind, rain, snow, ice, fog, heat, frost, uv, flood, other: the subject of an official weather warning, mapped from the issuer's event code.

junction_kind

exit, interchange, triangle, service_area, other.

licence_category

attribution, zero, share_alike, restricted_purpose, acceptance, official: the categories of Data Licensing and Attribution section 1.

message_status

issued (a new warning), updated (a new version of a warning), cancelled (withdrawn by the issuer before its end).

name_kind

official, alternate, exonym (a name in another language, such as "Cologne"), postcode. The API's matchedOn reports name for official, alternate_name for alternate and exonym, postcode for postcode.

note_kind

condition (a legal condition of use), purpose (the purpose the data may serve).

occupancy_status

Value Meaning
free Spaces available
filling Few spaces left
full No space
closed The facility is closed
unknown No status published

open_state

open, closed, unknown: whether a station is open, never a nullable boolean (CONV-012).

parking_kind

garage, lot, park_and_ride, rest_area, truck_parking, on_street, other.

place_kind

municipality, district, locality, region, state, station_area, other.

plug_standard

The formal standard as published: iec_62196_t1, iec_62196_t2, iec_62196_t2_combo, iec_62196_t1_combo, chademo, sae_j3400, domestic_f, iec_60309_industrial, other. Each maps to one connector_type.

poi_category

hospital, pharmacy, police, fire_station, rest_area, workshop, supermarket, toilet, atm, other.

price_unit

litre, kilogram.

region_level

state, district, municipality.

road_class

motorway, federal, state, urban, other. The same values as the public road_class filter.

rule_topic

lorry_sunday_ban, holiday_ban, speed_limits, winter_tyres, emission_zones, emergency_corridor, and further curated topics.

scope_kind

line, stop_place, mode, region: what one row of an alert's scope names.

severity

Ordered info < minor < lane_closed < major < road_closed: the effect of a traffic event on traffic.

Value Meaning
info No effect on capacity
minor Small effect, for example a hard-shoulder closure
lane_closed At least one lane closed
major Large effect, long delays expected
road_closed The carriageway is closed

surface_state

dry, damp, wet, ice, snow, frost, unknown.

text_origin

original (as published), curated (translated or written by a person), machine (machine-translated).

transport_mode

Value Meaning
long_distance_rail Long-distance trains
regional_rail Regional trains
suburban_rail Suburban rail (S-Bahn)
subway Underground (U-Bahn)
tram Tram and light rail
bus Bus and coach
ferry Ferry
other Any other mode, for example on-demand services

use_class

consumer, non_commercial, commercial: the kind of use a plan represents, matched against each source's permitted use classes.

vehicle_class

car, lorry, coach, motorhome, motorcycle, disabled (spaces for disabled drivers), all (the facility total).

Warning level

Not a code list but a closed integer scale, kept exactly as issued (FR-WEATHER-002):

Level Meaning
0 Advance information
1 Weather warning (minor)
2 Markedly severe weather
3 Severe weather
4 Extreme weather

4. Model vocabulary

Term Definition
Current-state record A record holding only the newest known state of a thing, replaced by each newer state
Event record A situation with a validity interval, kept in its current version and as a series of observations
Logical read model The entities and fields on these pages: the substance of the read contract, independent of storage names
Natural key The publisher's own key of a record (origin_key), unique only within its source
Observation One state at one observed_at, append-only
Record envelope The fields every record carries: source_ref, origin_key, published_at, recorded_at, changed_at, withdrawn_at
Reference record A record describing a thing that exists, updated in place and soft-closed when withdrawn
Representative point The one point of a located entity used for distances and nearest-neighbour questions
Retention class REF, CUR, OBS or TRN; see [[Data Model
Soft close Marking a withdrawn record with withdrawn_at and keeping it
Surrogate id The stable identity of a record, from which the public id is encoded

Home

About

Design

Data Model

Technical specification

Testing

Engineering

Technology choice

Reference

Clone this wiki locally