Brewfather - docs
Go to Brewfather.appOpen APP
Search…
English
What is Brewfather?
Getting Started
Recipes
Batches
Devices
Inventory
Library
Profiles
Styles
Tools
Settings
Account
Integrations
API
FAQ
Contact
Changelog
Partner/Affiliate
Legal
Privacy Policy
Terms of Service
3rd Party Licenses
Powered By GitBook
API
REST API

Disclamer

Breaking changes can come at any time as the development of the API is not finalized. Please keep yourself updated on the API-documentation.
Data returned from the API will be in metric units.

Authentication

Authorization header must consist of your userid:apikey (base64 encoded).
Example:
UserId: xyz123 API-key: 1234567890123456789012345678901234567890abcd Base 64 encode: "xyz123:1234567890123456789012345678901234567890abcd"
curl -H "authorization: Basic eHl6MTIzOjEyMzQ1Njc4OTAxMjM0NTY3ODkwMTIzNDU2Nzg5MDEyMzQ1Njc4OTBhYmNk" \
https://api.brewfather.app/v1/batches
In Postman, you can configure Basic Authorization by clicking the Authorization tab, selecting Basic Auth from the drop-down selector, and then typing the username (userid from above) and password (api-key form above) on the right of the colon on each row.
The API supports HTTPS traffic only (for security reasons).

Generate API-Key

In the Settings page you can click GENERATE in the API-section to create your API-key. You can currently only have one API-key per account.

Scopes

Scopes control what the API-key can access. Currently you can choose:
  • Read Recipes
  • Read Batches
  • Edit Batches
  • Read Inventory
  • Edit Inventory
When you generate your API-key you can select different scopes that the API-key can access, when new scopes are added you might need to generate a new key with the new scopes to allow access to the new scopes.

Rate Limit

Currently you can do a maximum of 150 calls per hour per API-key.
Rate limits can be changed at any time, build your integration to handle http code 429 Too Many Requests, response will include a Retry-After header.

Batches

get
https://api.brewfather.app
/v1/batches
Get Batches
get
https://api.brewfather.app
/v1/batches/:id
Get Batch
patch
https://api.brewfather.app
/v1/batches/:id
Update Batch
get
https://api.brewfather.app
/v1/batches/:batch_id/readings/last
Get Batch Last Reading
get
https://api.brewfather.app
/v1/batches/:batch_id/readings
Get Batch All Readings
get
https://api.brewfather.app
/v1/batches/:batch_id/brewtracker
Get Batch Brew Tracker

Recipes

get
https://api.brewfather.app
/v1/recipes
Get Recipes
get
https://api.brewfather.app
/v1/recipes/:id
Get Recipe

Inventory

get
https://api.brewfather.app
/v1/inventory/fermentables
Get Fermentables
get
https://api.brewfather.app
/v1/inventory/fermentables/:id
Get Fermentable
patch
https://api.brewfather.app
/v1/inventory/fermentables/:id
Update Fermentable
​
get
https://api.brewfather.app
/v1/inventory/hops
Get Hops
get
https://api.brewfather.app
/v1/inventory/hops/:id
Get Hop
patch
https://api.brewfather.app
/v1/inventory/hops/:id
Update Hop
​
get
https://api.brewfather.app
/v1/inventory/miscs
Get Miscs
get
https://api.brewfather.app
/v1/inventory/miscs/:id
Get Misc
patch
https://api.brewfather.app
/v1/inventory/miscs/:id
Update Misc
​
get
https://api.brewfather.app
/v1/inventory/yeasts
Get Yeasts
get
https://api.brewfather.app
/v1/inventory/yeasts/:id
Get Yeast
patch
https://api.brewfather.app
/v1/inventory/yeasts/:id
Update Yeast
Previous
Brewblox
Next
FAQ
Last modified 11mo ago
Copy link
Outline
Disclamer
Authentication
Generate API-Key
Scopes
Rate Limit
Batches
get
Get Batches
get
Get Batch
patch
Update Batch
get
Get Batch Last Reading
get
Get Batch All Readings
get
Get Batch Brew Tracker
Recipes
get
Get Recipes
get
Get Recipe
Inventory
get
Get Fermentables
get
Get Fermentable
patch
Update Fermentable
get
Get Hops
get
Get Hop
patch
Update Hop
get
Get Miscs
get
Get Misc
patch
Update Misc
get
Get Yeasts
get
Get Yeast
patch
Update Yeast