Skip to main content
POST
/
private-api
/
v1
/
{workspace_id}
/
farms
/
{farm_id}
/
miner
/
search
Search Miners
curl --request POST \
  --url https://api.nonce.app/private-api/v1/{workspace_id}/farms/{farm_id}/miner/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": {
    "contains": "S19"
  },
  "sn": {
    "contains": "S19"
  },
  "mac": {
    "contains": "S19"
  },
  "lifecycle_statuses": {
    "in": [
      "online",
      "offline"
    ]
  },
  "health_statuses": {
    "in": [
      "online",
      "offline"
    ]
  },
  "ip_ranges": [
    "192.168.1.5",
    "192.168.144.0/24",
    "10.0.0.1-10.0.0.50"
  ],
  "page": 4503599627370496,
  "limit": 5000
}
'
{
  "success": true,
  "data": [
    {
      "id": "002b1a50fa281efe0f320ebc39f5047b",
      "farm_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "farm": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "name": "Farm Name"
      },
      "workspace_id": "org_xxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "serial_number": "HTM3FS28HD25011939878367054H36045",
      "model": "Antminer S19",
      "ip": "192.168.1.100",
      "mac": "00:1B:44:11:3A:B7",
      "firmware_version": "20250304.15.REL",
      "rack": "A1",
      "position": 3,
      "is_mining": true,
      "last_check_succeed": true,
      "stale": false,
      "overheat": false,
      "low_hashrate": false,
      "overpower": false,
      "underpower": false,
      "lifecycle_status": "online",
      "health_status": null,
      "mining_mode": "normal",
      "mining_mode_preset": "<string>",
      "hashrate": 100120000000000,
      "hashrate_24h": 100120000000000,
      "power": 9771,
      "temp": 75.5,
      "efficiency": 34,
      "uptime": 86400,
      "last_updated_at": "2025-08-27T00:00:00Z",
      "errors": [
        {
          "code": "E001",
          "message": "Temperature too high"
        }
      ],
      "hashboards": [
        {
          "serial_number": "HB123456",
          "hashrate": 25120000000000,
          "chips": 4,
          "chip_frequency": 650
        }
      ],
      "total_chips": 5,
      "expected_chips": 4,
      "anomaly_flags": 0,
      "pools": [],
      "psus": []
    }
  ],
  "pagination": {
    "total": 50,
    "limit": 10,
    "offset": 0,
    "hasNext": true,
    "hasPrevious": false
  },
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.nonce.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Clerk Machine API Key for authentication

Path Parameters

​
workspace_id
string
required
​
farm_id
string
required

Body

application/json
​
agent_id
object

String filter operators. Provide at least one operator.

Example:
{ "contains": "S19" }
​
sn
object

String filter operators. Provide at least one operator.

Example:
{ "contains": "S19" }
​
mac
object

String filter operators. Provide at least one operator.

Example:
{ "contains": "S19" }
​
lifecycle_statuses
object

Enum or ID filter operators. Provide at least one operator.

Example:
{ "in": ["online", "offline"] }
​
health_statuses
object

Enum or ID filter operators. Provide at least one operator.

Example:
{ "in": ["online", "offline"] }
​
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: single address 192.168.1.5, CIDR 192.168.1.0/24, or hyphen range 192.168.1.1-192.168.1.254. At most 10 ranges per request.

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"
]
​
page
integer
Required range: 1 <= x <= 9007199254740991
​
limit
integer
Required range: 1 <= x <= 10000

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