Documentation
Worker, Wallet Statistics, and Chart API
RustMinerSystem port charts, worker lists, wallet statistics, independent fee ratios, logs, and TCP connection endpoints.
Worker, Wallet Statistics, and Chart API
These endpoints power the port-detail page and dashboard. GET calls are suitable for read-only monitoring; ratio mutations affect actual fee behavior.
Charts and system statistics
| Method | Path | Purpose |
|---|---|---|
| GET | /api/stat/currency/{currency} |
Total hashrate history for a currency. |
| GET | /api/stat/port/{id} |
Hashrate history for a listen port. |
| GET | /api/stat/worker/{id} |
Hashrate history for a worker. |
| GET | /api/device/stats |
Total device-count history. |
| GET | /api/currency/online/stat/{coin} |
Online-device history for one coin. |
| GET | /api/sys/stat |
CPU, memory, receive, and transmit history. |
| GET | /api/sys/base/info |
Current system-resource snapshot. |
History endpoints usually return arrays. Timestamp and unit conventions can vary by backend version.
Worker list
GET /api/port/{id}/g/workers?device=0&size=50&page=1&col=s_thh&desc=1&wallet=...
| Query | Meaning |
|---|---|
device |
Worker-state filter; the frontend defaults to 0. |
size |
Page size. |
page |
Page number. |
col |
Sort field, such as s_thh. |
desc |
1 for descending, 0 for ascending. |
wallet |
Optional comma-separated wallet filter. |
Fields consumed by the frontend include:
{
"workers": [],
"total": 0,
"stat": {
"online": 0,
"offline": 0,
"s_thh": 0
}
}
Wallet summaries and favorites
| Method | Path | Purpose |
|---|---|---|
| GET | /api/port/{id}/g/wallet/list |
Read wallets available for filtering. |
| GET | /api/port/{id}/g/wallets/{collect} |
Read wallet summaries; collect controls favorites filtering. |
| POST | /api/port/{id}/wallet/collect |
Add or remove a wallet favorite. |
{
"wallet": "<wallet or subaccount>",
"f": 1
}
f=1 adds the favorite; f=0 removes it.
Per-wallet fee ratio
| Method | Path | Purpose |
|---|---|---|
| GET | /api/port/{id}/wallet/ratio |
Read independent wallet ratios. |
| POST | /api/port/{id}/wallet/ratio |
Set the ratio for one miner wallet and fee wallet. |
| DELETE | /api/port/{id}/wallet/{wallet_name}/ratio |
Restore the wallet’s default ratio. |
{
"wallet": "<miner's wallet>",
"wid": 10,
"r": 0.01
}
wid is the fee-wallet ID, and r is a 0–1 fraction.
Per-worker fee ratio
Read the current ratio:
GET /api/wallet/{wallet_id}/worker/{sid}/ratio
Set or restore it:
POST /api/port/{id}/worker/ratio
<custom header name>: <API credential>
{
"sid": "<worker session ID>",
"wid": 10,
"r": 0.01,
"f": 1
}
f=1 saves an independent ratio; f=0 restores the default.
Logs and connections
| Method | Path | Purpose |
|---|---|---|
| GET | /api/port/{id}/log |
Read port logs. |
| GET | /api/group/{gid}/log |
Read worker-group connect/disconnect logs. |
| GET | /api/worker/{id}/error/log |
Read a worker’s failure data stream. |
| GET | /api/port/{id}/ips?page=1&size=20 |
Read active TCP connections for a port. |
The TCP response normally contains data, size, page, pages, and total.
