Swagger UI

Publibike APIs 
1.0.0
 
OAS3

PubliBike APIs

Terms of service
Send email to PubliBike AG
Contact PubliBike AG for license information

Stations

Use case: display the location of the stations on a map and whether or not bikes are available.
To fetch more details of a specific station use /public/stations/{id}

Parameters

No parameters

Responses

Code Description Links
200

An array of stations

Media type
Controls Accept header.
[ {
description:

Overview of a station to be displayed on map

id * integer ($int32)

Technical station id

latitude * number ($double)

Latitude of the station

longitude * number ($double)

Longitude of the station

state * {
description:

Representation of a state.

id * integer ($int32)

Technical state id

name * string

Translated human-readable state name

}
} ]
No links

Returns detailed information about a specific station and the vehicles currently at this station.
If the information of multiple stations is required, consider using /public/partner/stations

Parameters

Name Description
id  *
integer ($int32)
(path)

The station id

Responses

Code Description Links
200

Station details

Media type
Controls Accept header.
{
description:

Station with current available vehicles. The id of the state is an enumeration, e.g. {1: active, 2: inactive, ...}

id * integer ($int32)

Technical station id

latitude * number ($double)

Latitude of the station

longitude * number ($double)

Longitude of the station

state * {
description:

Representation of a state.

id * integer ($int32)

Technical state id

name * string

Translated human-readable state name

}
name * string

Public name of the station

address string

Station address without the city

zip string

Zip code of the station

city string

City of the station

vehicles [

All vehicles that are currently available at this station

{
description:

Representation of a vehicle

id * integer ($int32)

Technical vehicle id

name * string

Vehicle number visible to the user

ebike_battery_level number ($double)
maximum: 100
exclusiveMaximum: false
minimum: 0
exclusiveMinimum: false

E-Bike battery level in percent. The e-bike battery level is between 0 and 100. If the value is missing it is either not an e-bike or the battery level is unknown.

type * {
description:

Representation of a type.

id * integer ($int32)

Technical type id

name * string

Translated human-readable type name

}
} ]
network {
description:

Representation of a network

id * integer ($int32)

Technical station id

name * string

Translated network name

background_img string

Background image for app (language specific)

logo_img string

Logo of the network (language specific)

sponsors [

An array of sponsors for this network

{
description:

Represents a sponsor item containing an image and link (translated).

id integer ($int32)

Technical sponsor id.

name string

Name of the sponsor.

image string

Logo of the sponsor.

url string

URL to sponsor website.

} ]
}
sponsors [

An array of sponsors of this station

{
description:

Represents a sponsor item containing an image and link (translated).

id integer ($int32)

Technical sponsor id.

name string

Name of the sponsor.

image string

Logo of the sponsor.

url string

URL to sponsor website.

} ]
}
No links
404

Station not found

No links

Delivers all visible PubliBike stations including all the vehicles currently at a station.
Use case: Use this endpoint to repeatedly fetch all stations and vehicles. Fetch interval: not more often than every minute.
In case of showing a map with clickable POIs consider using the endpoint /public/stations to fetch the station locations and /public/stations/{id} for requesting the details when a user clicks on the station POI.

Parameters

No parameters

Responses

Code Description Links
200

Information of all the stations

Media type
Controls Accept header.
{
description:

Container for stations and their vehicles.

stations * [ {
description:

Overview of a single station and it's vehicles

id * integer ($int32)

Technical station id

latitude * number ($double)

Latitude of the station

longitude * number ($double)

Longitude of the station

state * {
description:

Representation of a state.

id * integer ($int32)

Technical state id

name * string

Translated human-readable state name

}
name * string

Public name of the station

address string

Station address without the city

zip string

Zip code of the station

city string

City of the station

vehicles [

All vehicles that are currently available at this station

{
description:

Representation of a vehicle

id * integer ($int32)

Technical vehicle id

name * string

Vehicle number visible to the user

ebike_battery_level number ($double)
maximum: 100
exclusiveMaximum: false
minimum: 0
exclusiveMinimum: false

E-Bike battery level in percent. The e-bike battery level is between 0 and 100. If the value is missing it is either not an e-bike or the battery level is unknown.

type * {
description:

Representation of a type.

id * integer ($int32)

Technical type id

name * string

Translated human-readable type name

}
} ]
network {
description:

Representation of a network

id * integer ($int32)

Technical station id

name * string

Translated network name

background_img string

Background image for app (language specific)

logo_img string

Logo of the network (language specific)

sponsors [

An array of sponsors for this network

{
description:

Represents a sponsor item containing an image and link (translated).

id integer ($int32)

Technical sponsor id.

name string

Name of the sponsor.

image string

Logo of the sponsor.

url string

URL to sponsor website.

} ]
}
sponsors [

An array of sponsors of this station

{
description:

Represents a sponsor item containing an image and link (translated).

id integer ($int32)

Technical sponsor id.

name string

Name of the sponsor.

image string

Logo of the sponsor.

url string

URL to sponsor website.

} ]
is_virtual_station boolean

Marks the station as virtual according to the requirements of the General Bikeshare Feed Specification (GBFS) https://github.com/NABSA/gbfs/blob/v2.2/gbfs.md#station_informationjson , a virtual station does not consist of physical infrastructure (docks) but is defined e.g. via geolocation

capacity integer ($int32)

The maximum number of bikes a station is able to accommodate. This is not a hard limit but can be used for displaying purposes.

} ]
}
No links