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`).
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).
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 brewsbrews:write: Create, update, delete brews and notesinventory:read: List inventory itemsinventory:write: Create, update, delete inventory itemsequipment:read: List equipment profilesequipment:write: Create, update, delete equipment profilesstyles:read: List style profilesstyles:write: Create, update, delete style profilesprofiles:read: List mash, fermentation, and water profilescustom-fields:read: List custom field definitionscustom-fields:write: Create, update, delete custom field definitionsprofiles:write: Create, update, delete mash, fermentation, and water profilescellar:read: View cellar, packaged stock, tap lists, and labelscellar:write: Manage cellar, packaging, stock, tap lists, and labelssettings:read: View preferences, imports, calculators, and your data exportsettings:write: Change preferences and undo importscommunity:read: View community, feedback, tickets, inbox, and account overviewcommunity:write: Post, vote, and reply in community, feedback, and tickets
In: header
Scope: cellar:read
Request Body
application/json
Only beers whose name contains this text, e.g. "porter".
Also list stock lines at 0 (default false).
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).
^\d{4}-\d{2}-\d{2}$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": {}
}
}