BrewForge Docs

Get fermentation status and readings

How a brew's fermentation is going, as its fermentation tab shows it: OG, expected FG, current gravity, apparent attenuation and ABV so far, whether the gravity is stable (finished), the current speed and the projected time to reach FG, plus the newest readings with their ids (for corrections with log_fermentation_reading reading_id, or delete_fermentation_readings). Use it to answer "is it done?": state "stable" means the gravity changed at most 0.001 over the last day. All gravities in SG, temperatures in °C. Scope: `brews:read` (or `read`).

POST
/api/v1/actions/get_fermentation

How a brew's fermentation is going, as its fermentation tab shows it: OG, expected FG, current gravity, apparent attenuation and ABV so far, whether the gravity is stable (finished), the current speed and the projected time to reach FG, plus the newest readings with their ids (for corrections with log_fermentation_reading reading_id, or delete_fermentation_readings). Use it to answer "is it done?": state "stable" means the gravity changed at most 0.001 over the last day. All gravities in SG, temperatures in °C.

Scope: brews:read (or read).

AuthorizationBearer <token>

API token in format: bfk_. Each operation lists the token scope it requires (the scopes are listed below).

  • read: Read everything (all areas)
  • write: Create, change and delete everything (all areas)
  • brews:read: List and view brews
  • brews:write: Create, update, delete brews and notes
  • inventory:read: List inventory items
  • inventory:write: Create, update, delete inventory items
  • equipment:read: List equipment profiles
  • equipment:write: Create, update, delete equipment profiles
  • styles:read: List style profiles
  • styles:write: Create, update, delete style profiles
  • profiles:read: List mash, fermentation, and water profiles
  • custom-fields:read: List custom field definitions
  • custom-fields:write: Create, update, delete custom field definitions
  • profiles:write: Create, update, delete mash, fermentation, and water profiles
  • cellar:read: View cellar, packaged stock, tap lists, and labels
  • cellar:write: Manage cellar, packaging, stock, tap lists, and labels
  • settings:read: View preferences, imports, calculators, and your data export
  • settings:write: Change preferences and undo imports
  • community:read: View community, feedback, tickets, inbox, and account overview
  • community:write: Post, vote, and reply in community, feedback, and tickets

In: header

Scope: brews:read

Request Body

application/json

brew*string

The brew: its id, its batch number (e.g. 12 or "#12") or its exact name (e.g. "Citra Pale Ale"). Case does not matter.

readings_limit?integer

How many of the newest readings to list (default 20, 0 = none).

Range0 <= value <= 500
[key: string]?never

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://brewforge.sh/api/v1/actions/get_fermentation" \  -H "Content-Type: application/json" \  -d '{    "brew": "string"  }'
{
  "brew": {
    "id": "string",
    "name": "string",
    "status": "string",
    "batch_number": 0
  },
  "state": "no_readings",
  "og_sg": 0,
  "og_plato": 0,
  "og_source": "measured",
  "expected_fg_sg": 0,
  "expected_fg_plato": 0,
  "fg_sg": 0,
  "fg_plato": 0,
  "current_gravity_sg": 0,
  "current_gravity_plato": 0,
  "latest_reading_at": "string",
  "apparent_attenuation_pct": 0,
  "abv_pct": 0,
  "speed_sg_per_day": 0,
  "projected_fg_at": "string",
  "projection_unavailable": "string",
  "peak_temp_c": 0,
  "days_active": 0,
  "readings_total": 0,
  "readings": [
    {
      "id": "string",
      "at": "string",
      "gravity_sg": 0,
      "gravity_plato": 0,
      "temp_c": 0,
      "ph": 0,
      "pressure_psi": 0,
      "comment": "string"
    }
  ]
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "hint": "string",
    "candidates": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "fields": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "details": {}
  }
}