# Pools

## GET /public/v2/pools

> Return list of pools available to user

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BitPool.Base.Entities.BitPoolEntity":{"type":"object","properties":{"PoolKey":{"type":"string","format":"uuid"},"Name":{"type":"string","nullable":true},"RegistrationDate":{"type":"string","format":"date-time"},"Virtual":{"type":"boolean","deprecated":true},"Public":{"type":"boolean","deprecated":true},"Owner":{"type":"boolean"},"AccessMode":{"$ref":"#/components/schemas/BitPool.Base.Enums.BitPoolUserRolesTypes"},"UtcOffset":{"type":"number","format":"float"},"TimeZone":{"type":"string","nullable":true}},"additionalProperties":false},"BitPool.Base.Enums.BitPoolUserRolesTypes":{"enum":[0,1,2,3,4,-1],"type":"integer","description":"\n\n0 = Administrator\n\n1 = Owner\n\n2 = CoOwner\n\n3 = Contributor\n\n4 = Reader\n\n-1 = None","format":"int32"}}},"paths":{"/public/v2/pools":{"get":{"tags":["Pools"],"summary":"Return list of pools available to user","parameters":[{"name":"includeHidden","in":"query","description":"Show hidden pools","schema":{"type":"boolean","default":true}},{"name":"lite","in":"query","description":"Without AccessMode","schema":{"type":"boolean","default":true}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BitPool.Base.Entities.BitPoolEntity"}}}}}}}}}}
```

## POST /public/v2/pools

> Create a new pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BitPool.Base.DTO.BP_RegisterPool":{"type":"object","properties":{"Poolname":{"type":"string","nullable":true}},"additionalProperties":false},"BitPool.Base.Entities.BitPoolEntity":{"type":"object","properties":{"PoolKey":{"type":"string","format":"uuid"},"Name":{"type":"string","nullable":true},"RegistrationDate":{"type":"string","format":"date-time"},"Virtual":{"type":"boolean","deprecated":true},"Public":{"type":"boolean","deprecated":true},"Owner":{"type":"boolean"},"AccessMode":{"$ref":"#/components/schemas/BitPool.Base.Enums.BitPoolUserRolesTypes"},"UtcOffset":{"type":"number","format":"float"},"TimeZone":{"type":"string","nullable":true}},"additionalProperties":false},"BitPool.Base.Enums.BitPoolUserRolesTypes":{"enum":[0,1,2,3,4,-1],"type":"integer","description":"\n\n0 = Administrator\n\n1 = Owner\n\n2 = CoOwner\n\n3 = Contributor\n\n4 = Reader\n\n-1 = None","format":"int32"}}},"paths":{"/public/v2/pools":{"post":{"tags":["Pools"],"summary":"Create a new pool","parameters":[{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BitPool.Base.DTO.BP_RegisterPool"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BitPool.Base.Entities.BitPoolEntity"}}}}}}}}}
```

## GET /public/v2/pools/{poolKey}

> Return a specific pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BitPool.Base.Entities.BitPoolEntity":{"type":"object","properties":{"PoolKey":{"type":"string","format":"uuid"},"Name":{"type":"string","nullable":true},"RegistrationDate":{"type":"string","format":"date-time"},"Virtual":{"type":"boolean","deprecated":true},"Public":{"type":"boolean","deprecated":true},"Owner":{"type":"boolean"},"AccessMode":{"$ref":"#/components/schemas/BitPool.Base.Enums.BitPoolUserRolesTypes"},"UtcOffset":{"type":"number","format":"float"},"TimeZone":{"type":"string","nullable":true}},"additionalProperties":false},"BitPool.Base.Enums.BitPoolUserRolesTypes":{"enum":[0,1,2,3,4,-1],"type":"integer","description":"\n\n0 = Administrator\n\n1 = Owner\n\n2 = CoOwner\n\n3 = Contributor\n\n4 = Reader\n\n-1 = None","format":"int32"}}},"paths":{"/public/v2/pools/{poolKey}":{"get":{"tags":["Pools"],"summary":"Return a specific pool","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BitPool.Base.Entities.BitPoolEntity"}}}}}}}}}
```

## DELETE /public/v2/pools/{poolKey}

> Delete a specific pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}}},"paths":{"/public/v2/pools/{poolKey}":{"delete":{"tags":["Pools"],"summary":"Delete a specific pool","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success"}}}}}}
```

