Skip to content

Latest commit

 

History

History
754 lines (652 loc) · 58.1 KB

gbfs.md

File metadata and controls

754 lines (652 loc) · 58.1 KB
Raw

General Bikeshare Feed Specification (GBFS)

This document explains the types of files and data that comprise the General Bikeshare Feed Specification (GBFS) and defines the fields used in all of those files.

Reference version

This documentation refers to v3.0-RC (release candidate). For past and upcoming versions see the README.

Table of Contents

Introduction

This specification has been designed with the following concepts in mind:

  • Provide the status of the system at this moment
  • Do not provide information whose primary purpose is historical

The specification supports real-time travel advice in GBFS-consuming applications.

Version Endpoints

The version of the GBFS specification to which a feed conforms is declared in the version field in all files. See Output Format.

GBFS Best Practice defines that:

GBFS producers should provide endpoints that conform to both the current specification long term support (LTS) branch as well as the latest release branch within at least 3 months of a new spec MAJOR or MINOR version release. It is not necessary to support more than one MINOR release of the same MAJOR release group because MINOR releases are backwards-compatible. See specification versioning

GBFS consumers should, at a minimum, support the current LTS branch. It highly recommended that GBFS consumers support later releases.

Default GBFS feed URLs, e.g. https://www.example.com/data/gbfs.json or https://www.example.com/data/fr/system_information.json must direct consumers to the feed that conforms to the current LTS documentation branch.

Term Definitions

