KoInIuM - koinium.it

KoInIuM API Documentation

Public REST API for querying pool status, coin data, and account balances. All endpoints return JSON. No authentication required.

Base URL:

https://koinium.it/api/

⚠️ Rate limit: max 10 requests per minute per IP. Returns HTTP 503 when the server is overloaded.

`/api/status`	10 req/min
`/api/currencies`	10 req/min
`/api/wallet`	10 req/min
`/api/walletEx`	60 req/min

HTTP Error Responses
503 Disabled, server overloaded — The server is under heavy load. Retry after a few seconds.
Empty response (HTTP 200) — Rate limit exceeded, username not found, or account locked.

GET /api/status Pool Status

Returns per-algorithm statistics including hashrate, workers, fees, and profitability estimates.

💾 Cached for 30s · Only algorithms with at least one active coin are listed.

בקשה:

GET https://koinium.it/api/status

תוצאה:

{
    "neoscrypt": {
        "name": "neoscrypt",
        "port": 4233,
        "coins": 8,
        "fees": 1,
        "fees_solo": 1,
        "hashrate": 1713606082,
        "hashrate_shared": 0,
        "hashrate_solo": 1713606082,
        "workers": 4,
        "workers_shared": 4,
        "workers_solo": 0,
        "estimate_current": "0.00060081",
        "estimate_last24h": "0.00115378",
        "actual_last24h": "0.78165",
        "mbtc_mh_factor": 1000,
        "hashrate_last24h": 194871868.3474
    },
    "scrypt": {
        "name": "scrypt",
        "port": 3433,
        "coins": 44,
        "fees": 1,
        "fees_solo": 1,
        "hashrate": 4018714999,
        "hashrate_shared": 0,
        "hashrate_solo": 4018714999,
        "workers": 5,
        "workers_shared": 5,
        "workers_solo": 0,
        "estimate_current": "0.00001353",
        "estimate_last24h": "0.00001915",
        "actual_last24h": "0.01302",
        "mbtc_mh_factor": 1000,
        "hashrate_last24h": 2924587603.0316
    },
    "sha256d": {
        "name": "sha256d",
        "port": 3333,
        "coins": 51,
        "fees": 1,
        "fees_solo": 1,
        "hashrate": 2942351756548700,
        "hashrate_shared": 0,
        "hashrate_solo": 2942351756548700,
        "workers": 19,
        "workers_shared": 19,
        "workers_solo": 0,
        "estimate_current": "0.00140124",
        "estimate_last24h": "0.00124114",
        "actual_last24h": "1.12292",
        "mbtc_mh_factor": 1000000000,
        "hashrate_last24h": 2565716809809990
    }
}

📋 Field Descriptions

Field	Type	Description
`name`	string	Algorithm name
`port`	int	Stratum port number
`coins`	int	Number of active coins for this algorithm
`fees`	float	Shared mining fee (%)
`fees_solo`	float	Solo mining fee (%)
`hashrate`	int	Total pool hashrate (H/s)
`hashrate_shared`	int	Shared miners hashrate (H/s)
`hashrate_solo`	int	Solo miners hashrate (H/s)
`workers`	int	Total connected workers
`workers_shared`	int	Connected shared workers (password without `m=solo`)
`workers_solo`	int	Connected solo workers (password contains `m=solo`)
`estimate_current`	string	Current estimated profitability (mBTC/factor/day, net of fees)
`estimate_last24h`	string	Average estimated profitability over last 24h
`actual_last24h`	string	Actual profitability over last 24h (mBTC/factor/day)
`mbtc_mh_factor`	int	Hashrate unit factor: ×1000 for scrypt/neoscrypt (mBTC/MH/day), ×10⁹ for sha256d (mBTC/GH/day)
`hashrate_last24h`	float	Average pool hashrate over last 24h (H/s)

GET /api/currencies Currencies

Returns per-coin statistics for all active, non-AuxPoW coins. Includes block data, hashrate, and profitability.

