BrewForge Docs

Run a brewing calculator

BrewForge's brewing calculators: ABV, IBU, beer color, strike water, step mash, dilution, boil-off, hydrometer temperature correction, refractometer, priming sugar, force carbonation, spunding, yeast pitch rate, hop freshness and unit conversion. Use them instead of doing brewing math yourself. Call without calculator to get the list with each calculator's parameters and an example; then call with calculator and params. Example: {"calculator": "priming-sugar", "params": {"volume": 19, "co2": 2.4, "beerTemp": 18}}. Results carry their units. Needs the plan feature `calculators`. Scope: `settings:read` (or `read`).

POST
/api/v1/actions/run_calculator

BrewForge's brewing calculators: ABV, IBU, beer color, strike water, step mash, dilution, boil-off, hydrometer temperature correction, refractometer, priming sugar, force carbonation, spunding, yeast pitch rate, hop freshness and unit conversion. Use them instead of doing brewing math yourself. Call without calculator to get the list with each calculator's parameters and an example; then call with calculator and params. Example: {"calculator": "priming-sugar", "params": {"volume": 19, "co2": 2.4, "beerTemp": 18}}. Results carry their units.

Needs the plan feature calculators. Scope: settings: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: settings:read

Request Body

application/json

calculator?string

Calculator name from the list, e.g. "priming-sugar" or "abv". Omit to list all calculators with their parameters.

params?

Parameters by name, as listed for the calculator, e.g. {"og": 1.052, "fg": 1.010}. Values are metric (L, °C, kg, g) and SG unless you pass the calculator's unit parameters (e.g. volumeUnit "gal", temperatureUnit "F") or units: "imperial".

[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/run_calculator" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "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": {}
  }
}