The Taplist.io is a REST-like API, available at
https://taplist.io/api/v1 . The API is currently in beta. With the Taplist.io API, you can build integrations and mashups that use your Taplist.io data in new and fun ways.
API access is available to all paid subscribers. Thank you for supporting Taplist.io!
Note: These docs are currently incomplete and will be updated. Last updated: December 6 2019.
Some resources, such as taps and kegs, are scoped to a venue. Other resources, such as beverages and beverage producers, are global to a Taplist.io organization. This distinction should be evident in the resource addresses (
All requests require authentication using an API token. API examples below use HTTPie, a curl clone, but you can use any client you like.
To get an API token, visit https://taplist.io/account/developer . Create a new API key, copy the secret value, and save it somewhere safe.
You now have a ~long-lived access token to your account. Now you can explore the API.
export AUTH_TOKEN="secret-xxxxxx" export VENUE_NAME="taplist-whatever"
# Get all taps http get \ https://taplist.io/api/v1/venues/$VENUE_NAME/taps \ Authorization:"token $AUTH_TOKEN" # Get a specific tap http get \ https://taplist.io/api/v1/venues/$VENUE_NAME/taps/1 \ Authorization:"token $AUTH_TOKEN" # Get all kegs http get \ https://taplist.io/api/v1/venues/$VENUE_NAME/kegs \ Authorization:"token $AUTH_TOKEN" # Get a specific keg http get \ https://taplist.io/api/v1/venues/$VENUE_NAME/kegs/1 \ Authorization:"token $AUTH_TOKEN"
Quota and rate limiting
In order to prevent bugs and abuse, your use of the API is subject to certain rate limits. Authenticated requests will see the following headers in responses:
X-Ratelimit-Limit: Human-readable description of your quota (requests/period)
X-Ratelimit-Remaining: Credits remaining in the current period
X-Ratelimit-Reset: Number of seconds remaining in the current period (aka seconds until reset)
X-Ratelimit-Limit: 500/hour X-Ratelimit-Remaining: 487 X-Ratelimit-Reset: 3440
Limits global to your account/organization. When quota is exhausted, an HTTP
429 will be returned. The default quota is 10k requests/hour. This limit is subject to change; please let us know if you encounter rate limits during ordinary use.
Work in progress.
List all taps.
Create a new tap.
Modify a tap.
Delete a tap.
List all kegs.
Create a new keg.
Modify a keg.
Delete a keg.
List all beverages.
Create a new beverage.
Modify a beverage.
Delete a beverage.
List all beverage producers.
Create a new beverage producer.
Modify a beverage producer.
Delete a beverage producer.