Query Parameter | Description | Parameter Options |
---|---|
customer |
Unique customer name provided by Digichief |
customer_api_key |
Your company's unique API keyy |
parameters |
Mandatory Parameter |
latlon |
Coordinates of center point in which to pull available transit. For mat follows: XX.XXXX,-XX,XXXX |
radius |
Radius from Latitude and Longitude to pull available transit, in meters |
&dest3 |
Lists the nearby stops with up to 3 arrival times per route. |
Optional Parameter |
|
&format= |
JSON or XML. Defaults to JSON. |
µ |
A switch parameter that adds docked and dockless vehicles to the output. |
&mindest= |
How many trip times will be in each destination, &mindest= valules 1 to 5 |
&format= |
JSON or XML. Defaults to JSON. |
Data Points | Roadify node | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
stops |
A list of transit stops within the radius in meters from the requested latlon |
|||||||||
id |
id |
The identifier of the stop |
||||||||
zone |
zone |
Transit system, such as NYC_MTA_Subway, NJ RAIl, MTA Bus, etc. |
||||||||
name |
name |
The display name of the stop like 5th Ave-Marion St |
||||||||
distance |
distanceM |
The distance of the stop, in meters, from the latlon provided in the request |
||||||||
lat |
lat |
Latitude of request |
||||||||
lon |
lon |
Longitude of request |
||||||||
routes |
routes |
List of routes to (direction1) or from (direction0) the stop |
||||||||
zone |
zone |
Transit system for this Route |
||||||||
id |
id |
The identifier of the route with multiple trips between the stop to and from another location |
||||||||
routeType |
routeType |
routeType:
Numberic identifier of route type - refer to routeType table |
||||||||
name |
name |
Route name |
||||||||
color |
color |
Route color |
||||||||
colorText |
colorText |
Color of text to be put on route color background if required |
||||||||
trips |
trips |
Describes the trips for a given route, including departure locations and times |
||||||||
direction0 |
Array of trips leaving the stop location |
|||||||||
id |
The identifier of each trip - one for each trip for the route |
|||||||||
route |
The id of route - |
|||||||||
direction |
The destination of the route |
|||||||||
did |
Direction name - always 0 for direction0 |
|||||||||
dest |
Destination name |
|||||||||
depTime |
The estimated time of departure for the stop in the time zone defined by the tz parameter |
|||||||||
depUTC |
The departure time, in seconds, since Unix epoch coordinated UTC - 1/1/1970 00:00:00 |
|||||||||
tz |
The IANA time zone identifier |
|||||||||
direction1 |
Array of trips arriving at the stop location |
|||||||||
id |
The identifier of each trip - one for each trip for the route |
|||||||||
route |
Given route within the array |
|||||||||
direction |
The destination of the route |
|||||||||
did |
Direction name - always 1 for direction1 |
|||||||||
dest |
Destination name |
|||||||||
depTime |
The estimated time of departure for the stop in the time zone defined by the tz parameter |
|||||||||
depUTC |
The departure time, in seconds, since Unix epoch coordinated UTC - 1/1/1970 00:00:00 |
|||||||||
tz |
The IANA time zone identifier |
|||||||||
Using µ | ||||||||||
docked |
||||||||||
id |
Unique ID of docked item |
|||||||||
src |
Provider name of docked vehicles |
|||||||||
addr |
Address of docked vehicles |
|||||||||
lat |
latitude of dock |
|||||||||
lon |
longitud of dock |
|||||||||
date |
date/time |
|||||||||
name |
Street identifiers often the same as addr |
|||||||||
total |
Number of total dock vehicle capacity |
|||||||||
docks |
Number of docks open |
|||||||||
bikes |
Number of bikes available |
|||||||||
dockless |
||||||||||
id |
Unique ID of dockless |
|||||||||
provider_id |
Dockless provider ID |
|||||||||
provider_name |
Dockless provider name |
|||||||||
lat |
latitude of vehicle |
|||||||||
lon |
longitude of vehicle |
|||||||||
vechicle_type_id |
Vehicle type |
|||||||||
distance |
Distance from lat/lon in the request |