> For the complete documentation index, see [llms.txt](https://docs.bierbot.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bierbot.com/developer-section/pro-api.md).

# Pro API

The Pro API lets you interact with your brewerys' data, i.e. to enable custom build dashboards.

### Setup

To enable the Pro API: Got to your brewerys admin page (<https://bricks.bierbot.com/#/brewery/admin>), locate the "Pro-API" section and toggle the enable toggle to on. The Pro-API key and API key become available. The latter is the normal API key you've used for setting up all your Brick. The first one is an additional API key we need for communicating with the API.

<figure><img src="https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2FxDLVdBA592SOWzhwD3j6%2FScreenshot%20from%202023-12-03%2008-30-19.png?alt=media&amp;token=2dd3327e-cab3-4831-9840-d78894288a75" alt=""><figcaption><p>Pro-API config menu</p></figcaption></figure>

### Usage

Note: This requires at least a PRO membership.

All endpoints live under `https://bricks.bierbot.com` and take your `apikey` and `proapikey` as query parameters. Every call — reading or writing — counts once against the same monthly request budget of your membership. You can see how many requests you have left on the brewery admin page; the budget refills at the start of each month.

If you're missing an endpoint, please reach out using the blue feedback button, the [contact form](https://bierbot.com/contact/) or the [forum](https://forum.bierbot.com).

{% openapi src="/files/FfGzYLLZ4DmuZUGP50CY" path="/api/devices" method="get" %}
[My Project.openapi.json](https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2Fgit-blob-e437fba1a57d618636f06acf206ca731bf3d589d%2FMy%20Project.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/FfGzYLLZ4DmuZUGP50CY" path="/api/device" method="get" %}
[My Project.openapi.json](https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2Fgit-blob-e437fba1a57d618636f06acf206ca731bf3d589d%2FMy%20Project.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/FfGzYLLZ4DmuZUGP50CY" path="/api/brews" method="get" %}
[My Project.openapi.json](https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2Fgit-blob-e437fba1a57d618636f06acf206ca731bf3d589d%2FMy%20Project.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/FfGzYLLZ4DmuZUGP50CY" path="/api/brew/{brewId}" method="get" %}
[My Project.openapi.json](https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2Fgit-blob-e437fba1a57d618636f06acf206ca731bf3d589d%2FMy%20Project.openapi.json?alt=media)
{% endopenapi %}

### Controlling your brewery

The endpoints above read. The two below **change what your hardware does** — they are the same commands the buttons in the app send, so anything you trigger here behaves exactly as if you had pressed it yourself. Both are `POST` for that reason.

{% hint style="warning" %}
Your Pro-API key is enough to switch heating on. Treat it like a password: do not put it in a URL you paste into a support ticket, a screenshot, or a public repository. The key is created once, when you first enable the Pro API, and there is no self-service way to replace it yet — if yours has leaked, please [get in touch](https://bierbot.com/contact/).
{% endhint %}

{% openapi src="/files/FfGzYLLZ4DmuZUGP50CY" path="/api/brew/{brewId}/control" method="post" %}
[My Project.openapi.json](https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2Fgit-blob-e437fba1a57d618636f06acf206ca731bf3d589d%2FMy%20Project.openapi.json?alt=media)
{% endopenapi %}

{% openapi src="/files/FfGzYLLZ4DmuZUGP50CY" path="/api/device/{deviceId}/target" method="post" %}
[My Project.openapi.json](https://972345729-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mb-yazhyh6RzCW1gcvw%2Fuploads%2Fgit-blob-e437fba1a57d618636f06acf206ca731bf3d589d%2FMy%20Project.openapi.json?alt=media)
{% endopenapi %}