💾 Cached for 15s
🔒 Ninja coins have masked details for privacy (symbol shown as NNJ).
📌 Excludes AuxPoW and PoS coins. Keyed by coin symbol.

בקשה:

GET https://koinium.it/api/currencies

תוצאה:

{
    "EMC2": {
        "name": "Einsteinium",
        "algo": "scrypt",
        "port": 3433,
        "reward": 0.975,
        "blocktime": null,
        "height": 11770756,
        "difficulty": 18.0935557,
        "minimumPayment": 0.001,
        "fees": 1,
        "fees_solo": 1,
        "miners": 0,
        "workers": 5,
        "workers_shared": 5,
        "workers_solo": 0,
        "shares": 14,
        "hashrate": 934584883.6096,
        "hashrate_shared": "0",
        "hashrate_solo": 934584883.6096,
        "network_hashrate": 873159887.6388,
        "estimate": "0.01403",
        "24h_blocks": 257,
        "24h_blocks_shared": 0,
        "24h_blocks_solo": 0,
        "24h_btc": 1.99e-06,
        "lastblock": 11770754,
        "lastblock_shared": 0,
        "lastblock_solo": 0,
        "timesincelast": 293,
        "timesincelast_shared": 0,
        "timesincelast_solo": 0
    },
    "NNJ": {
        "name": "Ninja",
        "algo": "sha256d",
        "port": 3333,
        "reward": 1,
        "blocktime": 0,
        "height": 0,
        "difficulty": 0,
        "minimumPayment": 0.001,
        "fees": 1,
        "fees_solo": 1,
        "miners": 0,
        "workers": 22,
        "workers_shared": 22,
        "workers_solo": 0,
        "shares": 131,
        "hashrate": "0",
        "hashrate_shared": "0",
        "hashrate_solo": "0",
        "network_hashrate": 0,
        "estimate": "1.27275",
        "24h_blocks": 0,
        "24h_blocks_shared": 0,
        "24h_blocks_solo": 0,
        "24h_btc": 0,
        "lastblock": 0,
        "lastblock_shared": 0,
        "lastblock_solo": 0,
        "timesincelast": 0,
        "timesincelast_shared": 0,
        "timesincelast_solo": 0,
        "ninja": true
    },
    ...
}

📋 Field Descriptions

Field	Type	Description
`name`	string	Coin name (masked as "Ninja" for ninja coins)
`algo`	string	Mining algorithm (`sha256d`, `scrypt`, `neoscrypt`)
`port`	int	Stratum port. May be coin-specific if configured in `db_stratums`, otherwise the algo default
`reward`	float	Current block reward (may include fees for coins like BTC)
`blocktime`	int\|null	Target block time in seconds. Can be null if not set in the database
`height`	int	Current blockchain height (0 for ninja coins)
`difficulty`	float	Current network difficulty (0 for ninja coins)
`minimumPayment`	float	Minimum withdrawal amount (BTC equivalent). Max of global minimum (0.001) and per-coin minimum
`fees` / `fees_solo`	float	Shared / Solo mining fees (%)
`miners`	int	Unique accounts targeting this coin (with active workers)
`workers`	int	Total connected workers mining this coin (includes workers on default coinid=6)
`workers_shared` / `workers_solo`	int	Workers split by mining mode
`shares`	int	Share count since the last block was found
`hashrate`	float\|string	Pool hashrate on this coin (H/s). Returns string `"0"` when no hashrate, numeric otherwise
`hashrate_shared` / `hashrate_solo`	float\|string	Hashrate split by mode (same type behavior as `hashrate`)
`network_hashrate`	float	Estimated total network hashrate (0 for ninja coins)
`estimate`	string	Estimated profitability (mBTC/MH/day)
`24h_blocks`	int	Blocks found by pool in last 24h
`24h_blocks_shared` / `24h_blocks_solo`	int	Blocks split by mode
`24h_btc`	float	BTC earned in last 24h
`lastblock`	int	Height of last block found by pool (0 if none or ninja)
`lastblock_shared` / `lastblock_solo`	int	Last block height split by mode
`timesincelast`	int	Seconds since last found block (0 if none)
`timesincelast_shared` / `timesincelast_solo`	int	Time since last block split by mode
`symbol`	string	Optional. Present only when the coin has an alternate ticker symbol (`symbol2`)
`ninja`	bool	Optional. Present and `true` only for ninja-flagged coins. All identifying details are masked

