OpenAPI 3.1.0
Reference for public pool data and private account endpoints, including authentication, response shapes, and route status from the OpenAPI contract.
Connection
Public API routes can be called without credentials. Private API routes require an API key generated in the user settings area of the dashboard. Keep keys server-side and rotate them if exposed.
https://api.icemining.ca/api/v1Authorization: Bearer {api_key}Send the generated key as a bearer token on every private API request.
Reference
/coin/{coin_id}Current public snapshot filtered by coin.
200 Current public snapshot filtered by coin. PublicCoinSnapshotV1
404 Coin not found. ApiProblem
503 Public snapshot unavailable or stale. ApiProblem
Reference
/coin/{coin_id}/blocksPublic block data for a coin.
200 Public block data for a coin. PublicPoolSnapshotV1
503 Public snapshot unavailable or stale. ApiProblem
Reference
/coinsCurrent public coin and pool snapshot.
200 Current public coin and pool snapshot. PublicPoolSnapshotV1
503 Public snapshot unavailable or stale. ApiProblem
Reference
/userAuthenticated account summary, derived from a single Workers read (`spec/POOL_API_ACCOUNT_DATA.md` §2.5 / §4 decision 2). Body is the same `WorkerHealthSnapshot` projection served by `/api/v1/user/workers`; clients aggregate the latest bucket for the summary counts.
200 Authenticated account summary, derived from a single Workers read (`spec/POOL_API_ACCOUNT_DATA.md` §2.5 / §4 decision 2). Body is the same `WorkerHealthSnapshot` projection served by `/api/v1/user/workers`; clients aggregate the latest bucket for the summary counts. WorkerHealthSnapshot
401 Missing or invalid API key. ApiProblem
429 Rate limited — per-IP or per-key budget exceeded (`spec/POOL_API_RATE_LIMIT_ABUSE.md` §4). Includes a `Retry-After` header. ApiProblem
503 Resolver or account-data read unavailable; retry later. ApiProblem
Reference
/user/hashrateAuthenticated hashrate-history projection for the default last-hour range at 30-second resolution. Body is an ICHRHST1 binary chunk (application/octet-stream), not JSON.
200 Authenticated hashrate-history projection for the default last-hour range at 30-second resolution. Body is an ICHRHST1 binary chunk (application/octet-stream), not JSON.
401 Missing or invalid API key. ApiProblem
429 Rate limited — per-IP or per-key budget exceeded (`spec/POOL_API_RATE_LIMIT_ABUSE.md` §4). Includes a `Retry-After` header. ApiProblem
503 Resolver or account-data read unavailable; retry later. ApiProblem
Reference
/user/paymentsPer-account balances + recent-payouts projection. Same `AccountPayoutsSnapshot` body as `/api/v1/user/payouts`; the kind discriminant differs so a future split needs no wire change.
200 Per-account balances + recent-payouts projection. Same `AccountPayoutsSnapshot` body as `/api/v1/user/payouts`; the kind discriminant differs so a future split needs no wire change. AccountPayoutsSnapshot
401 Missing or invalid API key. ApiProblem
429 Rate limited — per-IP or per-key budget exceeded (`spec/POOL_API_RATE_LIMIT_ABUSE.md` §4). Includes a `Retry-After` header. ApiProblem
503 Resolver or account-data read unavailable; retry later. ApiProblem
Reference
/user/payoutsPer-account balances + recent-payouts projection (`spec/POOL_API_ACCOUNT_DATA.md` §2.4).
200 Per-account balances + recent-payouts projection (`spec/POOL_API_ACCOUNT_DATA.md` §2.4). AccountPayoutsSnapshot
401 Missing or invalid API key. ApiProblem
429 Rate limited — per-IP or per-key budget exceeded (`spec/POOL_API_RATE_LIMIT_ABUSE.md` §4). Includes a `Retry-After` header. ApiProblem
503 Resolver or account-data read unavailable; retry later. ApiProblem
Reference
/user/workersPer-account worker-health projection: a rolling ring of one-minute health buckets (`spec/POOL_API_ACCOUNT_DATA.md` §2.4 status mapping).
200 Per-account worker-health projection: a rolling ring of one-minute health buckets (`spec/POOL_API_ACCOUNT_DATA.md` §2.4 status mapping). WorkerHealthSnapshot
401 Missing or invalid API key. ApiProblem
429 Rate limited — per-IP or per-key budget exceeded (`spec/POOL_API_RATE_LIMIT_ABUSE.md` §4). Includes a `Retry-After` header. ApiProblem
503 Resolver or account-data read unavailable; retry later. ApiProblem