# Welcome to Bitpool

<button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">Ask a question...</button>

<a href="https://github.com/bitpool/gitbook-bitpool-cloud-wiki/blob/main/home/?ask=How+do+I+get+started+with+Bitpool?/README.md" class="button secondary" data-icon="rocket-launch">Get started</a><a href="https://github.com/bitpool/gitbook-bitpool-cloud-wiki/blob/main/home/?ask=How+do+I+generate+a+Bitpool+API+key?/README.md" class="button secondary" data-icon="key">Get an API key</a><a href="https://github.com/bitpool/gitbook-bitpool-cloud-wiki/blob/main/home/?ask=How+do+I+connect+my+edge+devices+to+Bitpool?/README.md" class="button secondary" data-icon="plug">Connect devices</a><a href="https://github.com/bitpool/gitbook-bitpool-cloud-wiki/blob/main/home/?ask=How+do+I+build+a+dashboard+in+Bitpool?/README.md" class="button secondary" data-icon="chart-line">Build a dashboard</a>

Bitpool is a cloud platform for collecting, processing, and visualising time-series data from buildings, equipment, and IoT devices. Push data in from the edge over REST, MQTT, LoRaWAN, or Haystack, then dashboard, alarm, report, and analyse it with Bitpool AI.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><i class="fa-cloud" style="color:$primary;">:cloud:</i></td><td><strong>Cloud Platform</strong></td><td>Dashboards, flows, reports, semantics, and Bitpool AI in one portal.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform</a></td><td><a href="/files/LHIOZGoI6dPF36TuRaxH">/files/LHIOZGoI6dPF36TuRaxH</a></td></tr><tr><td><i class="fa-server" style="color:$primary;">:server:</i></td><td><strong>Bitpool Edge</strong></td><td>Node-RED and Niagara connectors for BACnet, Modbus, MQTT, and more.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-edge">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-edge</a></td><td><a href="/files/IaUMODRBBSBL8eUaPX09">/files/IaUMODRBBSBL8eUaPX09</a></td></tr><tr><td><i class="fa-terminal" style="color:$primary;">:terminal:</i></td><td><strong>API reference</strong></td><td>Try the Bitpool REST API live, then drop the code into your stack.</td><td><a href="https://wiki-cloud.bitpool.com/public-bitpool-api">https://wiki-cloud.bitpool.com/public-bitpool-api</a></td><td><a href="/files/ebMoLMpZFyLqpzByuzrk">/files/ebMoLMpZFyLqpzByuzrk</a></td></tr></tbody></table>

{% columns %}
{% column width="50%" %}

### Push your first data point

This quickstart walks through creating a Pool, generating an API key, and posting your first interval to Bitpool. The examples send the same request in several languages, so you can start with the one that matches your stack.

The Bitpool API is organised around an analogy: an **interval** is a single time-stamped reading, a **stream** is the time-series of those readings, a **pool** groups related streams, and an organisation owns one or more pools.

{% hint style="info" icon="sparkle" %}
**Tailor this to your stack**

Tell the Bitpool assistant what you're building and have it adapt the example.

<a href="https://github.com/bitpool/gitbook-bitpool-cloud-wiki/blob/main/home/?ask=Help+me+adapt+the+Bitpool+quickstart+for+my+use+case.+Here%27s+what+I%27m+building:" class="button primary" data-icon="gitbook-assistant">What are you building?</a>
{% endhint %}

{% hint style="warning" icon="life-ring" %}
**Need a hand?**

Common issues and how to resolve them.

<details>

<summary>I get a 401 Unauthorized response</summary>

Check that the `Authorization` header uses the `Bitpool2` scheme followed by a single space and your key, for example `Bitpool2 00000000-0000-0000-0000-000000000000`.

