Every entity codriver renders is one of the kinds below. Providers map their upstream's vocabulary to this taxonomy on output. Anything outside this list is rejected at ingest.
The TTLs below are seeded defaults for durable reports and feed ingestion.
They do not control built-in live incident freshness: that source uses the
five-minute Redis lifecycle,
with durable history saved on first driver confirm/dispute. Feeds can override
these defaults with ttl_seconds.
| Kind | Default TTL | Description |
|---|---|---|
alert.police |
10 min | Police presence, speed trap, checkpoint |
alert.accident |
10 min | Accident, crash, collision |
alert.hazard |
10 min | Generic hazard — use only if no subtype below fits |
alert.hazard.car_stopped |
10 min | Stopped vehicle on shoulder / lane |
alert.hazard.object_on_road |
10 min | Debris, tire, fallen cargo, lost load |
alert.hazard.pothole |
7 d | Pothole, lane damage |
alert.hazard.animal |
4 h | Animal on road (live or roadkill) |
alert.hazard.fog |
10 min | Fog patch reducing visibility |
alert.hazard.ice |
10 min | Ice, freezing rain, slippery surface |
alert.hazard.flooding |
2 h | Flooded road, heavy rain pooling |
alert.road_closed |
2 h | Full road closure (event, accident, work) |
alert.construction |
7 d | Construction zone, lane reduction, work in progress |
Properties commonly seen on alerts:
{
"subtype": "<upstream's subtype string, if any>",
"street": "Boul René-Lévesque",
"city": "Montréal",
"country": "CA",
"reported_by": "<username, if your upstream has it>",
"description": "<free-text>",
"num_thumbs_up": 0, // upstream confidence
"reliability": 6, // 0-10, optional
"confidence": 0, // 0-10, optional
"observed_from": { // for community-submitted alerts
"course_deg": 180, // heading of the observer
"speed_kmh": 45
}
}
| Kind | Default TTL | Description |
|---|---|---|
traffic.jam |
5 min | Driver-reported traffic jam (a point pin, separate from congestion ribbons) |
Properties on jams:
{
"severity": 3, // 1-4 for built-in reported traffic
"speed_kmh": 12.4, // current avg speed
"length_m": 850, // jam length in meters
"delay_s": 240, // delay vs free-flow
"street": "Highway 40",
"city": "Montréal",
"line_coordinates": [[-73.57, 45.50], [-73.56, 45.51], ...] // [lng, lat], GeoJSON order
}
The entity's lat / lng is the position of the jam. line_coordinates is accepted and stored, but an entity published by a feed is drawn as a point — codriver does not render a feed-supplied polyline. Send it if you have it (it is useful data), but do not count on a shape appearing on the map.
| Kind | Default TTL | Description |
|---|---|---|
camera.speed |
30 d | Fixed speed camera |
camera.red_light |
30 d | Red-light enforcement camera |
camera.avg_speed |
30 d | Average-speed enforcement (entry/exit pair) |
charger.supercharger |
30 d | Tesla Supercharger (DC fast, 150-250 kW typical) |
charger.destination |
30 d | Tesla Destination charger (AC, 7-22 kW typical) |
Properties on cameras:
{
"maxspeed": "50", // posted limit at the camera, string (some are 'variable')
"direction": "north", // compass / bearing if known
"name": "Sherbrooke St E camera",
"ref": "<upstream reference id>"
}
Properties on chargers:
{
"name": "Montréal-Ferrier Supercharger",
"address": "1234 Boul X, Montréal, QC",
"stalls": 12,
"max_kw": 250,
"connector_types": ["Tesla", "CCS"],
"last_verified": "2025-08-14T00:00:00Z",
"is_operational": true,
"usage_cost": "$0.41/kWh"
}
kind is validated per row at ingest. A row whose kind is not in this catalog is rejected individually — the rest of your batch or snapshot still lands. On push you see it in the errors array of the response; on pull it is counted as a rejection against that poll.
The catalog grows when a real provider needs to publish something new and the existing kinds don't fit. To request: email support@codriver.io with:
alert.hazard.pothole is the naming pattern)alert / event / poi)properties shapeSpeculative additions ("I might use this someday") aren't added. The taxonomy stays small on purpose.