Regions & corridors
The region argument selects the region. Geofence works for every region, while route and depot require interstate route artifacts, currently built for Travis and the cross-state interstate corridors.
Checking the live list
The table below is the full mode matrix from the catalog. The set of regions actually loaded by a given server is reported by hb.regions(). Check against it before sending.
for r in hb.regions().regions:
print(r.region, r.modes)Mode availability by region
| Region | Geofence | Route | Depot |
|---|---|---|---|
travis | ✅ | - | - |
houston | ✅ | - | - |
sanantonio | ✅ | - | - |
dallas | ✅ | - | - |
sf | ✅ | - | - |
la | ✅ | - | - |
phoenix | ✅ | - | - |
vegas | ✅ | - | - |
sandiego | ✅ | - | - |
sacramento | ✅ | - | - |
philadelphia | ✅ | - | - |
boston | ✅ | - | - |
cambridge | ✅ | - | - |
worcester | ✅ | - | - |
dc | ✅ | - | - |
polk | ✅ | - | - |
johnson | ✅ | - | - |
chicago | ✅ | - | - |
interstates | - | ✅ | ✅ |
City geofences
The geofence regions are metropolitan counties and cities across TX, CA, AZ, NV, PA, MA, IA and IL, for example travis (Austin), houston, dallas, sanantonio, sf, la, sandiego, sacramento, phoenix, vegas, philadelphia, boston, cambridge, worcester and chicago. Each carries its own crash and calibrated-VMT layers.
The three Massachusetts regions are municipal boundaries rather than counties, because none of those cities is coterminous with its county. They also record no airbag deployment, so outcome=airbag and outcome=ego_airbag return a 400 there. See the note below.
Interstate corridors
interstates is not a city. It is a multi-state interstate network, and the only region that supports route and depot modes. It spans the California interstates (I-5, I-80, I-580, I-205) and the CA and AZ cross-state corridors (I-10, I-15, I-40).
For route mode you pass (route, milepost) segments, and multi-corridor trips are stitched together via a junction graph. For depot mode you pass two lat/lon pins and the engine routes between them.
California-only denominator toggle
The denominator_vmt filter (CPRD vs HPMS) is meaningful only for the California geofence regions. Every other region uses a single state-DOT calibrated denominator and rejects denominator_vmt=hpms with a 400.
Boston defaults to a different crash year
crash_year defaults to 2022 everywhere except boston, which defaults to 2023. 28% of Boston's 2022 crashes were filed with an unknown severity and no injury counts, so its 2022 any-injury and serious+ rates read low. Omitting crash_year for boston therefore gives you 2023. Pass the year explicitly if you need a specific one.
Outcomes are not available in every region
A region whose source data cannot express an outcome rejects it with a 400 rather than returning a zero. Today that is airbag and ego_airbag for boston, cambridge, worcester, dc, polk and johnson. police_reported, observed_any_injury, ka and fatal are available everywhere.