Skip to content

Pool models

Pydantic models for pool-related endpoints.

rainbowminer_api_client.models.pools

Models for pool-related endpoints.

Covers: /pools, /allpools, /newpools, /algorithms.

Pool

Bases: RainbowMinerModel

An entry from /pools (currently active/enabled pools).

Attributes:

Name Type Description
Name str | None

Pool name.

BaseName str | None

Pool base name.

Algorithm list[str] | str | None

Algorithm(s) the pool is mining.

Currency str | None

Payout currency symbol.

Balance float | int | None

Current unpaid balance.

Paid float | int | None

Total paid out.

Earnings float | int | None

Recent earnings.

AllPool

Bases: RainbowMinerModel

An entry from /allpools (all known pools, active or not).

NewPool

Bases: RainbowMinerModel

An entry from /newpools (newly discovered pools).

Algorithm

Bases: RainbowMinerModel

An entry from /algorithms.