Make sure you replaced `YOUR_API_KEY` in the example and that the key has not been revoked in **Account Settings → API Keys** at [app.bitpool.com](https://app.bitpool.com/).

</details>

<details>

<summary>I get a 400 Bad Request response</summary>

Confirm the JSON body is valid and uses the property names shown in the example (`Poolname`, `Public`, `Virtual` are case-sensitive).

Send `Content-Type: application/json` and make sure the request is a `POST` to `https://api.bitpool.com/public/v2/pools`.

</details>

<details>

<summary>The request succeeds, but I can't see the data in the portal</summary>

Pools, Stations, and Streams are created once. After the Pool exists, create a Station and at least one Stream before posting interval logs.

When uploading logs, the `Ts` field must be an ISO-8601 timestamp with a timezone offset (for example `2026-01-01T00:00:00.000+00:00`) and `Val` must match the Stream's `DataType`.

</details>

<details>

<summary>My local example does not run</summary>

For JavaScript, use Node.js 18+ so `fetch` is built in, or install a client like `axios`.

For Python, install `requests` with `pip install requests`.

For .NET, target .NET 6 or later so `HttpClient.PostAsJsonAsync` is available.

</details>

<a href="https://github.com/bitpool/gitbook-bitpool-cloud-wiki/blob/main/home/?ask=Walk+me+through+what+happens+when+I+send+my+first+Bitpool+API+request,+step+by+step." class="button primary" data-icon="gitbook-assistant">Explain what's happening...</a>
{% endhint %}

Once your first request works, head to the API reference for the full endpoint list, or jump into the Cloud Platform guides to start dashboarding.

<a href="https://wiki-cloud.bitpool.com/public-bitpool-api" class="button primary" data-icon="terminal">API reference</a> <a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform" class="button secondary" data-icon="book-open">Platform guides</a>
{% endcolumn %}

{% column width="50%" %}
{% stepper %}
{% step %}
**Create your API key**

Sign in to Bitpool, then generate an API key from **Account Settings → API Keys**. Keys take the form `Bitpool2 00000000-0000-0000-0000-000000000000`.

<a href="https://app.bitpool.com/" class="button primary">Open Bitpool</a>
{% endstep %}

{% step %}
**Make your first request**

Pick a language below, replace `YOUR_API_KEY`, and run. This call creates a new Pool that will contain your streams.

{% tabs %}
{% tab title="JavaScript" %}
{% code overflow="wrap" %}

```javascript
const response = await fetch("https://api.bitpool.com/public/v2/pools", {
  method: "POST",
  headers: {
    "Authorization": "Bitpool2 YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    Poolname: "QUICKSTART",
    Public: false,
    Virtual: false,
  }),
});

const pool = await response.json();
console.log(pool);
```

{% endcode %}
{% endtab %}

{% tab title="Python" %}
{% code overflow="wrap" %}

```python
import requests

response = requests.post(
    "https://api.bitpool.com/public/v2/pools",
    headers={
        "Authorization": "Bitpool2 YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
        "Poolname": "QUICKSTART",
        "Public": False,
        "Virtual": False,
    },
)

print(response.json())
```

{% endcode %}
{% endtab %}

{% tab title="cURL" %}
{% code overflow="wrap" %}

```bash
curl -X POST https://api.bitpool.com/public/v2/pools \
  -H "Authorization: Bitpool2 YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Poolname": "QUICKSTART",
    "Public": false,
    "Virtual": false
  }'
```

{% endcode %}
{% endtab %}

{% tab title="C#" %}
{% code overflow="wrap" expandable="true" %}

```csharp
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Threading.Tasks;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bitpool2", "YOUR_API_KEY");

var response = await client.PostAsJsonAsync(
    "https://api.bitpool.com/public/v2/pools",
    new { Poolname = "QUICKSTART", Public = false, Virtual = false });

Console.WriteLine(await response.Content.ReadAsStringAsync());
```

{% endcode %}
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
**Parse the response**

A successful request returns the new Pool, including the `PoolKey` you'll use to create Stations and Streams.

{% code title="response.json" overflow="wrap" %}

```json
{
  "PoolKey": "11917245-6a1d-4117-11c6-1237e94e03e1",
  "Name": "QUICKSTART",
  "RegistrationDate": "/Date(1654818341126)/",
  "Virtual": false,
  "Public": false,
  "Owner": true,
  "AccessMode": 0,
  "UtcOffset": 10.0,
  "TimeZone": "Sydney"
}
```

{% endcode %}

Store the `PoolKey`, then create a Station and Stream to start posting interval data. The [API reference](https://wiki-cloud.bitpool.com/public-bitpool-api) walks through the full upload flow.
{% endstep %}
{% endstepper %}
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column width="50%" %}
{% embed url="<https://www.youtube.com/watch?v=7ggGSF_R_OE>" %}
How Bitpool works
{% endembed %}
{% endcolumn %}

{% column width="50%" valign="middle" %}

### See Bitpool in action

Watch a short overview of how Bitpool collects edge data, stores it as time-series streams, and turns it into dashboards, reports, and AI-driven insights for buildings and assets.

Then dive into the guides for dashboards, flows, reports, and Bitpool AI, or open the cloud portal and start building.

<a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform" class="button primary" data-icon="book-open">Platform guides</a> <a href="https://app.bitpool.com/" class="button secondary" data-icon="arrow-up-right-from-square">Open Bitpool</a>
{% endcolumn %}
{% endcolumns %}

## Get your data into Bitpool

Bitpool meets your data where it lives. Pick the path that matches your stack, then move on to dashboards, flows, and reports.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-cube" style="color:$primary;">:cube:</i></td><td><strong>Bitpool Edge</strong></td><td>Pre-themed Node-RED image with nodes for BACnet, Modbus, Awair, Integriti, and the Bitpool Uploader. Free for commercial use.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-edge">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-edge</a></td></tr><tr><td><i class="fa-tower-broadcast" style="color:$primary;">:tower-broadcast:</i></td><td><strong>Niagara connectors</strong></td><td>Bitpool Uploader Service and MQTT Driver modules for the Tridium Niagara ecosystem.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/niagara-connectors">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/niagara-connectors</a></td></tr><tr><td><i class="fa-windows" style="color:$primary;">:windows:</i></td><td><strong>Windows Uploader</strong></td><td>Upload data from BACnet, TAC Vista, Continuum, ION, Trend963, Delta, oBIX, and more.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/windows-uploader">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/windows-uploader</a></td></tr><tr><td><i class="fa-bolt" style="color:$primary;">:bolt:</i></td><td><strong>Direct integrations</strong></td><td>MQTT, LoRaWAN (The Things Network), Haystack, CSV import, and email connectors.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/connections">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/connections</a></td></tr></tbody></table>

## What you can build on Bitpool

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-chart-line" style="color:$primary;">:chart-line:</i></td><td><strong>Dashboards</strong></td><td>Drag-and-drop widgets for charts, tables, weather, infographics, and command-and-control.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/dashboards">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/dashboards</a></td></tr><tr><td><i class="fa-diagram-project" style="color:$primary;">:diagram-project:</i></td><td><strong>Flows &#x26; virtual streams</strong></td><td>Low-code flow editor for transforming data, building virtual meters, and triggering alerts.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/flows">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/flows</a></td></tr><tr><td><i class="fa-file-lines" style="color:$primary;">:file-lines:</i></td><td><strong>Reports</strong></td><td>Scheduled, templated reports with charts, baselines, period comparisons, and AI insights.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/reports">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/reports</a></td></tr><tr><td><i class="fa-microchip" style="color:$primary;">:microchip:</i></td><td><strong>Bitpool AI</strong></td><td>Ask questions about your buildings and assets, surface anomalies, and auto-generate insights.</td><td><a href="https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/bitpool-ai">https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-cloud-platform/bitpool-ai</a></td></tr></tbody></table>

<h2 align="center">Get the most out of Bitpool</h2>

<p align="center">Talk to our team, explore the cloud portal, or read the platform guides.</p>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-headset">:headset:</i></td><td><strong>Talk to Bitpool</strong></td><td>Reach the Bitpool team for onboarding, integration help, or commercial questions.</td><td><a href="https://support.bitpool.com" class="button primary">Support Portal</a> <a href="mailto:support@bitpool.com" class="button secondary">Email support</a></td><td></td><td><a href="https://support.bitpool.com">https://support.bitpool.com</a></td></tr><tr><td><i class="fa-rocket-launch">:rocket-launch:</i></td><td><strong>Open the cloud portal</strong></td><td>Sign in to start building dashboards, configuring connections, and managing your organisation.</td><td><a href="https://app.bitpool.com/" class="button secondary">Open Bitpool</a></td><td></td><td><a href="https://app.bitpool.com/">https://app.bitpool.com/</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki-cloud.bitpool.com/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.