This section defines terms that are used throughout this document.

  • JSON - (JavaScript Object Notation) is a lightweight format for storing and transporting data. This document uses many terms defined by the JSON standard, including field, array, and object. (https://www.w3schools.com/js/js_json_datatypes.asp)
  • Field - In JSON, a name/value pair consists of a field name (in double quotes), followed by a colon, followed by a value. (https://www.w3schools.com/js/js_json_syntax.asp)
  • GeoJSON - GeoJSON is a format for encoding a variety of geographic data structures. (https://geojson.org/)
  • Required - The field must be included in the dataset, and a value must be provided in that field for each record.
  • Optional - The field may be omitted from the dataset. If an optional column is included, some of the entries in that field may be empty strings. An omitted field is equivalent to a field that is empty.
  • Conditionally required - The field or file is required under certain conditions, which are outlined in the field or file description. Outside of these conditions, this field or file is optional.

Files

File Name Required Defines
gbfs.json Yes
(as of v2.0)		 Auto-discovery file that links to all of the other files published by the system.
gbfs_versions.json
(added in v1.1)		 Optional Lists all feed endpoints published according to versions of the GBFS documentation.
system_information.json Yes Details including system operator, system location, year implemented, URL, contact info, time zone.
vehicle_types.json
(added in v2.1-RC)		 Conditionally required Describes the types of vehicles that System operator has available for rent. Required of systems that include information about vehicle types in the station_status and/or free_bike_status files. If this file is not included, then all vehicles in the feed are assumed to be non-motorized bicycles.
station_information.json Conditionally required List of all stations, their capacities and locations. Required of systems utilizing docks.
station_status.json Conditionally required Number of available vehicles and docks at each station and station availability. Required of systems utilizing docks.
free_bike_status.json Conditionally required Vehicles that are available for rent. Required of systems that offer vehicles for rent outside of stations.
system_hours.json Optional Hours of operation for the system.
system_calendar.json Optional Dates of operation for the system.
system_regions.json Optional Regions the system is broken up into.
system_pricing_plans.json Optional System pricing scheme.
system_alerts.json Optional Current system alerts.
geofencing_zones.json
(added in v2.1-RC)		 Optional Geofencing zones and their associated rules and attributes.

File Requirements

  • All files should be valid JSON
  • All files in the spec may be published at a URL path or with an alternate name (e.g., station_info instead of station_information.json) (as of v2.0).
  • All data should be UTF-8 encoded
  • Line breaks should be represented by unix newline characters only (\n)
  • Pagination is not supported.

File Distribution

  • If the publisher intends to distribute as individual HTTP endpoints then:
    • Required files must not 404. They should return a properly formatted JSON file as defined in Output Format.
    • Optional files may 404. A 404 of an optional file should not be considered an error.
  • Auto-Discovery:
    • This specification supports auto-discovery.
    • The location of the auto-discovery file will be provided in the HTML area of the shared mobility landing page hosted at the URL specified in the URL field of the system_infomation.json file.
    • This is referenced via a link tag with the following format:
      • <link rel="gbfs" type="application/json" href="https://www.example.com/data/gbfs.json" />
    • References:

Localization

  • Each set of data files should be distributed in a single language as defined in system_information.json.
  • A system that wants to publish feeds in multiple languages should do so by publishing multiple distributions, such as:
    • https://www.example.com/data/en/system_information.json
    • https://www.example.com/data/fr/system_information.json

Field Types

  • Array - A JSON element consisting of an ordered sequence of zero or more values.
  • Object - A JSON element consisting of key-value pairs (fields).
  • Boolean - One of two possible values, trueor false. Boolean values must be JSON booleans, not strings (i.e. true or false, not "true" or "false"). (as of v2.0)
  • Date - Service day in the YYYY-MM-DD format. Example: 2019-09-13 for September 13th, 2019.
  • Time - Service time in the HH:MM:SS format for the time zone indicated in system_information.json (00:00:00 - 47:59:59). Time can stretch up to one additional day in the future to accommodate situations where, for example, a system was open from 11:30pm - 11pm the next day (i.e. 23:30:00-47:00:00).
  • Email - An email address. Example: [email protected]
  • Enum (Enumerable values) - An option from a set of predefined constants in the "Defines" column. Example: The rental_methods field contains values CREDITCARD, PAYPASS, etc...
  • Timestamp - Timestamp fields must be represented as integers in POSIX time. (e.g., the number of seconds since January 1st 1970 00:00:00 UTC)
  • ID - Should be represented as a string that identifies that particular entity. An ID:
    • must be unique within like fields (e.g. station_id must be unique among stations)
    • does not have to be globally unique, unless otherwise specified
    • must not contain spaces
    • should be persistent for a given entity (station, plan, etc). An exception is floating bike bike_id, which should not be persistent for privacy reasons (see free_bike_status.json). (as of v2.0)
  • String - Can only contain text. Strings must not contain any formatting codes (including HTML) other than newlines.
  • Language - An IETF BCP 47 language code. For an introduction to IETF BCP 47, refer to http://www.rfc-editor.org/rfc/bcp/bcp47.txt and http://www.w3.org/International/articles/language-tags/. Examples: en for English, en-US for American English, or de for German.
  • Latitude - WGS84 latitude in decimal degrees. The value must be greater than or equal to -90.0 and less than or equal to 90.0. Example: 41.890169 for the Colosseum in Rome.
  • Longitude - WGS84 longitude in decimal degrees. The value must be greater than or equal to -180.0 and less than or equal to 180.0. Example: 12.492269 for the Colosseum in Rome.
  • Non-negative Integer - An integer greater than or equal to 0.
  • Non-negative Float - A floating point number greater than or equal to 0.
  • Timezone - TZ timezone from the https://www.iana.org/time-zones. Timezone names never contain the space character but may contain an underscore. Refer to http://en.wikipedia.org/wiki/List_of_tz_zones for a list of valid values. Example: Asia/Tokyo, America/Los_Angeles or Africa/Cairo.
  • URI (added in v1.1) - A fully qualified URI that includes the scheme (e.g., com.abcrental.android://), and any special characters in the URI must be correctly escaped. See the following http://www.w3.org/Addressing/URL/4_URI_Recommentations.html for a description of how to create fully qualified URI values. Note that URIs may be URLs.
  • URL - A fully qualified URL that includes http:// or https://, and any special characters in the URL must be correctly escaped. See the following http://www.w3.org/Addressing/URL/4_URI_Recommentations.html for a description of how to create fully qualified URL values.
  • GeoJSON FeatureCollection - A FeatureCollection as described by the IETF RFC 7946 https://tools.ietf.org/html/rfc7946#section-3.3.
  • GeoJSON Multipolygon - A Geometry Object as described by the IETF RFC https://tools.ietf.org/html/rfc7946#section-3.1.7.

Output Format

Every JSON file presented in this specification contains the same common header information at the top level of the JSON response object:

Field Name Required Type Defines
last_updated Yes Timestamp Last time the data in the feed was updated.
ttl Yes Non-negative integer Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
version
(added in v1.1)		 Yes String GBFS version number to which the feed confirms, according to the versioning framework.
data Yes Object Response data in the form of name:value pairs.

Example:

{
  "last_updated": 1434054678,
  "ttl": 3600,
  "version": "2.0",
  "data": {
    "name": "Citi Bike",
    "system_id": "citibike_com"
  }
}

gbfs.json

Field Name Required Type Defines
language Yes Language The language that will be used throughout the rest of the files. It must match the value in the system_information.json file.
- feeds Yes Array An array of all of the feeds that are published by this auto-discovery file. Each element in the array is an object with the keys below.
 - name Yes String Key identifying the type of feed this is. The key must be the base file name defined in the spec for the corresponding feed type (system_information for system_information.json file, station_information for station_information.json file).
 - url Yes URL URL for the feed. Note that the actual feed endpoints (urls) may not be defined in the file_name.json format. For example, a valid feed endpoint could end with station_info instead of station_information.json.

Example:

{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "2.0",
  "data": {
    "en": {
      "feeds": [
        {
          "name": "system_information",
          "url": "https://www.example.com/gbfs/1/en/system_information"
        },
        {
          "name": "station_information",
          "url": "https://www.example.com/gbfs/1/en/station_information"
        }
      ]
    },
    "fr" : {
      "feeds": [
        {
          "name": "system_information",
          "url": "https://www.example.com/gbfs/1/fr/system_information"
        },
        {
          "name": "station_information",
          "url": "https://www.example.com/gbfs/1/fr/station_information"
        }
      ]
    }
  }
}

gbfs_versions.json (added in v1.1)

Each expression of a GBFS feed describes all of the versions that are available.

The following fields are all attributes within the main "data" object for this feed.

Field Name Required Type Defines
versions Yes Array Contains one object, as defined below, for each of the available versions of a feed. The array must be sorted by increasing MAJOR and MINOR version number.
- version Yes String The semantic version of the feed in the form X.Y.
- url Yes URL URL of the corresponding gbfs.json endpoint. 
{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "2.0",
  "data": {
    "versions": [
      {
        "version":"1.0",
        "url":"https://www.example.com/gbfs/1/gbfs"
      },
      {
        "version":"2.0",
        "url":"https://www.example.com/gbfs/2/gbfs"
      }
    ]
  }
}

system_information.json

The following fields are all attributes within the main "data" object for this feed.

Field Name Required Type Defines
system_id Yes ID Identifier for this vehicle share system. This should be globally unique (even between different systems) - for example, bcycle_austin or biketown_pdx. It is up to the publisher of the feed to guarantee uniqueness. This value is intended to remain the same over the life of the system.
language Yes Language The language that will be used throughout the rest of the files. It must match the value in the gbfs.json file.
name Yes String Name of the system to be displayed to customers.
short_name Optional String Optional abbreviation for a system.
operator Optional String Name of the operator.
url Optional URL The URL of the vehicle share system.
purchase_url Optional URL URL where a customer can purchase a membership.
start_date Optional Date Date that the system began operations.
phone_number Optional Phone Number A single voice telephone number for the specified system that presents the telephone number as typical for the system's service area. It can and should contain punctuation marks to group the digits of the number. Dialable text (for example, Capital Bikeshare’s "877-430-BIKE") is permitted, but the field must not contain any other descriptive text.
email Optional Email Email address actively monitored by the operator’s customer service department. This email address should be a direct contact point where riders can reach a customer service representative.
feed_contact_email
(added in v1.1)		 Optional Email A single contact email address for consumers of this feed to report technical issues.
timezone Yes Timezone The time zone where the system is located.
license_id
(added in v3.0-RC)		 Conditionally required String Required if the dataset is provided under a standard license. An identifier for a standard license from the SPDX License List. Provide license_id rather than license_url if the license is included in the SPDX License List. See the GBFS wiki for a comparison of a subset of standard licenses. If the license_id and license_url fields are blank or omitted, this indicates that the feed is provided under the Creative Commons Universal Public Domain Dedication.
license_url Conditionally required
(as of v3.0-RC)		 URL Required if the dataset is provided under a customized license. A fully qualified URL of a page that defines the license terms for the GBFS data for this system. Do not specify a license_url if license_id is specified. If the license_id and license_url fields are blank or omitted, this indicates that the feed is provided under the Creative Commons Universal Public Domain Dedication. (as of v3.0-RC)
attribution_organization_name
(added in v3.0-RC)		 Optional String If the feed license requires attribution, name of the organization to which attribution should be provided.
attribution_url
(added in v3.0-RC)		 Optional URL URL of the organization to which attribution should be provided.
rental_apps
(added in v1.1)		 Optional Object Contains rental app information in the android and ios JSON objects.
- android
(added in v1.1)		 Optional Object Contains rental app download and app discovery information for the Android platform in the store_uri and discovery_uri fields. See examples of how to use these fields and supported analytics.
 - store_uri
(added in v1.1)		 Conditionally Required URI URI where the rental Android app can be downloaded from. Typically this will be a URI to an app store such as Google Play. If the URI points to an app store such as Google Play, the URI should follow Android best practices so the viewing app can directly open the URI to the native app store app instead of a website.

If a rental_uris.android field is populated then this field is required, otherwise it is optional.

See the Analytics section for how viewing apps can report the origin of the deep link to rental apps.

Example value: https://play.google.com/store/apps/details?id=com.abcrental.android
 - discovery_uri
(added in v1.1)		 Conditionally Required URI URI that can be used to discover if the rental Android app is installed on the device (e.g., using PackageManager.queryIntentActivities()). This intent is used by viewing apps prioritize rental apps for a particular user based on whether they already have a particular rental app installed.

This field is required if a rental_uris.android field is populated, otherwise it is optional.

Example value: com.abcrental.android://
- ios
(added in v1.1)		 Optional Object Contains rental information for the iOS platform in the store_uri and discovery_uri fields. See examples of how to use these fields and supported analytics.
 - store_uri
(added in v1.1)		 Conditionally Required URI URI where the rental iOS app can be downloaded from. Typically this will be a URI to an app store such as the Apple App Store. If the URI points to an app store such as the Apple App Store, the URI should follow iOS best practices so the viewing app can directly open the URI to the native app store app instead of a website.

If a rental_uris.ios field is populated then this field is required, otherwise it is optional.

See the Analytics section for how viewing apps can report the origin of the deep link to rental apps.

Example value: https://apps.apple.com/app/apple-store/id123456789
 - discovery_uri
(added in v1.1)		 Conditionally Required URI URI that can be used to discover if the rental iOS app is installed on the device (e.g., using UIApplication canOpenURL:). This intent is used by viewing apps prioritize rental apps for a particular user based on whether they already have a particular rental app installed.

This field is required if a rental_uris.ios field is populated, otherwise it is optional.

Example value: com.abcrental.ios://

vehicle_types.json (added in v2.1-RC)

The following fields are all attributes within the main "data" object for this feed.

Field Name Required Type Defines
vehicle_types Yes Array Array that contains one object per vehicle type in the system as defined below.
- vehicle_type_id Yes ID Unique identifier of a vehicle type. See Field Types above for ID field requirements.
- form_factor Yes Enum The vehicle's general form factor.

Current valid values are:
  • bicycle
  • car
  • moped
  • other
  • scooter
- propulsion_type Yes Enum The primary propulsion type of the vehicle.

Current valid values are:
  • human (Pedal or foot propulsion)
  • electric_assist (Provides power only alongside human propulsion)
  • electric (Contains throttle mode with a battery-powered motor)
  • combustion (Contains throttle mode with a gas engine-powered motor)
This field was inspired by, but differs from the propulsion types field described in the Open Mobility Foundation Mobility Data Specification.
- max_range_meters Conditionally Required Non-negative float If the vehicle has a motor (as indicated by having a value other than human in the propulsion_type field), this field is required. This represents the furthest distance in meters that the vehicle can travel without recharging or refueling when it has the maximum amount of energy potential (for example, a full battery or full tank of gas).
- name Optional String The public name of this vehicle type.

Example:

{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "3.0",
  "data": {
    "vehicle_types": [
      {
        "vehicle_type_id": "abc123",
        "form_factor": "bicycle",
        "propulsion_type": "human",
        "name": "Example Basic Bike"
      },
      {
        "vehicle_type_id": "def456",
        "form_factor": "scooter",
        "propulsion_type": "electric",
        "name": "Example E-scooter V2",
        "max_range_meters": 12345
      },
      {
        "vehicle_type_id": "car1",
        "form_factor": "car",
        "propulsion_type": "combustion",
        "name": "Foor-door Sedan",
        "max_range_meters": 523992
      }
    ]
  }
}

station_information.json

All stations included in station_information.json are considered public (e.g., can be shown on a map for public use). If there are private stations (such as Capital Bikeshare’s White House station), these should not be included here.

Field Name Required Type Defines
stations Yes Array Array that contains one object per station as defined below.
- station_id Yes ID Identifier of a station.
- name Yes String Public name of the station.
- short_name Optional String Short name or other type of identifier.
- lat Yes Latitude The latitude of station.
- lon Yes Longitude The longitude of station.
- address Optional String Address (street number and name) where station is located. This must be a valid address, not a free-form text description (see "cross_street" below).
- cross_street Optional String Cross street or landmark where the station is located.
- region_id Optional ID Identifier of the region where station is located. See system_regions.json.
- post_code Optional String Postal code where station is located.
- rental_methods Optional Array Payment methods accepted at this station.
Current valid values are:
  • KEY (e.g. operator issued vehicle key / fob / card)
  • CREDITCARD
  • PAYPASS
  • APPLEPAY
  • ANDROIDPAY
  • TRANSITCARD
  • ACCOUNTNUMBER
  • PHONE
- is_virtual_station
(added in v2.1-RC)		 Optional Boolean Is this station a location with or without physical infrastructures (docks)?

true - The station is a location without physical infrastructure, defined by a point (lat/lon) and/or station_area (below).
false - The station consists of physical infrastructure (docks).

If this field is empty, it means the station consists of physical infrastructure (docks).
- station_area
(added in v2.1-RC)		 Optional GeoJSON Multipolygon A multipolygon that describes the area of a virtual station. If station_area is supplied then the record describes a virtual station.

If lat/lon and 'station_area' are both defined, the lat/lon is the significant coordinate of the station (e.g. dock facility or valet drop-off and pick up point).
- capacity Optional Non-negative integer Number of total docking points installed at this station, both available and unavailable, regardless of what vehicle types are allowed at each dock. Empty indicates unlimited capacity.
- vehicle_capacity
(added in v2.1-RC)		 Optional ID An object where each key is a vehicle_type_id as described in vehicle_types.json and the value is a number representing the total number of vehicles of this type that can park within the area defined in the station_area field. If the field station_area is defined and a particular vehicle type id is not defined in this object, then an unlimited virtual capacity is assumed for that vehicle type.
- is_valet_station
(added in v2.1-RC)		 Optional Boolean Are valet services provided at this station?

true - Valet services are provided at this station.
false - Valet services are not provided at this station.

If this field is empty, it means valet services are not provided at this station.
- rental_uris
(added in v1.1)		 Optional Object Contains rental URIs for Android, iOS, and web in the android, ios, and web fields. See examples of how to use these fields and supported analytics.
 - android
(added in v1.1)		 Optional URI URI that can be passed to an Android app with an android.intent.action.VIEW Android intent to support Android Deep Links (https://developer.android.com/training/app-links/deep-linking). Please use Android App Links (https://developer.android.com/training/app-links) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed.

This URI should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application.

If this field is empty, it means deep linking isn’t supported in the native Android rental app.

Note that URIs do not necessarily include the station_id for this station - other identifiers can be used by the rental app within the URI to uniquely identify this station.

See the Analytics section for how viewing apps can report the origin of the deep link to rental apps.

Android App Links example value: https://www.abc.com/app?sid=1234567890&platform=android

Deep Link (without App Links) example value: com.abcrental.android://open.abc.app/app?sid=1234567890
 - ios
(added in v1.1)		 Optional URI URI that can be used on iOS to launch the rental app for this station. More information on this iOS feature can be found here. Please use iOS Universal Links (https://developer.apple.com/ios/universal-links/) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed.

This URI should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application.

If this field is empty, it means deep linking isn’t supported in the native iOS rental app.

Note that the URI does not necessarily include the station_id - other identifiers can be used by the rental app within the URL to uniquely identify this station.

See the Analytics section for how viewing apps can report the origin of the deep link to rental apps.

iOS Universal Links example value: https://www.abc.com/app?sid=1234567890&platform=ios

Deep Link (without Universal Links) example value: com.abcrental.ios://open.abc.app/app?sid=1234567890
 - web
(added in v1.1)		 Optional URL URL that can be used by a web browser to show more information about renting a vehicle at this station.

This URL should be a deep link specific to this station, and should not be a general rental page that includes information for more than one station. The deep link should take users directly to this station, without any prompts, interstitial pages, or logins. Make sure that users can see this station even if they never previously opened the application.

If this field is empty, it means deep linking isn’t supported for web browsers.

Example value: https://www.abc.com/app?sid=1234567890
- vehicle_type_capacity
(added in v2.1-RC)		 Optional Object An object where each key is a vehicle_type_id as described in vehicle_types.json and the value is a number representing the total docking points installed at this station, both available and unavailable for the specified vehicle type.

Example:

{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "3.0",
  "data": {
    "stations": [
      {
        "station_id": "pga",
        "name": "Parking garage A",
        "lat": 12.34,
        "lon": 45.67,
        "vehicle_type_capacity": {
          "abc123": 7,
          "def456": 9
        }
      }
    ]
  }
}

station_status.json

Describes the capacity and rental availability of a station.

Field Name Required Type Defines
stations Yes Array Array that contains one object per station in the system as defined below.
- station_id Yes ID Identifier of a station see station_information.json.
- num_bikes_available Yes Non-negative integer Number of vehicles of any type available for rental. Number of functional vehicles physically at the station. To know if the vehicles are available for rental, see is_renting.
- num_bikes_disabled Optional Non-negative integer Number of disabled vehicles of any type at the station. Vendors who do not want to publicize the number of disabled vehicles or docks in their system can opt to omit station capacity (in station_information), num_bikes_disabled and num_docks_disabled (as of v2.0). If station capacity is published, then broken docks/vehicles can be inferred (though not specifically whether the decreased capacity is a broken vehicle or dock).
- num_docks_available Conditionally required
(as of v2.0)		 Non-negative integer Required except for stations that have unlimited docking capacity (e.g. virtual stations) (as of v2.0). Number of functional docks physically at the station. To know if the docks are accepting vehicle returns, see is_returning.
- num_docks_disabled Optional Non-negative integer Number of empty but disabled dock points at the station.
- is_installed Yes Boolean Is the station currently on the street?

true - Station is installed on the street.
false - Station is not installed on the street.
- is_renting Yes Boolean Is the station currently renting vehicles?

true - Station is renting vehicles. Even if the station is empty, if it is set to allow rentals this value should be true.
false - Station is not renting vehicles.
- is_returning Yes Boolean Is the station accepting vehicle returns?

true - Station is accepting vehicle returns. If a station is full but would allow a return if it was not full, then this value should be true.
false - Station is not accepting vehicle returns.
- last_reported Yes Timestamp The last time this station reported its status to the operator's backend.
- vehicle_docks_available
(added in v2.1-RC)		 Conditionally Required Array This field is required in feeds where the vehicle_types.json is defined and where certain docks are only able to accept certain vehicle types. If every dock at the station is able to accept any vehicle type, then this field is not required. This field's value is an array of objects. Each of these objects is used to model the number of docks available for certain vehicle types. The total number of docks from each of these objects should add up to match the value specified in the num_docks_available field.
 - vehicle_type_ids
(added in v2.1-RC)		 Yes Array of Strings An array of strings where each string represents a vehicle_type_id that is able to use a particular type of dock at the station
 - count
(added in v2.1-RC)		 Yes Non-negative integer A number representing the total number of available docks at the station that can accept vehicles of the specified types in the vehicle_types array.
- vehicles
(added in v2.1-RC)		 Conditionally Required Array This field is required if the vehicle_types.json file has been defined. This field's value is an array of objects. Each object contains data about a specific vehicle that is currently present at the docking station. Each of these vehicles is assumed to be rentable unless otherwise indicated with the is_reserved or is_disabled flags. All of the remaining fields in this table represent key/values for each vehicle object in this array. The length of this array must equal the value of the num_bikes_available field.
 - bike_id
(added in v2.1-RC)		 Yes ID Identifier of a vehicle, rotated to a random string, at minimum, after each trip to protect privacy (as of v2.0). Note: Persistent bike_id, published publicly, could pose a threat to individual traveler privacy.
 - is_reserved
(added in v2.1-RC)		 Yes Boolean Is the vehicle currently reserved for someone else
 - is_disabled
(added in v2.1-RC)		 Yes Boolean Is the vehicle currently disabled (broken)
 - vehicle_type_id
(added in v2.1-RC)		 Yes ID The vehicle_type_id of this vehicle as described in vehicle_types.json.
 - current_range_meters
(added in v2.1-RC)		 Conditionally Required Non-negative float If the corresponding vehicle_type definition for this vehicle has a motor, then this field is required. This value represents the furthest distance in meters that the vehicle can travel without recharging or refueling with the vehicle's current charge or fuel.

Example:

{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "3.0",
  "data": {
    "stations": [
      {
        "station_id": "station 1",
        "is_installed": true,
        "is_renting": true,
        "is_returning": true,
        "last_reported": 1434054678,
        "num_docks_available": 3,
        "vehicles": [{
          "bike_id": "mno345",
          "is_reserved": false,
          "is_disabled": false,
          "vehicle_type_id": "abc123"
        }, {
          "bike_id": "pqr678",
          "is_reserved": false,
          "is_disabled": false,
          "vehicle_type_id": "def456",
          "current_range_meters": 5432
        }],
        "vehicle_docks_available": [{
          "vehicle_type_ids": ["abc123"],
          "count": 2
        }, {
          "vehicle_type_ids": ["def456"],
          "count": 1
        }]
      }, {
        "station_id": "station 2",
        "is_installed": true,
        "is_renting": true,
        "is_returning": true,
        "last_reported": 1434054678,
        "num_docks_available": 8,
        "vehicles": [{
          "bike_id": "stu901",
          "is_reserved": false,
          "is_disabled": false,
          "vehicle_type_id": "abc123"
        }, {
          "bike_id": "vwx234",
          "is_reserved": false,
          "is_disabled": false,
          "vehicle_type_id": "def456",
          "current_range_meters": 4321
        }]
      }
    ]
  }
}

free_bike_status.json

Describes vehicles that are not at a station and are not currently in the middle of an active ride.

Field Name Required Type Defines
bikes Yes Array Array that contains one object per vehicle that is currently stopped as defined below.
- bike_id Yes ID Identifier of a vehicle, rotated to a random string, at minimum, after each trip to protect privacy (as of v2.0). Note: Persistent bike_id, published publicly, could pose a threat to individual traveler privacy.
- system_id
(added in v3.0-RC)		 Conditionally required ID Identifier referencing the system_id field in system_information.json. Required in the case of feeds that specify free (undocked) bikes and define systems in system_information.json.
- lat Yes Latitude Latitude of the vehicle.
- lon Yes Longitude Longitude of the vehicle.
- is_reserved Yes Boolean Is the vehicle currently reserved?

true - Vehicle is currently reserved.
false - Vehicle is not currently reserved.
- is_disabled Yes Boolean Is the vehicle currently disabled (broken)?

true - Vehicle is currently disabled.
false - Vehicle is not currently disabled.
- rental_uris
(added in v1.1)		 Optional Object JSON object that contains rental URIs for Android, iOS, and web in the android, ios, and web fields. See examples of how to use these fields and supported analytics.
 - android
(added in v1.1)		 Optional URI URI that can be passed to an Android app with an android.intent.action.VIEW Android intent to support Android Deep Links (https://developer.android.com/training/app-links/deep-linking). Please use Android App Links (https://developer.android.com/training/app-links) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed.

This URI should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations.

If this field is empty, it means deep linking isn’t supported in the native Android rental app.

Note that URIs do not necessarily include the bike_id for this vehicle - other identifiers can be used by the rental app within the URI to uniquely identify this vehicle.

See the Analytics section for how viewing apps can report the origin of the deep link to rental apps.

Android App Links example value: https://www.abc.com/app?sid=1234567890&platform=android

Deep Link (without App Links) example value: com.abcrental.android://open.abc.app/app?sid=1234567890
 - ios
(added in v1.1)		 Optional URI URI that can be used on iOS to launch the rental app for this vehicle. More information on this iOS feature can be found here. Please use iOS Universal Links (https://developer.apple.com/ios/universal-links/) if possible so viewing apps don’t need to manually manage the redirect of the user to the app store if the user doesn’t have the application installed.

This URI should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations.

If this field is empty, it means deep linking isn’t supported in the native iOS rental app.

Note that the URI does not necessarily include the bike_id - other identifiers can be used by the rental app within the URL to uniquely identify this vehicle.

See the Analytics section for how viewing apps can report the origin of the deep link to rental apps.

iOS Universal Links example value: https://www.abc.com/app?sid=1234567890&platform=ios

Deep Link (without Universal Links) example value: com.abcrental.ios://open.abc.app/app?sid=1234567890
 - web
(added in v1.1)		 Optional URL URL that can be used by a web browser to show more information about renting a vehicle at this vehicle.

This URL should be a deep link specific to this vehicle, and should not be a general rental page that includes information for more than one vehicle. The deep link should take users directly to this vehicle, without any prompts, interstitial pages, or logins. Make sure that users can see this vehicle even if they never previously opened the application. Note that as a best practice providers should rotate identifiers within deep links after each rental to avoid unintentionally exposing private vehicle trip origins and destinations.

If this field is empty, it means deep linking isn’t supported for web browsers.

Example value: https://www.abc.com/app?sid=1234567890
- vehicle_type_id
(added in v2.1-RC)		 Conditionally Required ID The vehicle_type_id of this vehicle as described in vehicle_types.json. This field is required if the vehicle_types.json is defined.
- last_reported
(added in v2.1-RC)		 Optional Timestamp The last time this vehicle reported its status to the operator's backend.
- current_range_meters
(added in v2.1-RC)		 Conditionally Required Non-negative float If the corresponding vehicle_type definition for this vehicle has a motor, then this field is required. This value represents the furthest distance in meters that the vehicle can travel without recharging or refueling with the vehicle's current charge or fuel.

Example:

{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "3.0",
  "data": {
    "bikes": [
      {
        "bike_id": "ghi789",
        "last_reported": 1434054678,
        "lat": 12.34,
        "lon": 56.78,
        "is_reserved": false,
        "is_disabled": false,
        "vehicle_type_id": "abc123"
      }, {
        "bike_id": "jkl012",
        "last_reported": 1434054687,
        "lat": 12.34,
        "lon": 56.78,
        "is_reserved": false,
        "is_disabled": false,
        "vehicle_type_id": "def456",
        "current_range_meters": 6543
      }
    ]
  }
}

system_hours.json

Describes the system hours of operation.

Field Name Required Type Defines
rental_hours Yes Array Array of objects as defined below. The array must contain a minimum of one object identifying hours for every day of the week or a maximum of two for each day of the week objects ( one for each user type).
- user_types Yes Array An array of member and/or nonmember value(s). This indicates that this set of rental hours applies to either members or non-members only.
- days Yes Array An array of abbreviations (first 3 letters) of English names of the days of the week for which this object applies (e.g. ["mon", "tue", "wed", "thu", "fri", "sat, "sun"]). Rental hours must not be defined more than once for each day and user type.
- start_time Yes Time Start time for the hours of operation of the system in the time zone indicated in system_information.json.
- end_time Yes Time End time for the hours of operation of the system in the time zone indicated in system_information.json.

Example:

{
  "last_updated": 1434054678,
  "ttl": 0,
  "version": "2.0",
  "data": {
    "rental_hours": [
      {
        "user_types": [ "member" ],
        "days": ["sat", "sun"],
        "start_time": "00:00:00",
        "end_time": "23:59:59"
      },
      {
        "user_types": [ "nonmember" ],
        "days": ["sat", "sun"],
        "start_time": "05:00:00",
        "end_time": "23:59:59"
      },
      {
        "user_types": [ "member", "nonmember" ],
        "days": ["mon", "tue", "wed", "thu", "fri"],
        "start_time": "00:00:00",
        "end_time": "23:59:59"
      }
    ]
  }
}

system_calendar.json

Describes the operating calendar for a system.

Field Name Required Type Defines
calendars Yes Array Array of objects describing the system operational calendar. A minimum of one calendar object is required. If start and end dates are the same every year, then start_year and end_year should be omitted.
- start_month Yes Non-negative Integer Starting month for the system operations (1-12).
- start_day Yes Non-negative Integer Starting date for the system operations (1-31).
- start_year Optional Non-negative Integer Starting year for the system operations.
- end_month Yes Non-negative Integer Ending month for the system operations (1-12).
- end_day Yes Non-negative Integer Ending date for the system operations (1-31).
- end_year Optional Non-negative Integer Ending year for the system operations.

system_regions.json

Describe regions for a system that is broken up by geographic or political region.

Field Name Required Type Defines
regions Yes Array Array of objects as defined below.
- region_id Yes ID Identifier for the region.
- name Yes String Public name for this region.

system_pricing_plans.json

Describes pricing for the system.

Field Name Required Type Defines
plans Yes Array Array of objects as defined below.
- plan_id Yes ID Identifier for a pricing plan in the system.
- url Optional URL URL where the customer can learn more about this pricing plan.
- name Yes String Name of this pricing plan.
- currency Yes String Currency used to pay the fare.

This pricing is in ISO 4217 code: http://en.wikipedia.org/wiki/ISO_4217
(e.g. CAD for Canadian dollars, EUR for euros, or JPY for Japanese yen.)
- price Yes Non-negative float OR String Fare price, in the unit specified by currency. If String, must be in decimal monetary value.
- is_taxable Yes Boolean Will additional tax be added to the base price?

true - Yes.
false - No.

false may be used to indicate that tax is not charged or that tax is included in the base price.
- description Yes String Customer-readable description of the pricing plan. This should include the duration, price, conditions, etc. that the publisher would like users to see.

system_alerts.json

This feed is intended to inform customers about changes to the system that do not fall within the normal system operations. For example, system closures due to weather would be listed here, but a system that only operated for part of the year would have that schedule listed in the system_calendar.json feed.
Obsolete alerts should be removed so the client application can safely present to the end user everything present in the feed.

Field Name Required Type Defines
alerts Yes Array Array of objects each indicating a system alert as defined below.
- alert_id Yes ID Identifier for this alert.
- type Yes Enum Valid values are:

  • SYSTEM_CLOSURE
  • STATION_CLOSURE
  • STATION_MOVE
  • OTHER
- times Optional Array Array of objects with the fields start and end indicating when the alert is in effect (e.g. when the system or station is actually closed, or when it is scheduled to be moved).
 - start Yes Timestamp Start time of the alert.
 - end Optional Timestamp End time of the alert. If there is currently no end time planned for the alert, this can be omitted.
- station_ids Optional Array If this is an alert that affects one or more stations, include their ID(s). Otherwise omit this field. If both station_id and region_id are omitted, this alert affects the entire system.
- region_ids Optional Array If this system has regions, and if this alert only affects certain regions, include their ID(s). Otherwise, omit this field. If both station_ids and region_ids are omitted, this alert affects the entire system.
- url Optional URL URL where the customer can learn more information about this alert.
- summary Yes String A short summary of this alert to be displayed to the customer.
- description Optional String Detailed description of the alert.
- last_updated Optional Timestamp Indicates the last time the info for the alert was updated.

geofencing_zones.json (added in v2.1-RC)

Describes geofencing zones and their associated rules and attributes.
By default, no restrictions apply everywhere. Geofencing zones should be modeled according to restrictions rather than allowance. An operational area (outside of which vehicles cannot be used) should be defined with a counterclockwise polygon, and a limitation area (in which vehicles can be used under certain restrictions) should be defined with a clockwise polygon.

Field Name Required Type Defines
geofencing_zones Yes GeoJSON FeatureCollection Each geofenced zone and its associated rules and attributes is described as an object within the array of features, as follows.
- type Yes String “FeatureCollection” (as per IETF RFC 7946).
- features Yes Array Array of objects as defined below.
 - type Yes String “Feature” (as per IETF RFC 7946).
 - geometry Yes GeoJSON Multipolygon A polygon that describes where rides might not be able to start, end, go through, or have other limitations. A clockwise arrangement of points defines the area enclosed by the polygon, while a counterclockwise order defines the area outside the polygon (right-hand rule). All geofencing zones contained in this list are public (i.e., can be shown on a map for public use).
 - properties Yes Object Properties: As defined below, describing travel allowances and limitations.
  - name Optional String Public name of the geofencing zone.
  - start Optional Timestamp Start time of the geofencing zone. If the geofencing zone is always active, this can be omitted.
  - end Optional Timestamp End time of the geofencing zone. If the geofencing zone is always active, this can be omitted.
  - rules Optional Array Array that contains one object per rule as defined below.

In the event of colliding rules within the same polygon, the earlier rule (in order of the JSON file) takes precedence.
In the case of overlapping polygons, the combined set of rules associated with the overlapping polygons applies to the union of the polygons. In the event of colliding rules in this set, the earlier rule (in order of the JSON file) also takes precedence.
   - vehicle_type_id Optional Array Array of IDs of vehicle types for which any restrictions should be applied (see vehicle type definitions in PR #136). If vehicle_type_ids are not specified, then restrictions apply to all vehicle types.
   - ride_allowed Required Boolean Is the undocked (“free bike”) ride allowed to start and end in this zone?

true - Undocked (“free bike”) ride can start and end in this zone.
false - Undocked (“free bike”) ride cannot start and end in this zone.
   - ride_through_allowed Required Boolean Is the ride allowed to travel through this zone?

true - Ride can travel through this zone.
false - Ride cannot travel through this zone.
   - maximum_speed_kph Optional Non-negative Integer What is the maximum speed allowed, in kilometers per hour?

If there is no maximum speed to observe, this can be omitted.

Deep Links (added in v1.1)

Deep links to iOS, Android, and web apps are supported via URIs in the system_information.json, station_information.json, and free_bike_status.json files. The following sections describe how analytics can be added to these URIs, as well as some examples.

Analytics (added in v1.1)

In all of the rental URI fields, a viewing app can report the origin of a deep link to request to a rental app by appending the client_id (added in v1.1) parameter to the URI along with the domain name for the viewing app.

For example, if Google is the viewing app, it can append:

client_id=google.com

...to the URI field to report that Google is the originator of the deep link request. If the Android URI is:

com.abcrental.android://open.abc.app/stations?id=1234567890

...then the URI used by Google would be: com.abcrental.android://open.abc.app/stations?id=1234567890&client_id=google.com

Other supported parameters include:

  1. ad_id (added in v1.1) - Advertising ID issued to the viewing app (e.g., IFDA on iOS)
  2. token (added in v1.1) - A token identifier that was issued by the rental app to the viewing app.

Examples (added in v1.1)

Example 1 - App Links on Android and Universal Links on iOS are supported:

system_information.json

{
  "last_updated": 1572447999,
  "data": {
  "system_id": "abc_cityname",
  "short_name": "ABC Bike Rental",
  "rental_apps": {
    "android": {
      "discovery_uri": "com.abcrental.android://"
    },
    "ios": {
      "discovery_uri": "com.abcrental.ios://"
    }
  }
  ...

station_information.json

"stations": [
  {
    "station_id": "425",
    "name": "Coppertail",
    "lat": 27.9563335328521,
    "lon": -82.430436084371,
    "rental_uris": {
      "android": "https://www.abc.com/app?sid=1234567890&platform=android",
      "ios": "https://www.abc.com/app?sid=1234567890&platform=ios"
    }
  },
  ...

Note that the Android URI and iOS Universal Link URLs don’t necessarily use the same identifier as the station_id.

Example 2 - App Links are not supported on Android and Universal Links are not supported on iOS, but deep links are still supported on Android and iOS:

system_information.json

{
  "last_updated": 1572447999,
  "data": {
    "system_id": "abc_cityname",
    "short_name": "ABC Bike Rental",
    "rental_apps": {
      "android": {
        "discovery_uri": "com.abcrental.android://"
        "store_uri": "https://play.google.com/store/apps/details?id=com.abcrental.android",
      },
      "ios": {
        "store_uri": "https://apps.apple.com/app/apple-store/id123456789",
        "discovery_uri": "com.abcrental.ios://"
      }
    },
    ...

station_information.json

"stations": [
  {
    "station_id": "425",
    "name": "Coppertail",
    "lat": 27.9563335328521,
    "lon": -82.430436084371,
    "rental_uris": {
      "android": "com.abcrental.android://open.abc.app/app?sid=1234567890",
      "ios": "com.abcrental.ios://open.abc.app/app?sid=1234567890"
    }
  },
  ...

Example 3 - Deep link web URLs are supported, but not Android or iOS native apps:

station_information.json

"stations": [
  {
    "station_id":"425",
    "name":"Coppertail",
    "lat":27.9563335328521,
    "lon":-82.430436084371,
    "rental_uris": {
      "web":"https://www.abc.com/app?sid=1234567890",
    }
  },
  ...

Disclaimers

Apple Pay, PayPass and other third-party product and service names are trademarks or registered trademarks of their respective owners.

License

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License.