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

[ array of Brewfather BATCH JSON ]

{ Brewfather BATCH JSON }

​

{
    "battery": 4.082377,
    "id": "GREEN",
    "rssi": -75,
    "temp": 5.1,
    "type": "iSpindel",
    "sg": 1.039,
    "time": 1572383500131,
    "angle": 32.8009
}

[ array of readings ]

{ brew tracker object }

Recipes

[ array of Brewfather RECIPE JSON ]

{ Brewfather RECIPE JSON }

Inventory

[ array of Brewfather JSON ]

{ Brewfather JSON }

​

​

[ array of Brewfather JSON ]

{ Brewfather JSON }

​

​

[ array of Brewfather JSON ]

{ Brewfather JSON }

​

​

[ array of Brewfather JSON ]

{ Brewfather JSON }

​