BrewForge Docs

Get the brew day plan

What to do on brew day, as the app's brew day tab computes it: water volumes (strike/sparge in L), strike temperature (°C), water additions, grain bill, mash steps, boil time, hop and other additions in order, yeast and pitching temperature, and every brew day measurement with its target and the value recorded so far (measurements[].field is the parameter name for record_brew_measurements). Once measurements exist it also returns the batch efficiencies (mash, brewhouse, Sudhausausbeute in %) next to the planned ones. Read-only. Reference the brew by id, batch number or exact name. Scope: `brews:read` (or `read`).

POST
/api/v1/actions/get_brew_day_plan

What to do on brew day, as the app's brew day tab computes it: water volumes (strike/sparge in L), strike temperature (°C), water additions, grain bill, mash steps, boil time, hop and other additions in order, yeast and pitching temperature, and every brew day measurement with its target and the value recorded so far (measurements[].field is the parameter name for record_brew_measurements). Once measurements exist it also returns the batch efficiencies (mash, brewhouse, Sudhausausbeute in %) next to the planned ones. Read-only. Reference the brew by id, batch number or exact name.

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.

[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_brew_day_plan" \  -H "Content-Type: application/json" \  -d '{    "brew": "string"  }'
{
  "brew": {
    "id": "string",
    "name": "string",
    "status": "string",
    "batch_number": 0
  },
  "planned": {
    "og_sg": 0,
    "og_plato": 0,
    "fg_sg": 0,
    "fg_plato": 0,
    "abv_pct": 0,
    "ibu": 0,
    "color_ebc": 0,
    "batch_volume_l": 0,
    "fermenter_volume_l": 0
  },
  "planned_efficiency": {
    "mash_efficiency_pct": 0,
    "brewhouse_efficiency_pct": 0,
    "sudhausausbeute_pct": 0
  },
  "measurements": [
    {
      "field": "string",
      "unit": "string",
      "phase": "string",
      "target": 0,
      "measured": 0,
      "off_by": 0,
      "on_target": true
    }
  ],
  "batch": {
    "mash_efficiency_pct": 0,
    "brewhouse_efficiency_pct": 0,
    "sudhausausbeute_pct": 0,
    "og_sg": 0,
    "og_plato": 0,
    "fg_sg": 0,
    "fg_plato": 0,
    "abv_pct": 0,
    "apparent_attenuation_pct": 0,
    "ibu": 0,
    "boil_off_l_per_h": 0,
    "packaged_volume_l": 0
  }
}
{
  "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": {}
  }
}