## PUT /public/v2/pools/{poolKey}/timezone

> Update specific pool with new timezone

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}}},"paths":{"/public/v2/pools/{poolKey}/timezone":{"put":{"tags":["Pools"],"summary":"Update specific pool with new timezone","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success"}}}}}}
```

## PUT /public/v2/pools/{poolKey}/rename

> Update specific pool with new name

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}}},"paths":{"/public/v2/pools/{poolKey}/rename":{"put":{"tags":["Pools"],"summary":"Update specific pool with new name","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /public/v2/pools/{poolKey}/stations

> Return list of stations inside specific pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BitPool.Base.Entities.BitStationEntity":{"type":"object","properties":{"StationID":{"type":"integer","format":"int32"},"StationName":{"type":"string","nullable":true},"RegistrationDate":{"type":"string","format":"date-time"},"PoolKey":{"type":"string","format":"uuid"}},"additionalProperties":false}}},"paths":{"/public/v2/pools/{poolKey}/stations":{"get":{"tags":["Pools"],"summary":"Return list of stations inside specific pool","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BitPool.Base.Entities.BitStationEntity"}}}}}}}}}}
```

## POST /public/v2/pools/{poolKey}/stations

> Create new station inside a specific pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BitPool.Base.Entities.BitStationEntity":{"type":"object","properties":{"StationID":{"type":"integer","format":"int32"},"StationName":{"type":"string","nullable":true},"RegistrationDate":{"type":"string","format":"date-time"},"PoolKey":{"type":"string","format":"uuid"}},"additionalProperties":false}}},"paths":{"/public/v2/pools/{poolKey}/stations":{"post":{"tags":["Pools"],"summary":"Create new station inside a specific pool","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BitPool.Base.Entities.BitStationEntity"}}}}}}}}}
```

## GET /public/v2/pools/{poolKey}/stations/{stationId}

> Return specific station inside a specific pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"BitPool.Base.Entities.BitStationEntity":{"type":"object","properties":{"StationID":{"type":"integer","format":"int32"},"StationName":{"type":"string","nullable":true},"RegistrationDate":{"type":"string","format":"date-time"},"PoolKey":{"type":"string","format":"uuid"}},"additionalProperties":false}}},"paths":{"/public/v2/pools/{poolKey}/stations/{stationId}":{"get":{"tags":["Pools"],"summary":"Return specific station inside a specific pool","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"stationId","in":"path","description":"","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BitPool.Base.Entities.BitStationEntity"}}}}}}}}}
```

## DELETE /public/v2/pools/{poolKey}/stations/{stationId}

> Delete a specific station inside a specific pool

```json
{"openapi":"3.0.1","info":{"title":"Bitpool API v2","version":"v2"},"servers":[{"url":"https://api.bitpool.com","description":"Production API"},{"url":"https://api.dev.bitpool.com","description":"Development API"}],"security":[{"Bitpool2":["readAccess","writeAccess"]}],"components":{"securitySchemes":{"Bitpool2":{"type":"apiKey","name":"Authorization","in":"header"}}},"paths":{"/public/v2/pools/{poolKey}/stations/{stationId}":{"delete":{"tags":["Pools"],"summary":"Delete a specific station inside a specific pool","parameters":[{"name":"poolKey","in":"path","description":"","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"stationId","in":"path","description":"","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"BPDateFormat","in":"header","description":"Date format header","required":true,"schema":{"type":"string","default":"ISO"}},{"name":"Accept","in":"header","description":"Accept header","required":true,"schema":{"type":"string","default":"application/json"}}],"responses":{"200":{"description":"Success"}}}}}}
```


---

# 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/public-bitpool-api/pools.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.