Miner models¶

Pydantic models for miner-related endpoints — active, running, failed, remote miners, and more.

rainbowminer_api_client.models.miners ¶

Models for miner-related endpoints.

Covers: /activeminers, /runningminers, /failedminers, /remoteminers, /minersneedingbenchmark, /minerinfo, /minerspeeds, /miners, /fastestminers, /availminers, /availminerstats, /minerstats, /getminerlog, /minerports, /asyncloaderjobs.

ActiveMiner ¶

Bases: _MinerBase

An entry from /activeminers.

RunningMiner ¶

Bases: _MinerBase

An entry from /runningminers.

FailedMiner ¶

Bases: _MinerBase

An entry from /failedminers.

RemoteMiner ¶

Bases: RainbowMinerModel

An entry from /remoteminers (default mode).

Attributes:

Name	Type	Description
`online`	`bool`	Whether the remote miner is reachable.
`worker`	`str \| None`	Worker name of the remote miner.
`data`	`list[Any] \| dict[str, Any] \| None`	Miner data payload (dynamic).

RemoteMinerEntry ¶

Bases: _MinerBase

An entry from /remoteminers?mode=miners — flattened miner data.

Attributes:

Name	Type	Description
`Worker`	`str \| None`	The originating worker name.

MinerNeedingBenchmark ¶

Bases: RainbowMinerModel

An entry from /minersneedingbenchmark.

MinerInfo ¶

Bases: RainbowMinerModel

An entry from /minerinfo (miner capability info).

MinerSpeed ¶

Bases: RainbowMinerModel

An entry from /minerspeeds.

Miner ¶

Bases: RainbowMinerModel

An entry from /miners (available miner definitions).

Attributes:

Name	Type	Description
`BaseName`	`str \| None`	Miner binary base name.
`Path`	`str \| None`	Path to the miner executable.

FastestMiner ¶

Bases: RainbowMinerModel

An entry from /fastestminers.

AvailMinerStat ¶

Bases: RainbowMinerModel

An entry from /availminerstats.

Attributes:

Name	Type	Description
`Name`	`str`	Miner base name.
`Statcount`	`int`	Number of stored hashrate stats.

MinerStat ¶

Bases: RainbowMinerModel

An entry from /minerstats.

Attributes:

Name	Type	Description
`BaseName`	`str \| None`	Miner binary base name.
`Name`	`str \| None`	Full miner name.
`Algorithm`	`str \| None`	Primary algorithm.
`SecondaryAlgorithm`	`str`	Secondary algorithm (dual mining).
`Speed`	`list[Any]`	Hashrate values.
`Ratio`	`list[Any]`	Efficiency ratios.
`PowerDraw`	`float \| int \| None`	Power consumption in watts.
`Devices`	`str \| None`	Device model label.
`DeviceModel`	`str \| None`	Raw device model identifier.
`Benchmarking`	`bool`	Whether the miner is currently benchmarking.
`NeedsBenchmark`	`bool`	Whether benchmark data is stale.
`BenchmarkFailed`	`bool`	Whether the last benchmark failed.
`Benchmarked`	`str \| None`	Timestamp of last successful benchmark.
`LogFile`	`str`	Associated log file name.

MinerLogResult ¶

Bases: RainbowMinerModel

Response of /getminerlog.

Attributes:

Name	Type	Description
`Status`	`bool`	`True` if the log file was found.
`Content`	`str`	The log file contents.

MinerPorts ¶

Bases: RootModel[dict[str, Any]]

Response of /minerports — mapping of miner names to port numbers.

AsyncloaderJob ¶

Bases: RainbowMinerModel

An entry from /asyncloaderjobs.

StringList ¶

Bases: RootModel[list[str]]

A simple list-of-strings response (e.g. /availminers, /disabled).