BrewForge Docs

Browse the community feed or discover brewers

The BrewForge community. Without query/style: the feed of what the brewers the user follows brewed, packaged and shared (last 30 days, `days` for more), plus a few suggested brewers. With query and/or style (or view: "discover"): search other brewers' shared recipes by beer name, style or brewer name/handle (e.g. query "hopfenhans" or style "German Pilsner"), with suggested brewers. Use handles from the result with get_brewer_profile / interact_with_brewer, brew_id with cheer_brew, share_token with adopt_shared_recipe. Only brewers with an open profile appear. Scope: `community:read` (or `read`).

POST
/api/v1/actions/browse_community

The BrewForge community. Without query/style: the feed of what the brewers the user follows brewed, packaged and shared (last 30 days, days for more), plus a few suggested brewers. With query and/or style (or view: "discover"): search other brewers' shared recipes by beer name, style or brewer name/handle (e.g. query "hopfenhans" or style "German Pilsner"), with suggested brewers. Use handles from the result with get_brewer_profile / interact_with_brewer, brew_id with cheer_brew, share_token with adopt_shared_recipe. Only brewers with an open profile appear.

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

Request Body

application/json

view?string

"feed" (default) or "discover". Passing query or style switches to discover.

Value in"feed" | "discover"
query?string

Beer name, style or brewer name/handle to search for, e.g. "pils" or "hopfenhans".

Lengthlength <= 80
style?string

Exact style name of shared recipes, e.g. "American IPA". The discover result lists available styles.

Lengthlength <= 80
days?integer

Feed only: days to look back, 30-365 (default 30).

Range30 <= value <= 365
[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/browse_community" \  -H "Content-Type: application/json" \  -d '{}'
{
  "view": "feed",
  "following": 0,
  "entries": [
    {
      "kind": "brewed",
      "date": "string",
      "brewer": {
        "handle": "string",
        "name": "string",
        "location": "string"
      },
      "brew_id": "string",
      "beer": "string",
      "style": "string",
      "milestone": 0,
      "share_token": "string",
      "based_on": "string",
      "cheers": 0,
      "cheered_by_you": true
    }
  ],
  "has_older": true,
  "recipes": [
    {
      "brew_id": "string",
      "name": "string",
      "style": "string",
      "brewer": {
        "handle": "string",
        "name": "string",
        "location": "string"
      },
      "abv_pct": 0,
      "ibu": 0,
      "brewed_by": 0,
      "cheers": 0,
      "share_token": "string"
    }
  ],
  "styles": [
    "string"
  ],
  "suggested_brewers": [
    {
      "handle": "string",
      "name": "string",
      "location": "string",
      "styles": [
        "string"
      ],
      "listed_recipes": 0,
      "new_here": true
    }
  ],
  "note": "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": {}
  }
}