api.cdta.orgCDTA Route Schedule API

- Version 1 The CDTA API Route Schedule API allows authorized applications to access to public transit information for the Capital District Area (Albany, Schenectady, Rensselaer and Saratoga counties) in Upstate New York . Overview Time Routes Directions Route -- Schedules Stops Near Stops Search Stops Search Arrivals Alerts App Start App Usage -- Overview All of CDTA’s Route and Schedule API are read-only in nature, use HTTP/1.1 as the application protocol for communication, with HTTP GET as the method to call the service, and JSON formatted data as the default response. An XML response is also available if specified. Each API begins with a base URL followed by parameters and arguments. The service arguments are separated by either a forward slash ("/") as part of the URL path, or GET parameters with the standard "?/&/=" separators. The version of the API will be built into the URL, for example http://api.cdta.org/api/v1/?request=routes. An API key will be required to make requests to the API. All requests to the API must be accompanied by a valid API key. The API is still in BETA so please email us here to receive a key for testing purposes: API Key Request . Updates These are new items that have been added or changed within the CDTA API as we move along during development. # Area Description 0051 Search New endpoint that searches stop names, landmark names, stop ids and routes for relevant information. Will return urls to relevant information within API and on CDTA website. 0043 Search Stops New endpoint that searches stop names and stop ids for relevant stops. Also searches landmarks. 0041 Near Stops Added nearest landmarks as separate list (array). 0041 All Included Links to Browser Based Examples for all endpoints. (XML examples will need to view source to see return value) 0038 Stops Enabled endpoint to return all stops when no route_id is specified, all CDTA stops will be returned in alphabetical order Issues These are the current issues or bugs with the CDTA API as we move along during development. # Area Description 0035 Schedules Not Functionally Complete: This end point is functional but not accepting direction_name as a parameter instead it only accepts direction_id -- 0018 Arrivals Limited Data: This end point is fully functional but only returning data for route 1 currently. All schedule data will be loaded by November 1, 2013 0012 Schedules Limited Data: This end point is functional but only returning data for route 1 currently. All schedule data will be loaded by November 1, 2013 -- 0033 Near Stops Distance: The current distance is in degrees and is an approximation using the Pythagorean distance formula. 0034 Near Stops Distance Feet: The calculation for the distance in feet is based on the length of degree at a specific latitude. This is currently set the average of 268977.45 for one degree of longitude and 364455.15 for one degree of latitude. Suffice to say the distance in feet is an APPROXIMIATION. For miles the lengths are 59.98 for one degree of latitude and 50.94 for one degree of longitude. Authentication All requests to the CDTA API require an application key to validate the request. The application key is requested by the developer from CDTA and will be used to track the number and type of requests that are made. Response Codes A HTTP Get Request will return one of the following response codes. Status 200 Ok - the request was good and response is valid. 401 Unauthorized - invalid API key 404 Not Found 405 Invalid Method - we only do GETs around here 415 Unsupported Media Type - we only do JSON and XML 429 Too Many Request – your application has exceeded the number of requests possible. Contact developer support to increase your request threshold. 500 Server Error – sorry something went wrong, please try again later 503 Service Unavailable – again really sorry, service is temporarily down, please try again later Time This method may be used to determine if your application time is synchronized to systems time. This may be used to determine if “next scheduled bus”. GET /api/v1/?request=time Returns the current system date and time. Parameters key (required) string API Access Key. format (optional) string json (default); xml. Response Fields time (required) date-time current system time in format YYYYMMDD HH:MI:SS uri (required) string self referencing uri Response-JSON 200 SHOW < Content-Type: application/json > { "time":"20131010 10:57:05", "uri":"\/api\/v1\/time" } Response-XML 200 SHOW < Content-Type: application/xml > <?xml version="1.0"?> <cdta-response> <time>20131010 12:07:47</time> <uri>/api/v1/time</uri> </cdta-response> Examples Hint: Click on the Example Name to see response in browser. default curl -G "http://api.cdta.org/api/v1/?request=time" -H "key: <apikey> " format specified curl -G "http://api.cdta.org/api/v1/?request=time&format=xml" -H "key: <apikey> " Routes This method is used to get either a full list of route information or an individual route GET /api/v1/?request=routes/{route_id} Returns the detailed information for a route including name, type, description, urls to pdf schedule, kml and map images. There are also styling information for the route including color and text color. If no {route_id} is specified then a list of all routes will be returned. Parameters route_id (optional) string The route identifier. If no identifier specified then all routes are returned. key (required) string API Access Key. format (optional) string json (default); xml. Response Fields route_id (required) string one, two or three digit route identifier route_name (required) string name of route route_type (required) string route type (BRT, Trunk, Neighborhood, Commuter, Express, Northway Express) route_description (required) string route running description route_url (required) string full cdta website url for the route schedule_url (required) string full url for the route pdf schedule (.pdf) map_kml_url (required) string full url for the route kml file (.kml) map_image_url (required) string full url for the route map image (.png) route_color (required) string Hex value representing the route badge (background circle) or line color route_text_color (required) string Hex value representing the route text color on top of the route badge or line service_days (required) string Comma separated list of which days the service is run, these include: Weekday, specific day of week (ex. Wednesday), Saturday and/or Sunday route_effective_date (required) string effective date of the route information YYYYMMDD HH:MI:SS route_schedule_uri (required) string route schedule reference uri uri (required) string self reference uri Response-JSON 200 SHOW < Content-Type: application/json > { "routes" : [{ "route_id" : "1", "route_name" : "Central Avenue", "route_type" : "Trunk", "route_description" : "<p><strong><u>East<\/u><\/strong><\/p>\r\n\r\n<p>Leave the bus shelter in front of Colonie Center via north on Wolf Road, to a right into Colonie Center at Dunkin Donuts. Bear left around the back of Macy&rsquo;s, to left at the stop sign, to left on Sand Creek Road, to left on Wolf Road, to left on Central Avenue, into Washington Avenue, to right on Eagle Street, to left on State Street, to right on Broadway, to right on Madison Avenue, to Madison Avenue staging area.<\/p>\r\n\r\n<p><u><strong>West<\/strong><\/u><\/p>\r\n\r\n<p>Leave Staging Area via right on Green Street, to a left on Dallius Street, to a right on Division Street, to a left on Broadway, to left on State Street, to right on Eagle Street, to left on Washington Avenue, bear right to Central Avenue, to right on Wolf Road, to the bus cutout in front of Colonie Center.<\/p>", "route_url" : "http:\/\/api.cdta.org\/schedules_route_details.php?route_id=7", "schedule_url" : "http:\/\/api.cdta.org\...