GET /api/wallet Account Status

Returns balance summary for a registered account. The "username" parameter is required.

בקשה:

GET https://koinium.it/api/wallet?username=USERNAME

ℹ️ The legacy parameter "address" is still accepted for backward compatibility.

תוצאה:

{
    "currency": "BTC",
    "unsold": 0.00050362,
    "balance": 0.00120000,
    "unpaid": 0.00170362,
    "paid24h": 0.00000000,
    "total": 0.00170362
}

📋 Field Descriptions

Field	Type	Description
`currency`	string	Payout coin symbol (based on account's `coinid`). Masked as "NNJ" for ninja coins
`unsold`	float	Earnings from mined coins not yet exchanged (converted to BTC equivalent)
`balance`	float	Available balance ready for withdrawal
`unpaid`	float	Total unpaid = unsold + balance
`paid24h`	float	Total paid (withdrawn) in the last 24 hours
`total`	float	Grand total = unpaid + paid24h

Returns empty response if username not found or account is locked.

GET /api/walletEx Account Status (Extended)

Extended account info including per-worker details (hashrate, difficulty, version).

בקשה:

GET https://koinium.it/api/walletEx?username=USERNAME

ℹ️ The legacy parameter "address" is still accepted for backward compatibility.

תוצאה:

{
    "currency": "BTC",
    "unsold": 0.00050362,
    "balance": 0.00120000,
    "unpaid": 0.00170362,
    "paid24h": 0.00000000,
    "total": 0.00170362,
    "miners": [
        {
            "version": "BFGMiner/5.5.0",
            "password": "d=65536,m=solo",
            "ID": "antminer-s19",
            "algo": "sha256d",
            "difficulty": 65536,
            "subscribe": 1,
            "accepted": 82463372.083,
            "rejected": 0
        }
    ]
}

📋 Field Descriptions — miners[]

Field	Type	Description
`version`	string	Mining software user-agent string
`password`	string	Stratum password (contains difficulty `d=` and mining mode `m=` options)
`ID`	string	Worker/device name
`algo`	string	Algorithm the worker is mining
`difficulty`	float	Current share difficulty assigned to this worker
`subscribe`	int	Whether the worker supports mining.subscribe (1=yes, 0=no)
`accepted`	float	Accepted share rate (weighted difficulty sum)
`rejected`	float	Rejected share rate

Returns empty response if username not found or account is locked. Workers are sorted by password.

Endpoints

Endpoint	Description	Auth	Cache	Rate Limit
`/api/status`	Per-algorithm pool statistics	—	30s	10/min
`/api/currencies`	Per-coin statistics (non-AuxPoW, non-PoS)	—	15s	10/min
`/api/wallet?username=X`	Account balance summary	Username	—	10/min
`/api/walletEx?username=X`	Extended: balance + active workers	Username	—	60/min

Notes:
· Hashrate values are in H/s (hashes per second). In /api/status hashrate values are integers; in /api/currencies they may be numeric or string "0" when zero.
· Estimates are in mBTC/MH/day (adjusted by mbtc_mh_factor for each algorithm). Use mbtc_mh_factor to interpret the unit: ×1000 = mBTC/MH/day (scrypt, neoscrypt), ×10⁹ = mBTC/GH/day (sha256d).
· Ninja coins have masked details for privacy (symbol shown as NNJ).
· blocktime may be null when not available from the daemon.
· Admin IPs bypass rate limiting and overload checks.