Skip to main content
POST
Search Miners

Authorizations

Authorization
string
header
required

Clerk OAuth JWT access token

Path Parameters

workspace_id
string
required
farm_id
string<uuid>
required
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)$

Body

application/json
status
object

Filter by system-managed miner reporting status

Example:
tags
object

Filter by exact operator-managed miner tags

Example:
mining_mode
object

Filter by exact raw mining mode values

Example:
network_mode
object

Filter by network mode. unknown matches miners whose firmware does not report a mode or that have not been collected yet.

Example:

Structured search against one miner field

Example:
sort
Miner Sort · object[]

Ordered miner sort clauses

Minimum array length: 1
Example:
hashrate
Nonnegative Numeric Range · object

Hashrate range in H/s

Example:
power
Nonnegative Numeric Range · object

Power range in watts

Example:
temperature
Numeric Range · object

Temperature range in celsius

Example:
efficiency
Nonnegative Numeric Range · object

Efficiency range in J/TH

Example:
runtime
Nonnegative Numeric Range · object

Runtime range in seconds

Example:
hashrate_realization
Nonnegative Numeric Range · object

Hashrate realization ratio range, where 0.8 means 80%

Example:
last_updated_at
Date Range · object

Last report timestamp range

Example:
rack
string

Exact rack identifier

Minimum string length: 1
ip_ranges
string[]
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?))$
anomaly_flags
object

Filter by anomaly type. Uses bitmask matching against the anomaly_flags field.

Example:
page
integer
default:1
Required range: x <= 9007199254740991
page_size
integer
default:20
Required range: x <= 10000

Response

Miners matching the structured search criteria

success
enum<boolean>
required
Available options:
true
data
MinerSummary · object[]
required
pagination
object
required
error
null
required
Example:

null