Traffic API¶
TrafficApi
¶
Bases: HEREApi
A python interface into the HERE Traffic API
Source code in herepy/traffic_api.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
|
__init__(api_key=None, timeout=None)
¶
Returns a TrafficApi instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
api_key |
str
|
API key taken from HERE Developer Portal. |
None
|
timeout |
int
|
Timeout limit for requests. |
None
|
Source code in herepy/traffic_api.py
22 23 24 25 26 27 28 29 30 31 32 |
|
additional_attributes(quadkey, attributes)
¶
Request traffic flow including shape and functional class information.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
quadkey |
str
|
The quadkey unique defines a region of the globe using a standard addressing algortihm. |
required |
attributes |
List
|
List that contains FlowProximityAdditionalAttributes. |
required |
Returns:
Type | Description |
---|---|
[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
|
flow_availability_data()
¶
Flow availability requests allow you to see what traffic flow coverage exists in the current Traffic API.
Returns:
Type | Description |
---|---|
Optional[TrafficFlowAvailabilityResponse]
|
TrafficFlowAvailabilityResponse |
Source code in herepy/traffic_api.py
344 345 346 347 348 349 350 351 352 353 354 |
|
flow_in_corridor(points, width)
¶
Request traffic flow for a defined route.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
points |
List
|
List contains lists of latitude and longitude pairs in order. |
required |
width |
int
|
Width of corridor (in meters). |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
|
flow_using_proximity(latitude, longitude, distance)
¶
Request traffic flow for a circle around a defined point.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
latitude |
float
|
List contains latitude and longitude in order. |
required |
longitude |
float
|
List contains latitude and longitude in order. |
required |
distance |
int
|
Extending a distance of metres in all directions. |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
|
flow_using_proximity_returning_additional_attributes(latitude, longitude, distance, attributes)
¶
Request traffic flow information using proximity, returning shape and functional class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
latitude |
float
|
List contains latitude and longitude in order. |
required |
longitude |
float
|
List contains latitude and longitude in order. |
required |
distance |
int
|
Extending a distance of metres in all directions. |
required |
attributes |
List
|
List that contains FlowProximityAdditionalAttributes. |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
|
flow_using_quadkey(quadkey)
¶
Request traffic flow information using a quadkey.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
quadkey |
str
|
The quadkey unique defines a region of the globe using a standard addressing algortihm. |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
|
flow_with_minimum_jam_factor(top_left, bottom_right, min_jam_factor=7)
¶
Request traffic flow information in specified area with a jam factor.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
top_left |
List
|
List contains latitude and longitude in order. |
required |
bottom_right |
List
|
List contains latitude and longitude in order. |
required |
min_jam_factor |
int
|
Severe congestion with a jam factor greater than 7. |
7
|
Returns:
Type | Description |
---|---|
Optional[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
flow_within_boundingbox(top_left, bottom_right, response_attributes='sh,fc')
¶
Request traffic flow information within specified area.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
top_left |
List
|
List contains latitude and longitude in order. |
required |
bottom_right |
List
|
List contains latitude and longitude in order. |
required |
response_attributes |
String
|
String containing response attributes separated by commas. |
'sh,fc'
|
Returns:
Type | Description |
---|---|
Optional[TrafficFlowResponse]
|
TrafficFlowResponse |
Source code in herepy/traffic_api.py
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
|
incidents_in_bounding_box(top_left, bottom_right, criticality)
¶
Request traffic incident information within specified area.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
top_left |
List
|
List contains latitude and longitude in order. |
required |
bottom_right |
List
|
List contains latitude and longitude in order. |
required |
criticality |
List
|
List of IncidentsCriticalityStr. |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficIncidentResponse]
|
TrafficIncidentResponse |
Source code in herepy/traffic_api.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
|
incidents_in_corridor(points, width)
¶
Request traffic incidents for a defined route.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
points |
List
|
List contains lists of latitude and longitude pairs in order. |
required |
width |
int
|
Width of corridor. |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficIncidentResponse]
|
TrafficIncidentResponse |
Source code in herepy/traffic_api.py
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
|
incidents_via_proximity(latitude, longitude, radius, criticality)
¶
Request traffic incident information within specified area.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
latitude |
float
|
Latitude of specified area. |
required |
longitude |
float
|
Longitude of specified area. |
required |
radius |
int
|
Radius of area in meters. |
required |
criticality |
List
|
List of IncidentsCriticalityInt. |
required |
Returns:
Type | Description |
---|---|
Optional[TrafficIncidentResponse]
|
TrafficIncidentResponse |
Source code in herepy/traffic_api.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|