Skip to content

A simple api to know the closest Bixi bike stations from your location.

Notifications You must be signed in to change notification settings

corentinleberre/bixi-around

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bixi-around

A simple api to know the closest Bixi bike stations from your location. It allows you to choose the best station according to your needs (classic or electric bike, parking slot).

I only tested it for the city of Montreal 🇨🇦. But, the data streams are based on the GBFS standard, so it's theoretically possible that it also works in the following cities 👉 https://github.com/MobilityData/gbfs/blob/master/systems.csv

Usage/Examples

TODO link to the Apple Shortcuts to integrate it with Siri.

Demo

Bikes around Montréal city hall 👉 https://bixi-around.fly.dev/api/bixi-around?city=montreal&lat=45.501690&lon=-73.567253&nbResult=5

API Reference

Get all items

  GET /api/bixi-around?city=montreal&lat=45.501690&lon=-73.567253&nbResult=5
Query Parameter Type Description
city string Required. Default "montreal"
lat number Required. Longitude GPS coordinates
long number Required. Latitude GPS coordinates
nbResult number Required. Number of result expected

Run Locally

Clone the project

  git clone https://github.com/corentinleberre/bixi-around

Go to the project directory

  cd bixi-around

Install dependencies

  npm install

Build the server

  npm run build

Start the server

  npm run start

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

About

A simple api to know the closest Bixi bike stations from your location.

Topics

Resources

Stars

Watchers

Forks