Urban Sharing - Predictions API (1.0.0)

Download OpenAPI specification:

Urban Sharing Support: info@urbansharing.com URL: https://www.urbansharing.com

Release History

Date	Version	Notes
Fri Nov 14 2025	1.0.0	Initial release of Predictions API

Predictions v0

List systems

Responses

Response samples

200

Content type

application/json

{"data": [{"system_id": "oslobysykkel",
"name": "Oslo Bysykkel",
"label": "oslo-bysykkel",
"alias": "oslo",
"latitude": 0,
"longitude": 0,
"bbox": [0
],
"country_name": "Norway",
"timezone": "Europe/Oslo"
}
]
}

Get stations

List system's stations

path Parameters

systemId

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"station_id": "station-123",
"name": "Central Station",
"address": "123 Main Street",
"latitude": 0,
"longitude": 0,
"capacity": 0,
"created_at": "2025-11-14T14:18:55.857Z",
"last_modified": "2025-11-14T14:18:55.857Z"
}
]
}

Get station statuses

List system's stations statuses

path Parameters

systemId

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"station_id": "station-123",
"status": true,
"available_bikes": 0,
"available_mechanical_bikes": 0,
"available_electric_bikes": 0,
"available_docks": 0,
"disabled_bikes": 0,
"disabled_mechanical_bikes": 0,
"disabled_electric_bikes": 0,
"disabled_docks": 0,
"is_installed": true,
"is_renting": true,
"is_returning": true
}
]
}

Get occupation predictions

Predicts occupancy for the selected station attribute at the given timestamps

path Parameters

systemId

required

string

query Parameters

timestamps	Array of strings Example: `timestamps[]=2023-01-01T00:00:00Z&timestamps[]=in-60-minutes` Timestamps to predict for
category required	string Enum: "AVAILABLE_BIKES" "AVAILABLE_MECHANICAL_BIKES" "AVAILABLE_ELECTRIC_BIKES" "AVAILABLE_DOCKS" Example: category=AVAILABLE_BIKES The category of prediction

Responses

Response samples

200

Content type

application/json

{"data": [{"station_id": "station-123",
"predictions": [{"timestamp": "2025-11-14T14:05:35.295Z",
"value": 0
}
]
}
]
}

Get probability predictions

Predicts occupancy for the selected station attribute at the given timestamps

path Parameters

systemId

required

string

query Parameters

timestamps	Array of strings Example: `timestamps[]=2023-01-01T00:00:00Z&timestamps[]=in-60-minutes` Timestamps to predict for
category required	string Enum: "AVAILABLE_BIKES" "AVAILABLE_MECHANICAL_BIKES" "AVAILABLE_ELECTRIC_BIKES" "AVAILABLE_DOCKS" Example: category=AVAILABLE_BIKES The category of prediction

Responses

Response samples

200

Content type

application/json

{"data": [{"station_id": "station-123",
"predictions": [{"timestamp": "2025-11-14T14:15:05.136Z",
"value": 0
}
]
}
]
}