List Granted Miners
Returns miners from a farm shared with the caller through a cross-organization grant. The grant must include the requested farm.
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)
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Miner, hashboard, power supply, or controller serial number (single value)
1"HTM3FS28HD25011939878367054H36045"
Filter miners by MAC address
1"AA:BB:CC:DD:EE:FF"
Filter miners by status.
Accepts both run status (online, stale) and preset tags (archived, maintenance, retired, off_rack, transit).
Run status and tags are independent axes — filtering by online does NOT exclude miners carrying tags.
For new clients prefer tags for tag 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, offline, stale, sleep, unknown, archived, off_rack, transit, maintenance, retired, error, low_hashrate, overheated, overpower, underpower, overclocking "online"
Filter miners by tags (operator-managed labels). Overlap match — a miner matches if it carries any of the values.
Preset values: maintenance, retired, off_rack, transit, archived, plus free-form custom tags.
Supports multiple values separated by , or multiple query parameters.
1"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.
x >= 00.8
Upper bound of hashrate realization rate. No hard cap (allows >1 for overclocked miners).
x >= 01.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).
1Filter 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.
10^(?:(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)\/(?:3[0-2]|[12]?\d)|(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)-(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)|(?:(25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?))$"192.168.1.5,192.168.144.0/24,10.0.0.1-10.0.0.50"