Skip to content

An API Client to check how many people are in a bouldering gym (in Germany)

License

Notifications You must be signed in to change notification settings

gggscript/how-many-people-are-bouldering

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

How many people are bouldering?

Programmatically find out how many people are in a bouldering gym

In the last few years more and more Bouldering Gyms have shown the occupancy of their gym on their website. They use services provided by POS Systems like Boulderado or Webclimber. These occupancy displays are almost always limited in their utility, showing only how many people are present right now instead of trends and having no easy API.

This project is an REST API client with a defined schema and a list of gyms with their respective API endpoints

Usage

You need node.js and npm

Install with npm install how-many-people-are-bouldering

const Bouldering = require('how-many-people-are-bouldering')

// Bouldering.gyms is an Array of all supported gyms
// you can also find this data in gyms.json
const myFavoriteGym = Bouldering.gyms.find((gym) => gym.name === 'Berlin Magicmountain')

Bouldering.getOccupancy(myFavoriteGym).then((result) => console.log(result))

// Because Berlin Magicmount uses Boulderado's API (myFavoriteGym.api.type === 'boulderado')
// -> the result will be absolute
const exampleAbsoluteResult = {
  type: 'absolute',
  current: 69,
  max: 130,
}
const exampleRelativeResult = {
  type: 'relative',
  percentage: 15,
}

Support

2 APIs

46 Gyms

About

An API Client to check how many people are in a bouldering gym (in Germany)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published