Brewer's Friend Docs
  • Brewer's Friend Docs
  • Frequently Asked Questions
    • Recipes
    • Brew Sessions
    • Account Information
    • Platform Related
    • Additional Information
    • Contributing to BF
  • Recipe Builder
    • Recipe Setup
    • Quick Water Requirements
    • Mash Guidelines
    • Fermentables
      • Goal
    • Hops
    • Yeast
    • Other Ingredients
    • Advanced Settings
    • Water Chemistry
    • Priming Information
    • Cost
      • Currency
    • Versions
    • Description / Notes
    • Recipe Tools
    • Add Photos
  • Brew Session
    • Starting a Brew Session
      • Auto Batch Code
    • Brew Steps
    • Brew Log
    • Recipe View
    • Mash Calculator
    • Strike Water
    • Water Requirements
    • Water Chemistry
    • Fermentation
    • Device Notifications and Log Alerts
    • Notes
    • Edit
  • Inventory and Shopping
    • Inventory Deductions
    • Cost
    • Yeast
    • Search and Convert
    • CSV Import
    • BSG Invoice Import
    • Tags
    • Recipe Suggestions
  • Groups
    • Settings
    • Tanks
    • Device Notifications
  • Profile
    • Account
    • Membership
    • Public Profile
    • General
    • Equipment Profiles
    • Water Profiles
    • Brew Steps
    • Integrations
    • Devices
    • Brands
  • Devices
    • Tilt
      • Google Sheets
    • Floaty
    • iSpindel
    • Plaato
    • Stream
  • API
    • Brew Sessions
    • Device Streams
    • Fermentation
    • Recipes
      • Recipe Beer XML
    • Old API
      • 201309
        • Recipes
        • Brew Sessions
  • Changelog
  • Contributing
  • Contact
Powered by GitBook
On this page
  • Get Fermentation Data
  • Import Fermentation Data

Was this helpful?

  1. API

Fermentation

Get Fermentation Data

GET 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.

Path Parameters

Name
Type
Description

brew_session_id

string

Brew Session ID found in the brew session URL.

Query Parameters

Name
Type
Description

skip

number

Number of records to skip from 0

limit

number

Number of records to limit

from

string

Date in the format YYYY-MM-DD

to

string

Date in the format YYYY-MM-DD

Headers

Name
Type
Description

X-API-KEY

string

Your API Key.

{
  "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"
  }]
}
{
  "message":"not-found",
  "detail":"no records found"
}

Import Fermentation Data

POST 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.

Path Parameters

Name
Type
Description

brew_session_id

string

Brew Session ID found in the brew session URL.

Query Parameters

Name
Type
Description

reset

boolean

set true to delete all readings for this brew session first.

Headers

Name
Type
Description

Content-Type

string

application/json or text/csv

X-API-KEY

string

Your API Key.

{
  "message": "success",
  "imported": {
    "count": 12
  }
}
{
  "message":"not-found",
  "detail":"brew session found"
}

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", , , ,

PreviousDevice StreamsNextRecipes

Last updated 5 years ago

Was this helpful?

Post an array of reading objects, the same format you will get from exporting data from a fermentation in the or the same you would post to in the .

Stream API
Brew Session Fermentation tab