---
title: "Get Pool Groups"
method: GET
path: "/api/v1/pools/"
tags: ["Pools"]
---

# Get Pool Groups

`GET /api/v1/pools/`

## Request

- Base URL: `http://miner`
- URL: `http://miner/api/v1/pools/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/docs/api/v1/pools/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetches the list of all configured pool groups, including their pools, load balancing strategy, and status.

## Response `200`

A list of pool groups with their respective pools and configurations.

- PoolGroup[]
  - `name` string, required: Group name
  - `pools` Pool[], required: Group pools
    - `active` boolean, required: Flag if pool is active (running)
    - `alive` boolean, required: Flag if pool is alive
    - `enabled` boolean, required: Flag if pool connection is enabled
    - `stats` PoolStats: Structure handle pool statistics
      - `accepted_shares` integer, required: Accepted shares
      - `best_share` integer, required: Best share (deprecated: may overflow for values > 2^64-1, use best_share_str instead)
      - `best_share_str` string, required: Best share as decimal string
      - `generated_work` integer, required: Generated work
      - `last_difficulty` integer, required: Last difficulty
      - `last_share_time` Timestamp: Custom version of google.protobuf.Timestamp It is used only during compilation to replace google.protobuf.Timestamp to enable traits for de/serialization and for generating documentation
        - `nanos` integer, required
        - `seconds` integer, required
      - `rejected_shares` integer, required: Rejected shares
      - `stale_shares` integer, required: Stale shares
    - `uid` string, required: Pool connection id
    - `url` string, required: Pool connection URL
    - `user` string, required: Pool connection user
  - `strategy` union: Load balancing strategy
    - object
      - `quota` Quota, required: Structure for quota load balance strategy
        - `value` integer, required
    - object
      - `fixedshareratio` FixedShareRatio, required: Structure for fixed share ratio load balance strategy Fixed share ratio is value between 0.0 to 1.0 where 1.0 represents that all work is generated from the group
        - `value` number, double, required
  - `uid` string, required: Group id

---

[API](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api.md) - [All operations](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/revisions/d341c8e1d506?raw)