List Miners
Returns real-time mining status for all miners in the specified farm. The information includes hashrate, power consumption, temperature, mining status, hardware details, and error information
Authorizations
Clerk Machine API Key for authentication
Query Parameters
Page number (default: 1)
x >= 11
Number of items per page (default: 10, max: 10000)
1 <= x <= 1000010
Agent Id (uuid generated by nonce system)
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Miner sn/hashboard sn/power supply sn/controller sn.(single value)
"HTM3FS28HD25011939878367054H36045, HLM3FSFF594C06X60006"
Filter miners by MAC address
"AA:BB:CC:DD:EE:FF"
Filter miners by status.
Accepts both run status (online, stale) and ops status (archived, maintenance, retired, off_rack, transit).
Run status and ops status are independent axes — filtering by online does NOT exclude miners with an ops_status set.
For new clients prefer ops_status for ops-state filtering and status for connectivity-state filtering.
Supports multiple values separated by , (e.g., "online,stale") or multiple query parameters (e.g., "status=online&status=stale").
Available statuses:
- online: Miner is actively mining and connected
- offline: Miner is not connected or powered off
- stale: Miner data is stale (no recent updates)
- archived: (Asset) Miner has been archived
- off_rack: (Asset) Miner is removed from rack
- transit: (Asset) Miner is in transit
- maintenance: (Asset) Miner is under maintenance
- retired: (Asset) Miner has been retired
- error: Deprecated. Use anomaly_filters.
- low_hashrate: Deprecated. Use hashrate_realization range.
- overheated: Deprecated. Use anomaly_filters=temperature.
- overpower: Deprecated. Use anomaly_filters=power.
- underpower: Deprecated. Use anomaly_filters=power.
- overclocking: Deprecated. Use mining_modes_in with overclocking presets.
"online"
Exclude miners by status (NOT IN semantics) — the complement of status.
Accepts the same values as status; combine with status to include some and exclude others.
Primary use: status_exclude=stale selects the online scope (status <> stale), matching the
overview "online/healthy/abnormal/sleep" cards. Supports ,-separated or repeated params.
"stale"
Filter miners by ops status (operator-managed state).
Values: maintenance, retired, off_rack, transit, archived.
Supports multiple values separated by , or multiple query parameters.
"archived"
Unstable filter. true returns only miners with non-null unstable_reason (mac/sn unreliable). Omit, null, or false to include unstable miners.
false
Abnormal axis (the whole anomaly_flags bitmask, not a specific type).
true = any anomaly bit set (anomaly_flags <> 0) — the overview "abnormal" scope.
false = no anomaly bits (anomaly_flags = 0) — the fault-free scope behind "healthy"/"sleep".
Omit to include both. Prefer this over OR-ing all anomaly_filters for the abnormal aggregate.
false
Filter miners by anomaly type (OR semantics — returns miners matching ANY of the specified types). Available values: fan, power, temperature, hashboard, network, firmware, unknown, control_board, pool, low_hashrate. Corresponds to bits in the anomaly_flags bitmask field on each miner. Accepts repeated array (anomaly_filters[]=fan&anomaly_filters[]=power), comma-separated string (anomaly_filters=fan,power), or single value (anomaly_filters=fan).
fan, power, temperature, hashboard, network, firmware, unknown, control_board, pool, low_hashrate Lower bound of hashrate realization rate (actual / expected). 1.0 = 100%. Miners with NULL or 0 expected_hashrate are excluded.
0.8
Upper bound of hashrate realization rate. No hard cap (allows >1 for overclocked miners).
1.2
Filter miners by mining_mode value (OR semantics — returns miners matching ANY of the specified modes). Accepts repeated array (mining_modes_in[]=high&mining_modes_in[]=power_tuning), comma-separated string (mining_modes_in=high,power_tuning), or single value (mining_modes_in=high).
["high", "power_tuning", "hashrate_tuning"]Exclude miners by mining_mode value (NOT IN semantics) — the complement of mining_modes_in.
Primary use: mining_modes_not_in=sleep excludes sleepers, matching the overview "healthy" card
(fault-free, non-sleep). Accepts repeated array, comma-separated string, or single value.
["sleep"]Filter miners by IPv4 ranges. A miner matches if its IP falls into any of the provided ranges. Each item accepts one of three forms:
- single address (e.g.
192.168.1.5) - CIDR (e.g.
192.168.1.0/24) - hyphen range (e.g.
192.168.1.1-192.168.1.254, inclusive) Supports multiple values separated by,or repeated query parameters.
"192.168.1.5,192.168.144.0/24,10.0.0.1-10.0.0.50"