Skip to content

Balance & earnings models

Pydantic models for balances, payouts, and earnings endpoints.

rainbowminer_api_client.models.balances

Models for balance, payout, and earnings endpoints.

Covers: /balances, /payouts, /earnings.

Balance

Bases: RainbowMinerModel

An entry from /balances.

Attributes:

Name Type Description
Name str | None

Balance entry name (pool or wallet name).

BaseName str | None

Base name ("TotalPools", "Wallet", etc.).

Currency str | None

Currency symbol.

Started str | None

Tracking start timestamp.

Total float | int | str | None

Current unpaid balance.

Paid float | int | str | None

Total amount paid out.

Earnings float | int | str | None

Total earnings.

Earnings_1h float | int | str | None

Earnings in the last hour.

Earnings_1d float | int | str | None

Earnings in the last day.

Earnings_1w float | int | str | None

Earnings in the last week.

Earnings_Avg float | int | str | None

Average earnings.

Payout

Bases: RainbowMinerModel

An entry from /payouts.

Attributes:

Name Type Description
Name str | None

Pool base name.

Currency str | None

Currency symbol.

Date str | None

Payout timestamp.

Amount float | int | None

Payout amount.

Txid str | None

Transaction ID.

Earning

Bases: RainbowMinerModel

An entry from /earnings.

Attributes:

Name Type Description
Date str | None

Local timestamp.

Date_UTC str | None

UTC timestamp.

PoolName str | None

Pool name.

Currency str | None

Currency symbol.

Balance float | int | None

Current balance.

Paid float | int | None

Total paid.

Earnings float | int | None

Earnings for the period.

Value float | int | None

Fiat value.

Balance_BTC float | int | None

Balance in BTC.

Paid_BTC float | int | None

Paid in BTC.

Earnings_BTC float | int | None

Earnings in BTC.

Value_BTC float | int | None

Fiat value in BTC.

EarningsResult

Bases: RainbowMinerModel

Paginated response of /earnings.

Attributes:

Name Type Description
total int

Number of rows after filtering.

totalNotFiltered int

Number of rows before filtering.

rows list[Earning]

The requested page of earnings.