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
  • Search All My Brew Sessions
  • Get One Brew Session
  • Get Brew Session Logs

Was this helpful?

  1. API

Brew Sessions

Search All My Brew Sessions

GET https://api.brewersfriend.com/v1/brewsessions

This endpoint allows you to get your brew sessions.

Query Parameters

Name
Type
Description

group_id

string

Group ID

brewer_author_id

string

Brewer Author ID

sort

string

created_at, updated_at or batchcode Formatted: created_at:1 for ASC and created_at:-1 for DESC

id

number

Brew Session id

folder_id

number

Brew Session folder id

keyword

string

Searches brew session batch and phase

updated_from

string

Brew Sessions updated date start in the format YYYY-MM-DD

updated_to

string

Brew Sessions updated date end in the format YYYY-MM-DD

created_from

string

Brew Sessions created date start in the format YYYY-MM-DD

created_to

string

Brew Sessions created date end in the format YYYY-MM-DD

limit

number

Defaults to 20

offset

number

Defaults to 0

Headers

Name
Type
Description

X-API-KEY

string

Your API key.

{
  "message": "success",
  "count": "66",
  "brewsessions": [
    {
      "id": "196351",
      "loginid": "119823",
      "recipeid": "578357",
      "folder_id": null,
      "brewstepprofileid": "1",
      "phase": "Planning",
      "userdate": "2019-06-17",
      "batchcode": "00009",
      "chillmethod": "Plate Chiller",
      "mash_water_unit": null,
      "totalwater": "290.211",
      "starting_mash_thickness": null,
      "userunit": "metric",
      "equipment_profile_id": "119209",
      "waterprofile_volume": null,
      "waterprofile_dilution": null,
      "waterprofile_selected": null,
      "waterprofilesource_selected": null,
      "source_ca": null,
      "source_mg": null,
      "source_so4": null,
      "source_na": null,
      "source_cl": null,
      "source_hco3": null,
      "target_ca": null,
      "target_mg": null,
      "target_so4": null,
      "target_na": null,
      "target_cl": null,
      "target_hco3": null,
      "addition_caco3": null,
      "addition_nahco3": null,
      "addition_caso4": null,
      "addition_cacl2": null,
      "addition_mgso4": null,
      "addition_nacl": null,
      "deleted": "0",
      "updated_at": "2019-06-17 21:45:30",
      "created_at": "2019-06-17 15:45:30",
      "session_notes": null,
      "tilt_active": "0",
      "tilt_color": null,
      "tilt_updated": null,
      "addition_mgcl2": null,
      "addition_caoh2": null,
      "addition_naoh": null,
      "folder_name": null,
      "recipe_title": "Big IPA",
      "device_reading": "{\"last_reading\":{\"SG\":\"1.050\",\"Temp\":\"60.0\",\"Color\":\"RED\",\"Timepoint\":\"43306.54155361111\",\"Beer\":\"IPA Test\",\"Comment\":\"Better comment\"}}",
      "device_updated_at": "2019-06-28 16:29:01",
      "device_active": null,
      "device_id": "58"
    }
  ]
}
{
    "message": "unauthorized",
    "detail": "invalid api key"
}

GET https://api.brewersfriend.com/v1/brewsessions

Path Parameters

Name
Type
Description

string

current_stats

GET https://api.brewersfriend.com/v1/recipes

Query Parameters

Name
Type
Description

sort

string

created_at, updated_at or title Formatted: created_at:1 for ASC and created_at:-1 for DESC

GET https://api.brewersfriend.com/v1/recipes

Query Parameters

Name
Type
Description

sort

string

created_at, updated_at or title Formatted: created_at:1 for ASC and created_at:-1 for DESC

curl -H "X-API-Key: 535ad06757dd29bd83be1e635ec10530407a8XAVTX" \
https://api.brewersfriend.com/v1/brewsessions

Get One Brew Session

GET https://api.brewersfriend.com/v1/brewsessions/:brew_session_id

This endpoint allows you to get one brew session. Replace :brew_session_id with the brew session id.

Path Parameters

Name
Type
Description

brew_session_id

number

Brew Session id

Headers

Name
Type
Description

X-API-KEY

string

Your API key.

{
  "message": "success",
  "count": "1",
  "brewsessions": [
    {
      "id": "196351"
      ...,
      "current_stats": {
        "og": 17.5,
        "og_unit": "P",
        "fg": 1.012,
        "fg_unit": "G",
        "abv": 7.86908202907592,
        "abv_alt": 8.269363738779216,
        "ph": "",
        "temp": "",
        "temp_unit": "F",
        "updated": "2020-08-12T17:45:09+00:00"
      },
      "recipe": {
        "id": "578357",
        ...
      }
    }
  ]
}
curl -H "X-API-Key: 535ad06757dd29bd83be1e635ec10530407a8XAVTX" \
https://api.brewersfriend.com/v1/brewsessions/196351

Get Brew Session Logs

GET https://api.brewersfriend.com/v1/brewsessions/:brew_session_id/logs

This endpoint allows you to get a brew sessions logs. Replace :brew_session_id with the brew session id.

Path Parameters

Name
Type
Description

brew_session_id

number

Brew Session id

Headers

Name
Type
Description

X-API-KEY

string

Your API key.

{
  "message": "success",
  "count": "1",
  "brewsessions": [
    {
      "id": "196351"
      ...,
      "current_stats": {
        "og": 17.5,
        "og_unit": "P",
        "fg": 1.012,
        "fg_unit": "G",
        "abv": 7.86908202907592,
        "abv_alt": 8.269363738779216,
        "ph": "",
        "temp": "",
        "temp_unit": "F",
        "updated": "2020-08-12T17:45:09+00:00"
      },
      "recipe": {
        "id": "578357",
        ...
      }
    }
  ]
}
curl -H "X-API-Key: 535ad06757dd29bd83be1e635ec10530407a8XAVTX" \
https://api.brewersfriend.com/v1/brewsessions/196351/logs
PreviousAPINextDevice Streams

Last updated 3 years ago

Was this helpful?