BrewForge Docs

Find beer styles

Search beer styles by name, style number or category: the BJCP 2021 library (source "library", id = style number like "21A") and the brewer's own styles (source "mine"). Each row has the style's ranges as [min, max]: og_sg / fg_sg (SG), ibu, color_ebc (EBC, as brews report color) and color_srm (SRM, as in the guidelines), abv_pct. Example: {"query": "ipa"} or {"category": "Pale Bitter European Beer"}. To use a library style as a base for your own, call save_style { from_library }. Scope: `styles:read` (or `read`).

POST
/api/v1/actions/find_styles

Search beer styles by name, style number or category: the BJCP 2021 library (source "library", id = style number like "21A") and the brewer's own styles (source "mine"). Each row has the style's ranges as [min, max]: og_sg / fg_sg (SG), ibu, color_ebc (EBC, as brews report color) and color_srm (SRM, as in the guidelines), abv_pct. Example: {"query": "ipa"} or {"category": "Pale Bitter European Beer"}. To use a library style as a base for your own, call save_style { from_library }.

Scope: styles: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: styles:read

Request Body

application/json

query?string

Text in the name or style number, case-insensitive. Example: "hazy" or "21B".

category?string

Text in the category name. Example: "IPA" or "Strong Belgian".

source?string

"library" (BJCP 2021), "mine" (own styles) or "all" (default; own styles first).

Value in"all" | "library" | "mine"
include_description?boolean

true: add each style's description text (longer result). Default false.

limit?integer

How many rows to return, 1-100 (default 20).

Range1 <= value <= 100
cursor?string

next_cursor from the previous page, to get the next page. Omit for the first page.

[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/find_styles" \  -H "Content-Type: application/json" \  -d '{}'
{
  "items": [
    {
      "id": "string",
      "source": "library",
      "name": "string",
      "number": "string",
      "category": "string",
      "guidelines": "string",
      "og_sg": [
        0,
        0
      ],
      "fg_sg": [
        0,
        0
      ],
      "ibu": [
        0,
        0
      ],
      "color_ebc": [
        0,
        0
      ],
      "color_srm": [
        0,
        0
      ],
      "abv_pct": [
        0,
        0
      ],
      "description": "string"
    }
  ],
  "next_cursor": "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": {}
  }
}