Skip to main content
GET
List Miners

Authorizations

Authorization
string
header
required

Clerk Machine API Key for authentication

Path Parameters

workspace_id
string
required
farm_id
string
required

Query Parameters

page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

pageSize
number

Number of items per page (default: 10, max: 10000)

Required range: 1 <= x <= 10000
Example:

10

agent_id
string<uuid>

Agent Id (uuid generated by nonce system)

Pattern: ^([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)$
Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

sn
string

Miner, hashboard, power supply, or controller serial number (single value)

Minimum string length: 1
Example:

"HTM3FS28HD25011939878367054H36045"

mac
string

Filter miners by MAC address

Minimum string length: 1
Example:

"AA:BB:CC:DD:EE:FF"

status
enum<string>[]

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.
Available options:
online,
offline,
stale,
sleep,
unknown,
archived,
off_rack,
transit,
maintenance,
retired,
error,
low_hashrate,
overheated,
overpower,
underpower,
overclocking
Example:

"online"

tags
string[]

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.

Minimum string length: 1
Example:

"archived"

unstable
boolean

Unstable filter. true returns only miners with non-null unstable_reason (mac/sn unreliable). Omit, null, or false to include unstable miners.

Example:

false

has_anomaly
boolean

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.

Example:

false

anomaly_filters
enum<string>[]

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).

Available options:
fan,
power,
temperature,
hashboard,
network,
firmware,
unknown,
control_board,
pool,
low_hashrate
Example:
hashrate_realization_min
number

Lower bound of hashrate realization rate (actual / expected). 1.0 = 100%. Miners with NULL or 0 expected_hashrate are excluded.

Required range: x >= 0
Example:

0.8

hashrate_realization_max
number

Upper bound of hashrate realization rate. No hard cap (allows >1 for overclocked miners).

Required range: x >= 0
Example:

1.2

mining_modes_in
string[]

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).

Minimum string length: 1
Example:
ip_ranges
string[]

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.
Maximum array length: 10
Pattern: ^(?:(?:(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?))$
Example:

"192.168.1.5,192.168.144.0/24,10.0.0.1-10.0.0.50"

Response

Successfully retrieved miner status

success
boolean
required

Indicates if the request was successful

Example:

true

data
Miner · object[]
required

Array of items

pagination
object
required

Pagination metadata

error
null
required

Error object (null on success)

Example:

null