BrewForge Docs

Beer on hand: kegs, bottles and cans

Lists the packaged beer the brewer has: kegs on tap or ready (litres left, keg sensor), bottle/can stock lines (beer × container, count), and the containers with how many are owned, filled and empty. Use for 'how much porter is left?' or before update_keg / update_bottle_stock. Filter with beer (part of a beer name). Volumes in litres. Beer still in fermenters/tanks is in get_cellar. Needs the plan feature `cellar`. Scope: `cellar:read` (or `read`).

POST
/api/v1/actions/get_beer_stock

Lists the packaged beer the brewer has: kegs on tap or ready (litres left, keg sensor), bottle/can stock lines (beer × container, count), and the containers with how many are owned, filled and empty. Use for 'how much porter is left?' or before update_keg / update_bottle_stock. Filter with beer (part of a beer name). Volumes in litres. Beer still in fermenters/tanks is in get_cellar.

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

Request Body

application/json

beer?string

Only beers whose name contains this text, e.g. "porter".

include_empty?boolean

Also list stock lines at 0 (default false).

today?string

The brewer's local date today, YYYY-MM-DD (e.g. "2026-11-11"). Optional: defaults to today in UTC. Pass it when the brewer's day differs from UTC (late evening in America, early morning in Asia).

Match^\d{4}-\d{2}-\d{2}$
[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_beer_stock" \  -H "Content-Type: application/json" \  -d '{}'
{
  "kegs": [
    {
      "stay_id": "string",
      "keg": "string",
      "beer": "string",
      "brew_id": "string",
      "volume_l": 0,
      "capacity_l": 0,
      "pints_left": 0,
      "since": "string",
      "sensor": "string"
    }
  ],
  "bottles_and_cans": [
    {
      "line_id": "string",
      "beer": "string",
      "brew_id": "string",
      "container": "string",
      "count": 0,
      "volume_l": 0
    }
  ],
  "containers": [
    {
      "name": "string",
      "type": "string",
      "volume_l": 0,
      "owned": 0,
      "filled": 0,
      "empty": 0
    }
  ],
  "keg_sensors": [
    {
      "id": "string",
      "name": "string",
      "attached_to_keg": true
    }
  ]
}
{
  "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": {}
  }
}