Fermentation

get
Get Fermentation Data
https://api.brewersfriend.com/v1/fermentation/:brew_session_id
This endpoint allows you to get fermentation data from a brew session.  Replace :brew_session_id ith the brew session id.
Request
Response
Request
Path Parameters
brew_session_id
required
string
Brew Session ID found in the brew session URL.
Headers
X-API-KEY
required
string
Your API Key.
Query Parameters
skip
optional
number
Number of records to skip from 0
limit
optional
number
Number of records to limit
from
optional
string
Date in the format YYYY-MM-DD
to
optional
string
Date in the format YYYY-MM-DD
Response
200: OK
Cake successfully retrieved.
{
  "message": "success",
  "readings": [{
    "_id": {
      "$oid": "5c5b15646ea3a6ca48726862"
    },
    "login_id": 119823,
    "api_key": "",
    "brewevent_id": 196331,
    "recipe_id": 578166,
    "ip": "::1",
    "name": "RED",
    "gravity": "1.030",
    "gravity_unit": "G",
    "temp": "67.0",
    "temp_unit": "F",
    "comment": "",
    "beer": "IPA Test",
    "interval": "43306.54155361111",
    "created_at": "2019-02-06T17:12:04+00:00",
    "source": "tilt"
  }]
}
404: Not Found
Could not find a cake matching this query.
{
  "message":"not-found",
  "detail":"no records found"
}
post
Import Fermentation Data
https://api.brewersfriend.com/v1/fermentation/:brew_session_id/import
This endpoint allows you to post fermentation data for a brew session.  The data is in the same format as either the JSON or CSV export in Brew Session Fermentation Export.  Replace :brew_session_id with the brew session id.
Request
Response
Request
Path Parameters
brew_session_id
required
string
Brew Session ID found in the brew session URL.
Headers
Content-Type
required
string
application/json or text/csv
X-API-KEY
required
string
Your API Key.
Query Parameters
reset
optional
boolean
set true to delete all readings for this brew session first.
Response
200: OK
Cake successfully retrieved.
{
  "message": "success",
  "imported": {
    "count": 12
  }
}
404: Not Found
Could not find a cake matching this query.
{
  "message":"not-found",
  "detail":"brew session found"
}
Post an array of reading objects, the same format you will get from exporting data from a fermentation in the Brew Session Fermentation tab or the same you would post to in the Stream API.
JSON Format
[{
 "name": "BrewBench",
 "temp": 22.2,
 "temp_unit": "C",
 "gravity": 14.1,
 "gravity_unit": "P",
 "ph": 4.5,
 "comment": "",
 "beer": "",
 "battery": 3.588112,
 "RSSI": -57,
 "angle": "",
 "created_at": "2019-12-10T14:31:18+00:00"
}]
CSV Format
gravity, gravity_unit, temp, temp_unit, ph, bpm, created_at, source, name, annotation, comment
14.1, "P", 22.2, "C", 4.5, ,"2019-12-10T14:31:18+00:00", , , ,
​
Device Streams
Recipes
Last updated 8 months ago
Fermentation

getGet Fermentation Data

postImport Fermentation Data

JSON Format

CSV Format

get
Get Fermentation Data

post
Import Fermentation Data
