MyBikelane Home > API Docs

Developer API Documentation

Info

This is a common read-only API to the MyBikelane and UncivilServants database. All methods are web addressable and configurable using simple query string arguments. All data collected by either site is exposed and it is our hope that the development community takes this and uses it.

Format and Response Codes

Optional arguments are passed to the methods via query string in some cases. Where an argument references a key to a numeric ID, you can retrieve a list of those records via related methods.

All methods return an HTTP response code. In event of an error, generally a text response with more information will also be returned.

Output of data is user specified and can be one of JSON (default if none specified) of XML. Additional formats may be added in the future if enough need to warrant.

Methods

Sites
url: http://www.mybikelane.com/api/sites
description: Retrieve a listing of the various sites from which you can retrieve data.
optional args
  • format -- output in one of json | xml
Cities
url: http://www.mybikelane.com/api/cities
description: Retrieve a listing of the various cities the site recognizes.
optional args
  • format -- output in one of json | xml
Tags
url: http://www.mybikelane.com/api/tags
description: Retrieve a listing of the tags set on posts. Only used by MyBikelane.com.
optional args
  • city_id -- integer id of the city to limit results to
  • limit -- limit to this number of results
  • format -- output in one of json | xml
Agencies
url: http://www.mybikelane.com/api/agencies
description: Retrieve list of city agencies tied to posts. Only used by Uncivilservants.org.
optional args
  • format -- output in one of json | xml
Permit Types
url: http://www.mybikelane.com/api/permits
description: Retrieve list of permit types tied to posts. Only used by Uncivilservants.org.
optional args
  • format -- output in one of json | xml
Signs
url: http://www.mybikelane.com/api/signs
description: Retrieve list of signs tied to posts. Only used by Uncivilservants.org.
optional args
  • format -- output in one of json | xml
Violations
url: http://www.mybikelane.com/api/violations
description: Retrieve list of violations tied to posts. Only used by Uncivilservants.org.
optional args
  • format -- output in one of json | xml
Posts
url: http://www.mybikelane.com/api/posts
description: Retrieve list of posts.
optional args
  • site_id -- integer id of the site to limit results to
  • city_id -- integer id of the city to limit results to
  • plate_id -- integer id of the license plate record to limit results to
  • plate -- string value of license plate record to limit results to; requires plate_state in addition
  • plate_state -- string value of license plate state record to limit results to; requires plate in addition
  • member_id -- integer id of the uploading member_id to limit results to
  • violation_id -- integer id of the violation type to limit results to
  • agency_id -- integer id of the agency id to limit results to
  • permit_id -- integer id of the permit type id to limit results to
  • sign_id -- integer id of the sign id to limit results to
  • tag -- string value of tag to limit results to
  • sdate -- start date to limit results to
  • edate -- end date to limit results to
  • limit -- limit to this number of results
  • format -- output in one of json | xml