Query Farm Miner Metrics
curl --request POST \
--url https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"period": "2023-11-07T05:31:56Z",
"theo": 123,
"total": 123,
"classification": {
"healthy": 123,
"abnormal": 123,
"sleep": 123,
"stale": 123
},
"anomaly_breakdown": {
"hashboard": {
"count": 123,
"also_has": {}
},
"temperature": {
"count": 123,
"also_has": {}
},
"fan": {
"count": 123,
"also_has": {}
},
"network": {
"count": 123,
"also_has": {}
},
"pool": {
"count": 123,
"also_has": {}
},
"power": {
"count": 123,
"also_has": {}
},
"control_board": {
"count": 123,
"also_has": {}
},
"firmware": {
"count": 123,
"also_has": {}
},
"low_hashrate": {
"count": 123,
"also_has": {}
},
"unknown": {
"count": 123,
"also_has": {}
}
},
"mining_modes": [
{
"mining_mode": "<string>",
"mining_mode_preset": "<string>",
"count": 123,
"firmwares": [
{
"firmware": "<string>",
"count": 123
}
]
}
],
"miner_models": [
{
"model": "<string>",
"theoretical_hashrate": 123,
"submodel": "<string>",
"count": 123,
"average_expected_hashrate": 123
}
]
},
"error": null
}{
"success": false,
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed"
}
}{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing credential"
}
}{
"success": false,
"data": null,
"error": {
"code": "FORBIDDEN",
"message": "Access denied"
}
}{
"success": false,
"data": null,
"error": {
"code": "FARM_NOT_FOUND",
"message": "Farm not found"
}
}{
"success": false,
"data": null,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
}
}Farms
Query Farm Miner Metrics
Return real-time aggregate miner classification counts and mining-mode and model distributions for a farm. Classification counts are independent — a sleeping miner with a fault appears in both abnormal and sleep. Online miners equal total minus stale.
POST
/
public-api
/
v2
/
workspaces
/
{workspace_id}
/
farms
/
{farm_id}
/
miner-metrics
/
query
Query Farm Miner Metrics
curl --request POST \
--url https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nonce.app/public-api/v2/workspaces/{workspace_id}/farms/{farm_id}/miner-metrics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"period": "2023-11-07T05:31:56Z",
"theo": 123,
"total": 123,
"classification": {
"healthy": 123,
"abnormal": 123,
"sleep": 123,
"stale": 123
},
"anomaly_breakdown": {
"hashboard": {
"count": 123,
"also_has": {}
},
"temperature": {
"count": 123,
"also_has": {}
},
"fan": {
"count": 123,
"also_has": {}
},
"network": {
"count": 123,
"also_has": {}
},
"pool": {
"count": 123,
"also_has": {}
},
"power": {
"count": 123,
"also_has": {}
},
"control_board": {
"count": 123,
"also_has": {}
},
"firmware": {
"count": 123,
"also_has": {}
},
"low_hashrate": {
"count": 123,
"also_has": {}
},
"unknown": {
"count": 123,
"also_has": {}
}
},
"mining_modes": [
{
"mining_mode": "<string>",
"mining_mode_preset": "<string>",
"count": 123,
"firmwares": [
{
"firmware": "<string>",
"count": 123
}
]
}
],
"miner_models": [
{
"model": "<string>",
"theoretical_hashrate": 123,
"submodel": "<string>",
"count": 123,
"average_expected_hashrate": 123
}
]
},
"error": null
}{
"success": false,
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed"
}
}{
"success": false,
"data": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing credential"
}
}{
"success": false,
"data": null,
"error": {
"code": "FORBIDDEN",
"message": "Access denied"
}
}{
"success": false,
"data": null,
"error": {
"code": "FARM_NOT_FOUND",
"message": "Farm not found"
}
}{
"success": false,
"data": null,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
}
}Authorizations
oauth-jwtclerk-api-key
Clerk OAuth JWT access token
Path Parameters
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)$