{ "openapi": "3.0.3", "info": { "title": "2Miners Pool API", "version": "2.1.0", "description": "Public HTTP API of the [2Miners](https://2miners.com) mining pools. Every pool has its own host:\n`https://.2miners.com/api` for PPLNS and `https://solo-.2miners.com/api` for SOLO. Pick the pool in the\nserver selector. All endpoints are read-only `GET` requests with JSON responses, except `POST /accounts/{login}/settings`.\n\n### Conventions\n\n- **Amounts** (balances, payments, rewards, payout thresholds) are integers in the pool's base unit of the coin,\n not in whole coins. Divide by the factor below to get coins:\n\n | Factor | Pools |\n |---|---|\n | 10^2 | NEXA |\n | 10^8 | AE, BCH, BEAM, BTC, CKB, KAS, PRL, RVN, XNA, ZEC |\n | 10^9 | ERG, ETC, ETHW, GRIN, MWC, QUAI (Shannon for ETC/ETHW) |\n | 10^12 | QTC, ZEPH |\n\n One exception: in `/blocks`, `reward` on ETC, ETHW, QUAI-SHA and QUAI-KawPoW is the full block reward in **wei** (10^18),\n sent as a decimal string.\n- **Large numbers as strings.** Node fields in `/stats` (`height`, `difficulty`, `networkhashps`, ...) are strings, and so is\n block `reward` on ETC, ETHW, ERG, QTC and QUAI. Parse them as numbers.\n- **Hashrates** are in hashes per second (graphs per second on GRIN and MWC).\n- **Timestamps** are Unix time in seconds, except `now` and `updatedAt`, which are in milliseconds.\n- **Empty lists** may be returned as `null` instead of `[]`.\n- **Fields differ by coin.** The schemas list every field seen in production. Fields marked with a coin name appear only on those pools.\n- **GRIN and MWC** report per-algorithm values: `hashrate`, `currentHashrate` and the share counters are objects keyed by\n algorithm (`\"32\"` for GRIN Cuckatoo32, `\"31\"` for MWC Cuckaroo31) instead of numbers. They also accept an optional\n `/{algo}` suffix on the range endpoints.\n- **Range buckets**: `5m`, `30m` and `6h` (the bucket size of a chart point). Any other value returns `404`.\n- An unknown miner address returns `404`.\n- Responses are cached for up to about a minute, so polling more often than that returns the same data.\n\nSource and issues: [github.com/2miners/apidoc](https://github.com/2miners/apidoc).\n", "contact": { "name": "2Miners support", "email": "support@2miners.com", "url": "https://2miners.com" }, "license": { "name": "2Miners Mining Pools", "url": "https://2miners.com" } }, "servers": [ { "url": "https://{pool}.2miners.com/api", "description": "Pool API. `solo-` prefix = SOLO pool.", "variables": { "pool": { "default": "kas", "enum": [ "ae", "solo-ae", "bch", "solo-bch", "beam", "solo-beam", "solo-btc", "ckb", "solo-ckb", "erg", "solo-erg", "etc", "solo-etc", "ethw", "solo-ethw", "grin", "solo-grin", "kas", "solo-kas", "mwc", "solo-mwc", "nexa", "solo-nexa", "prl", "solo-prl", "qtc", "solo-qtc", "quaikawpow", "solo-quaikawpow", "quaisha", "solo-quaisha", "rvn", "solo-rvn", "xna", "solo-xna", "zec", "solo-zec", "zeph", "solo-zeph" ], "description": "Pool host name" } } } ], "tags": [ { "name": "Pool", "description": "Pool-wide statistics." }, { "name": "Blocks and payments", "description": "Blocks found and payouts made by the pool." }, { "name": "Account", "description": "One miner, by wallet address." }, { "name": "Workers", "description": "A miner's workers (rigs)." } ], "paths": { "/stats": { "get": { "tags": [ "Pool" ], "summary": "Pool statistics", "description": "Pool hashrate, miners, block counters, round luck and the state of the blockchain node.", "operationId": "getStats", "responses": { "200": { "description": "Pool statistics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoolStats" } } } } } } }, "/stats/region": { "get": { "tags": [ "Pool" ], "summary": "Hashrate by country", "description": "Pool hashrate and miners grouped by the miners' country (GeoIP).", "operationId": "getRegionStats", "responses": { "200": { "description": "Hashrate by country", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionStats" } } } } } } }, "/miners": { "get": { "tags": [ "Pool" ], "summary": "Online miners", "description": "All miners online, with their hashrate.", "operationId": "getMiners", "responses": { "200": { "description": "Online miners", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Miners" } } } } } } }, "/blocks": { "get": { "tags": [ "Blocks and payments" ], "summary": "Blocks", "description": "Blocks found by the pool: candidates, immature and the latest matured blocks, plus luck over recent blocks.", "operationId": "getBlocks", "responses": { "200": { "description": "Blocks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blocks" } } } } } } }, "/finders": { "get": { "tags": [ "Blocks and payments" ], "summary": "Block finders", "description": "Latest blocks with the address of the miner who found each.", "operationId": "getFinders", "responses": { "200": { "description": "Block finders", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Finders" } } } } } } }, "/payments": { "get": { "tags": [ "Blocks and payments" ], "summary": "Pool payouts", "description": "Latest payouts of the pool and its totals.", "operationId": "getPayments", "responses": { "200": { "description": "Pool payouts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payments" } } } } } } }, "/accounts/{login}": { "get": { "tags": [ "Account" ], "summary": "Account", "description": "Everything about one miner: hashrate, workers, balances, payouts, rewards and payout settings.", "operationId": "getAccount", "responses": { "200": { "description": "Account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ] } }, "/accounts/{login}/stats": { "get": { "tags": [ "Account" ], "summary": "Account balances", "description": "Balances and payout settings only. Lighter than the full account.", "operationId": "getAccountStats", "responses": { "200": { "description": "Account balances", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountStats" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ] } }, "/check/{login}": { "get": { "tags": [ "Account" ], "summary": "Check address", "description": "Whether the pool knows this address, and its last share. Returns `404` for an unknown address.", "operationId": "checkAccount", "responses": { "200": { "description": "Known address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Check" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ] } }, "/accounts/{login}/hashrates/{bucket}": { "get": { "tags": [ "Account" ], "summary": "Account hashrate chart", "description": "Hashrate history of the miner, one point per bucket.", "operationId": "getAccountHashrates", "responses": { "200": { "description": "Hashrate chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashrateChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } } ] } }, "/accounts/{login}/hashrates/{bucket}/{algo}": { "get": { "tags": [ "Account" ], "summary": "Account hashrate chart (per algorithm)", "description": "Hashrate history of the miner, one point per bucket. GRIN and MWC only: the chart for one algorithm.", "operationId": "getAccountHashratesByAlgo", "responses": { "200": { "description": "Hashrate chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashrateChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } }, { "name": "algo", "in": "path", "required": true, "description": "Algorithm: `32` on GRIN, `31` on MWC.", "schema": { "type": "string", "enum": [ "31", "32" ] } } ] } }, "/accounts/{login}/shares/{bucket}": { "get": { "tags": [ "Account" ], "summary": "Account shares chart", "description": "Valid, invalid and stale shares of the miner, one point per bucket.", "operationId": "getAccountShares", "responses": { "200": { "description": "Shares chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharesChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } } ] } }, "/accounts/{login}/shares/{bucket}/{algo}": { "get": { "tags": [ "Account" ], "summary": "Account shares chart (per algorithm)", "description": "Valid, invalid and stale shares of the miner, one point per bucket. GRIN and MWC only: the chart for one algorithm.", "operationId": "getAccountSharesByAlgo", "responses": { "200": { "description": "Shares chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharesChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } }, { "name": "algo", "in": "path", "required": true, "description": "Algorithm: `32` on GRIN, `31` on MWC.", "schema": { "type": "string", "enum": [ "31", "32" ] } } ] } }, "/accounts/{login}/settings": { "get": { "tags": [ "Account" ], "summary": "Payout settings", "description": "Current payout threshold and the allowed range.", "operationId": "getAccountSettings", "responses": { "200": { "description": "Payout settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettings" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ] }, "post": { "tags": [ "Account" ], "summary": "Change payout threshold", "description": "Sets the miner's minimum payout. To prove ownership, send the full IP address of the miner's most active worker; `config.ipHint` shows its last octet. Repeated wrong IPs can lock the account for changes.", "operationId": "setAccountSettings", "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettingsChange" } } } }, "responses": { "200": { "description": "Saved. Returns the new settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettings" } } } }, "400": { "description": "Unknown key or a value that is not a number." }, "403": { "description": "Changes are locked for this account." }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." }, "405": { "description": "The IP address does not match." }, "417": { "description": "The value is outside `allowedMinPayout`..`allowedMaxPayout`." } } } }, "/workers/{login}": { "get": { "tags": [ "Workers" ], "summary": "Workers", "description": "The miner's workers with hashrate and share counters.", "operationId": "getWorkers", "responses": { "200": { "description": "Workers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workers" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ] } }, "/workers/{login}/lastbeat": { "get": { "tags": [ "Workers" ], "summary": "Workers last share", "description": "Last share time of every worker. The lightest way to watch for offline rigs.", "operationId": "getWorkersLastBeat", "responses": { "200": { "description": "Last share per worker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkersLastBeat" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." } ] } }, "/workers/{login}/{worker}/hashrates/{bucket}": { "get": { "tags": [ "Workers" ], "summary": "Worker hashrate chart", "description": "Hashrate history of one worker, measured and reported.", "operationId": "getWorkerHashrates", "responses": { "200": { "description": "Hashrate chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashrateChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "worker", "in": "path", "required": true, "description": "Worker name (the part after the dot in the miner's login).", "schema": { "type": "string" } }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } } ] } }, "/workers/{login}/{worker}/hashrates/{bucket}/{algo}": { "get": { "tags": [ "Workers" ], "summary": "Worker hashrate chart (per algorithm)", "description": "Hashrate history of one worker, measured and reported. GRIN and MWC only: the chart for one algorithm.", "operationId": "getWorkerHashratesByAlgo", "responses": { "200": { "description": "Hashrate chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HashrateChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "worker", "in": "path", "required": true, "description": "Worker name (the part after the dot in the miner's login).", "schema": { "type": "string" } }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } }, { "name": "algo", "in": "path", "required": true, "description": "Algorithm: `32` on GRIN, `31` on MWC.", "schema": { "type": "string", "enum": [ "31", "32" ] } } ] } }, "/workers/{login}/{worker}/shares/{bucket}": { "get": { "tags": [ "Workers" ], "summary": "Worker shares chart", "description": "Valid, invalid and stale shares of one worker.", "operationId": "getWorkerShares", "responses": { "200": { "description": "Shares chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharesChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "worker", "in": "path", "required": true, "description": "Worker name (the part after the dot in the miner's login).", "schema": { "type": "string" } }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } } ] } }, "/workers/{login}/{worker}/shares/{bucket}/{algo}": { "get": { "tags": [ "Workers" ], "summary": "Worker shares chart (per algorithm)", "description": "Valid, invalid and stale shares of one worker. GRIN and MWC only: the chart for one algorithm.", "operationId": "getWorkerSharesByAlgo", "responses": { "200": { "description": "Shares chart", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharesChart" } } } }, "404": { "description": "Unknown miner address (or worker), or an invalid bucket." } }, "parameters": [ { "name": "login", "in": "path", "required": true, "description": "Miner's wallet address, as used in the miner's configuration.", "schema": { "type": "string" }, "example": "kaspa:qz0s9c..." }, { "name": "worker", "in": "path", "required": true, "description": "Worker name (the part after the dot in the miner's login).", "schema": { "type": "string" } }, { "name": "bucket", "in": "path", "required": true, "description": "Size of one chart point.", "schema": { "type": "string", "enum": [ "5m", "30m", "6h" ] } }, { "name": "algo", "in": "path", "required": true, "description": "Algorithm: `32` on GRIN, `31` on MWC.", "schema": { "type": "string", "enum": [ "31", "32" ] } } ] } } }, "components": { "schemas": { "Node": { "type": "object", "properties": { "name": { "type": "string", "description": "Node name.", "example": "kas_pplns" }, "height": { "type": "string", "description": "Current block height.", "example": "593203136" }, "height_eu2": { "type": "string", "description": "Height seen by the pool's second, third... server (multi-server pools: ERG, ETC, KAS, RVN). Also `height_eu3`, `height_eu4`, `height_eu5`." }, "difficulty": { "type": "string", "description": "Network difficulty.", "example": "32578829425393544" }, "networkhashps": { "type": "string", "description": "Network hashrate, H/s.", "example": "4208987930067163" }, "avgBlockTime": { "type": "string", "description": "Average block time, seconds.", "example": "1.00" }, "blockReward": { "type": "string", "description": "Block reward, in the pool's base unit (not on every coin)." }, "lastBeat": { "type": "string", "description": "Last node update, Unix seconds.", "example": "1794740744" }, "dagSize": { "type": "string", "description": "DAG size, bytes (ETC, ETHW, RVN, QUAI-KawPoW)." }, "epoch": { "type": "string", "description": "Current epoch (ETC, ETHW, RVN, QUAI-KawPoW)." }, "baseFeePerGas": { "type": "string", "description": "Base fee per gas (ETHW)." }, "epochIndex": { "type": "string", "description": "Epoch index (CKB)." }, "epochLength": { "type": "string", "description": "Epoch length (CKB)." }, "epochNumber": { "type": "string", "description": "Epoch number (CKB)." }, "minDiff": { "type": "string", "description": "Minimum share difficulty (GRIN, MWC)." }, "primaryWeight31": { "type": "string", "description": "Cuckaroo31 primary weight (MWC)." }, "primaryWeight32": { "type": "string", "description": "Cuckatoo32 primary weight (GRIN)." } }, "description": "Blockchain node as seen by the pool. All values are strings." }, "PoolRoundStats": { "type": "object", "properties": { "lastBlockFound": { "type": "integer", "format": "int64", "description": "When the pool last found a block, Unix seconds." }, "roundShares": { "type": "integer", "format": "int64", "description": "Shares in the current round." }, "nShares": { "type": "integer", "format": "int64", "description": "PPLNS window size (N), in shares." }, "eu_sessions": { "type": "integer", "format": "int64", "description": "Open stratum sessions on the main server." }, "eu2_sessions": { "type": "integer", "format": "int64", "description": "Open sessions on the second server (multi-server pools). Also `eu3_sessions`, `eu4_sessions`, `eu5_sessions`." } }, "description": "Current round." }, "PoolStats": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "now": { "type": "integer", "format": "int64", "description": "Server time, Unix milliseconds." }, "hashrate": { "type": "number", "description": "Pool hashrate, H/s.", "example": 4208987930067163 }, "hashrates": { "type": "object", "description": "GRIN/MWC: pool hashrate per algorithm.", "additionalProperties": { "type": "number" } }, "minersTotal": { "type": "integer", "format": "int64", "description": "Miners online." }, "workersTotal": { "type": "integer", "format": "int64", "description": "Workers online." }, "candidatesTotal": { "type": "integer", "format": "int64", "description": "Blocks found but not yet confirmed." }, "immatureTotal": { "type": "integer", "format": "int64", "description": "Blocks waiting for maturity." }, "maturedTotal": { "type": "integer", "format": "int64", "description": "Matured blocks found by the pool, all time." }, "luck": { "type": "number", "description": "Luck of the current round, percent (shares submitted / network difficulty × 100)." }, "minPayout": { "type": "number", "description": "Default minimum payout, in whole coins (not on every coin)." }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/Node" } }, "stats": { "$ref": "#/components/schemas/PoolRoundStats" } }, "required": [ "apiVersion", "now", "hashrate", "minersTotal", "workersTotal", "nodes", "stats" ] }, "RegionShare": { "type": "object", "properties": { "hr": { "type": "number", "description": "Hashrate from this country, H/s." }, "miners": { "type": "integer", "format": "int64", "description": "Miners from this country." }, "percent": { "type": "number", "description": "Share of the pool hashrate, percent." } }, "required": [ "hr", "miners", "percent" ] }, "RegionStats": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "now": { "type": "integer", "format": "int64", "description": "Server time, Unix milliseconds." }, "hashrate": { "type": "number", "description": "Pool hashrate, H/s." }, "hashrates": { "type": "object", "description": "GRIN/MWC: pool hashrate per algorithm.", "additionalProperties": { "type": "number" } }, "minersTotal": { "type": "integer", "format": "int64" }, "workersTotal": { "type": "integer", "format": "int64" }, "stats": { "type": "object", "description": "Keyed by ISO country code (lower case, `unknown` when the IP has no country). On GRIN and MWC there is one more level: algorithm first, then country.", "additionalProperties": { "oneOf": [ { "$ref": "#/components/schemas/RegionShare" }, { "type": "object", "description": "GRIN/MWC: countries of one algorithm.", "additionalProperties": { "$ref": "#/components/schemas/RegionShare" } } ] } } } }, "MinerSummary": { "type": "object", "properties": { "lastBeat": { "type": "integer", "format": "int64", "description": "Last share, Unix seconds." }, "hr": { "type": "number", "description": "Hashrate, H/s." }, "offline": { "type": "boolean", "description": "No recent shares." }, "currentLuck": { "type": "string", "description": "Not on every coin." }, "bits": { "type": "string", "description": "Algorithm (GRIN, MWC)." } } }, "MinersMultiAlgo": { "type": "object", "properties": { "hashrate": { "type": "number" }, "miners": { "type": "object", "description": "Keyed by miner address.", "additionalProperties": { "$ref": "#/components/schemas/MinerSummary" } }, "total": { "type": "integer", "format": "int64" } } }, "Miners": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "now": { "type": "integer", "format": "int64", "description": "Server time, Unix milliseconds." }, "hashrate": { "type": "number", "description": "Pool hashrate, H/s." }, "hashrates": { "type": "object", "description": "GRIN/MWC: pool hashrate per algorithm.", "additionalProperties": { "type": "number" } }, "minersTotal": { "type": "integer", "format": "int64" }, "workersTotal": { "type": "integer", "format": "int64" }, "miners": { "type": "object", "description": "Online miners, keyed by miner address.", "additionalProperties": { "$ref": "#/components/schemas/MinerSummary" } }, "minersMulti": { "type": "object", "description": "GRIN/MWC: the same list split by algorithm.", "additionalProperties": { "$ref": "#/components/schemas/MinersMultiAlgo" } } } }, "Block": { "type": "object", "properties": { "height": { "type": "integer", "format": "int64" }, "timestamp": { "type": "integer", "format": "int64", "description": "Unix seconds." }, "hash": { "type": "string" }, "difficulty": { "type": "number", "description": "Network difficulty of the block." }, "shares": { "type": "number", "description": "Shares submitted in the round." }, "finder": { "type": "string", "description": "Address of the miner who found the block." }, "currentLuck": { "type": "string", "description": "Round luck, percent (not on every coin)." }, "orphan": { "type": "boolean" }, "reward": { "description": "Block reward. A number in the pool's base unit on most pools; a decimal string on ETC, ETHW, ERG, QTC and QUAI (wei on ETC, ETHW and QUAI).", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ] }, "uncle": { "type": "boolean", "description": "Uncle block (ETC, ETHW)." }, "uncleHeight": { "type": "integer", "format": "int64", "description": "ETC, ETHW." }, "extraReward": { "type": "integer", "format": "int64", "description": "KAS." }, "mevExtraReward": { "type": "string", "description": "ETHW, wei." }, "bits": { "type": "string", "description": "Algorithm (GRIN, MWC)." }, "BaseReward": { "type": "integer", "format": "int64", "description": "GRIN, MWC." }, "ExtraReward": { "type": "integer", "format": "int64", "description": "GRIN, MWC." } } }, "LuckWindow": { "type": "object", "properties": { "luck": { "type": "number", "description": "Average luck over the window (1 = 100%)." }, "orphanRate": { "type": "number", "description": "Share of orphaned blocks (0..1)." }, "uncleRate": { "type": "number", "description": "Share of uncle blocks (ETC, ETHW, ERG, QTC)." }, "extraBlocks": { "type": "integer", "format": "int64", "description": "KAS." } } }, "Blocks": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/Block" }, "description": "Found, not yet confirmed. `null` when empty.", "nullable": true }, "candidatesTotal": { "type": "integer", "format": "int64" }, "immature": { "type": "array", "items": { "$ref": "#/components/schemas/Block" }, "description": "Waiting for maturity. `null` when empty.", "nullable": true }, "immatureTotal": { "type": "integer", "format": "int64" }, "matured": { "type": "array", "items": { "$ref": "#/components/schemas/Block" }, "description": "Latest matured blocks. `null` when empty.", "nullable": true }, "maturedTotal": { "type": "integer", "format": "int64" }, "luck": { "type": "object", "description": "Luck over the last N blocks, keyed by N (`64`, `128`, `256`, `1024`; more on some pools).", "additionalProperties": { "$ref": "#/components/schemas/LuckWindow" } } } }, "FinderBlock": { "type": "object", "properties": { "finders": { "type": "string", "description": "Address of the miner who found the block." }, "hash": { "type": "string" }, "height": { "description": "Block height (a number on most pools).", "oneOf": [ { "type": "integer", "format": "int64" }, { "type": "string" } ] }, "timestamp": { "description": "Unix seconds (a string on most pools).", "oneOf": [ { "type": "string" }, { "type": "integer", "format": "int64" } ] }, "bits": { "type": "string", "description": "Algorithm (GRIN, MWC)." } } }, "Finders": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "findersBlock": { "type": "array", "items": { "$ref": "#/components/schemas/FinderBlock" }, "description": "Latest blocks with their finders. `null` when empty.", "nullable": true } } }, "PoolPayment": { "type": "object", "properties": { "tx": { "type": "string", "description": "Transaction id." }, "amount": { "type": "integer", "format": "int64", "description": "Base unit." }, "timestamp": { "type": "integer", "format": "int64", "description": "Unix seconds." }, "address": { "type": "string", "description": "Recipient (pools that pay one address per transaction)." }, "totalPayees": { "type": "integer", "format": "int64", "description": "Recipients in the transaction (pools that batch payouts)." }, "txFee": { "type": "integer", "format": "int64", "description": "Network fee, base unit (not on every coin)." }, "txKernelExcess": { "type": "string", "description": "GRIN, MWC." } } }, "PoolFinStats": { "type": "object", "properties": { "balance": { "type": "integer", "format": "int64", "description": "Unpaid balances of all miners, base unit." }, "immature": { "type": "integer", "format": "int64", "description": "Immature rewards of all miners, base unit." }, "pending": { "type": "integer", "format": "int64", "description": "Payouts in progress, base unit." }, "paid": { "type": "integer", "format": "int64", "description": "Paid out, all time, base unit." }, "totalMined": { "type": "integer", "format": "int64", "description": "Mined, all time, base unit." }, "lastCreditHeight": { "type": "integer", "format": "int64", "description": "Height of the last credited block." }, "lastCreditHash": { "type": "string", "description": "Hash of the last credited block." } } }, "Payments": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/PoolPayment" }, "description": "Latest payouts. `null` when empty.", "nullable": true }, "paymentsTotal": { "type": "integer", "format": "int64", "description": "Payouts, all time." }, "finstats": { "$ref": "#/components/schemas/PoolFinStats" } } }, "AccountConfig": { "type": "object", "properties": { "minPayout": { "type": "integer", "format": "int64", "description": "Miner's payout threshold, base unit." }, "defaultMinPayout": { "type": "integer", "format": "int64", "description": "Default threshold, base unit." }, "allowedMinPayout": { "type": "integer", "format": "int64", "description": "Lowest threshold the miner may set, base unit." }, "allowedMaxPayout": { "type": "integer", "format": "int64", "description": "Highest threshold the miner may set, base unit." }, "ipHint": { "type": "string", "description": "Masked IP of the miner's most active worker, e.g. `x.x.x.75`. Needed to change settings.", "example": "x.x.x.75" }, "ipWorkerName": { "type": "string", "description": "Worker that `ipHint` belongs to." }, "permitChanges": { "type": "boolean", "description": "Not on every coin." }, "paymentHubHint": { "type": "string", "description": "Payout currency when the miner is paid in another coin." } }, "description": "Payout settings." }, "AccountStatsBlock": { "type": "object", "properties": { "balance": { "type": "integer", "format": "int64", "description": "Unpaid balance, base unit." }, "immature": { "type": "integer", "format": "int64", "description": "Rewards waiting for block maturity, base unit." }, "pending": { "type": "integer", "format": "int64", "description": "Payout in progress, base unit." }, "paid": { "type": "integer", "format": "int64", "description": "Paid out, all time, base unit." }, "blocksFound": { "type": "integer", "format": "int64", "description": "Blocks found by this miner." }, "lastShare": { "type": "integer", "format": "int64", "description": "Last share, Unix seconds." }, "gas": { "type": "integer", "format": "int64", "description": "ETHW, QUAI." } }, "description": "Balances. Fields without data are omitted." }, "Worker": { "type": "object", "properties": { "lastBeat": { "type": "integer", "format": "int64", "description": "Last share, Unix seconds." }, "hr": { "type": "number", "description": "Hashrate, short average, H/s." }, "hr2": { "type": "number", "description": "Hashrate, long average, H/s." }, "rhr": { "type": "number", "description": "Hashrate reported by the mining software, H/s (0 if not reported)." }, "offline": { "type": "boolean" }, "sharesValid": { "type": "integer", "format": "int64" }, "sharesInvalid": { "type": "integer", "format": "int64" }, "sharesStale": { "type": "integer", "format": "int64" }, "bits": { "type": "string", "description": "Algorithm (GRIN, MWC)." } } }, "AccountPayment": { "type": "object", "properties": { "tx": { "type": "string", "description": "Transaction id." }, "amount": { "type": "integer", "format": "int64", "description": "Base unit." }, "timestamp": { "type": "integer", "format": "int64", "description": "Unix seconds." }, "txFee": { "type": "integer", "format": "int64", "description": "Network fee, base unit (not on every coin)." }, "txKernelExcess": { "type": "string", "description": "GRIN, MWC." } } }, "AccountReward": { "type": "object", "properties": { "blockheight": { "type": "integer", "format": "int64" }, "blockhash": { "type": "string", "description": "Not on every coin." }, "timestamp": { "type": "integer", "format": "int64", "description": "Unix seconds." }, "reward": { "type": "integer", "format": "int64", "description": "Miner's reward from this block, base unit." }, "percent": { "type": "number", "description": "Miner's share of the block reward (0..1)." }, "immature": { "type": "boolean" }, "orphan": { "type": "boolean" }, "currentLuck": { "type": "number", "description": "Round luck (not on every coin)." }, "uncle": { "type": "boolean", "description": "ETC, ETHW." } } }, "SumReward": { "type": "object", "properties": { "name": { "type": "string", "example": "Last 24 hours" }, "inverval": { "type": "integer", "format": "int64", "description": "Window length, seconds. The field name is misspelled in the API and is kept for compatibility.", "example": 86400 }, "reward": { "type": "integer", "format": "int64", "description": "Rewards in the window, base unit." }, "numreward": { "type": "integer", "format": "int64", "description": "Number of rewards in the window." }, "offset": { "type": "integer", "format": "int64", "description": "Not on every coin." } }, "description": "Rewards over a time window. Always 5 items: 1 hour, 12 hours, 24 hours, 7 days, 30 days." }, "ProfitPoint": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int64", "description": "Unix seconds." }, "interval": { "type": "integer", "format": "int64", "description": "Seconds." }, "profit": { "type": "integer", "format": "int64", "description": "Base unit." }, "numreward": { "type": "integer", "format": "int64" }, "currentLuck": { "type": "number" } }, "description": "KAS." }, "Account": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "updatedAt": { "type": "integer", "format": "int64", "description": "Unix milliseconds." }, "currentHashrate": { "description": "Hashrate. A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "number", "example": 373381931996867 }, { "type": "object", "description": "GRIN/MWC: hashrate per algorithm.", "additionalProperties": { "type": "number" } } ] }, "hashrate": { "description": "Hashrate. A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "number", "example": 373381931996867 }, { "type": "object", "description": "GRIN/MWC: hashrate per algorithm.", "additionalProperties": { "type": "number" } } ] }, "currentLuck": { "type": "string", "description": "Not on every coin." }, "roundShares": { "type": "integer", "format": "int64", "description": "Miner's shares in the current round." }, "sharesValid": { "description": "A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "integer", "format": "int64", "example": 22474 }, { "type": "object", "description": "GRIN/MWC: value per algorithm.", "additionalProperties": { "type": "integer", "format": "int64" } } ] }, "sharesInvalid": { "description": "A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "integer", "format": "int64", "example": 22474 }, { "type": "object", "description": "GRIN/MWC: value per algorithm.", "additionalProperties": { "type": "integer", "format": "int64" } } ] }, "sharesStale": { "description": "A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "integer", "format": "int64", "example": 22474 }, { "type": "object", "description": "GRIN/MWC: value per algorithm.", "additionalProperties": { "type": "integer", "format": "int64" } } ] }, "workers": { "type": "object", "description": "Keyed by worker name.", "additionalProperties": { "$ref": "#/components/schemas/Worker" } }, "workersOnline": { "type": "integer", "format": "int64" }, "workersOffline": { "type": "integer", "format": "int64" }, "workersTotal": { "type": "integer", "format": "int64" }, "stats": { "$ref": "#/components/schemas/AccountStatsBlock" }, "config": { "$ref": "#/components/schemas/AccountConfig" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/AccountPayment" }, "description": "Latest payouts, up to `pageSize`. `null` when empty.", "nullable": true }, "paymentsTotal": { "type": "integer", "format": "int64", "description": "Payouts, all time." }, "pageSize": { "type": "integer", "format": "int64", "description": "Maximum number of payouts returned." }, "rewards": { "type": "array", "items": { "$ref": "#/components/schemas/AccountReward" }, "description": "Rewards from recent blocks.", "nullable": true }, "sumrewards": { "type": "array", "items": { "$ref": "#/components/schemas/SumReward" } }, "24hreward": { "type": "integer", "format": "int64", "description": "Rewards in the last 24 hours, base unit." }, "24hnumreward": { "type": "integer", "format": "int64", "description": "Number of rewards in the last 24 hours." }, "profit": { "type": "array", "items": { "$ref": "#/components/schemas/ProfitPoint" }, "description": "KAS: hourly earnings." } } }, "AccountStats": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "shares": { "type": "integer", "format": "int64", "description": "CKB only: the miner's share counter." }, "updatedAt": { "type": "integer", "format": "int64", "description": "Unix milliseconds." }, "stats": { "$ref": "#/components/schemas/AccountStatsBlock" }, "config": { "$ref": "#/components/schemas/AccountConfig" } } }, "AccountSettings": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "config": { "$ref": "#/components/schemas/AccountConfig" } } }, "AccountSettingsChange": { "type": "object", "properties": { "ip": { "type": "string", "description": "Full IP address of the miner's most active worker (see `config.ipHint`). Proves that the caller controls the rig." }, "key": { "type": "string", "enum": [ "minPayout" ], "description": "Setting to change. Only `minPayout` is supported." }, "value": { "type": "string", "description": "New payout threshold in the pool's base unit, as a decimal string, between `allowedMinPayout` and `allowedMaxPayout`.", "example": "5000000000" } }, "required": [ "ip", "key", "value" ] }, "Check": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "lastShare": { "type": "integer", "format": "int64", "description": "Last share, Unix seconds." } } }, "Workers": { "type": "object", "properties": { "currentHashrate": { "description": "Hashrate. A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "number", "example": 373381931996867 }, { "type": "object", "description": "GRIN/MWC: hashrate per algorithm.", "additionalProperties": { "type": "number" } } ] }, "hashrate": { "description": "Hashrate. A number on most pools; on GRIN and MWC an object keyed by algorithm.", "oneOf": [ { "type": "number", "example": 373381931996867 }, { "type": "object", "description": "GRIN/MWC: hashrate per algorithm.", "additionalProperties": { "type": "number" } } ] }, "workers": { "type": "object", "description": "Keyed by worker name.", "additionalProperties": { "$ref": "#/components/schemas/Worker" } }, "workersOnline": { "type": "integer", "format": "int64" }, "workersOffline": { "type": "integer", "format": "int64" }, "workersTotal": { "type": "integer", "format": "int64" } } }, "WorkersLastBeat": { "type": "object", "properties": { "workers": { "type": "object", "description": "Keyed by worker name.", "additionalProperties": { "type": "object", "properties": { "lastBeat": { "type": "integer", "format": "int64", "description": "Last share, Unix seconds." } } } } } }, "Point": { "type": "object", "properties": { "x": { "type": "integer", "format": "int64", "description": "Start of the bucket, Unix seconds." }, "y": { "type": "number" } }, "description": "Chart point." }, "HashrateChart": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "bucket": { "type": "string", "example": "5m" }, "actual": { "type": "array", "items": { "$ref": "#/components/schemas/Point" }, "description": "Hashrate measured by the pool, H/s, newest first. `null` when empty.", "nullable": true }, "reported": { "type": "array", "items": { "$ref": "#/components/schemas/Point" }, "description": "Worker charts only: hashrate reported by the mining software (filled on RVN and XNA). `null` when empty.", "nullable": true } } }, "SharesChart": { "type": "object", "properties": { "apiVersion": { "type": "integer", "format": "int64", "description": "API format version. Always `200`.", "example": 200 }, "bucket": { "type": "string", "example": "5m" }, "valid": { "type": "array", "items": { "$ref": "#/components/schemas/Point" }, "description": "Valid shares per bucket, newest first. `null` when empty.", "nullable": true }, "invalid": { "type": "array", "items": { "$ref": "#/components/schemas/Point" }, "description": "Invalid shares per bucket. `null` when empty.", "nullable": true }, "stale": { "type": "array", "items": { "$ref": "#/components/schemas/Point" }, "description": "Stale shares per bucket. `null` when empty.", "nullable": true } } } } } }