v51

latestOpenAPI 3.1.0GNU General Public License version 3raw.githubusercontent.com2026-08-01151240.0 KB
system

Get system information

Returns current system status and information

get/api/system/info

Response

Successful operation

ASICModelstring required

ASIC model identifier

apEnablednumber required

Whether AP mode is enabled (0=no, 1=yes)

autofanspeednumber required

Automatic fan speed control (0=manual, 1=auto)

bestDiffnumber required

Best difficulty achieved

bestSessionDiffnumber required

Best difficulty achieved in current session

boardVersionstring required

Hardware board version

coreVoltagenumber required

Configured ASIC core voltage

coreVoltageActualnumber required

Actual measured ASIC core voltage

currentnumber required

Current draw in milliamps

displaystring required

The configured display

fallbackStratumExtranonceSubscribeboolean required

Enable fallback pool extranonce subscription

fallbackStratumPortnumber required

Fallback stratum server port

fallbackStratumSuggestedDifficultynumber required

Fallback pool suggested difficulty

fallbackStratumURLstring required

Fallback stratum server URL

fallbackStratumUserstring required

Fallback stratum username

fallbackStratumTLSboolean required

Enable fallback stratum TLS

fallbackStratumCertstring required

Fallback stratum TLS cert

fallbackStratumDecodeCoinbaseboolean required

Enable fallback pool coinbase transaction decoding

fallbackStratumProtocol'SV1' | 'SV2'

Configured fallback stratum protocol

fallbackStratumV2AuthorityPubkeystring

Fallback SV2 authority public key for certificate verification (base58-encoded)

fallbackStratumV2ChannelType'standard' | 'extended'

Configured fallback SV2 channel type

fanrpmnumber required

Current fan speed in RPM

fan2rpmnumber required

Current secondary fan speed in RPM

fanspeednumber required

Current fan speed percentage

temptargetnumber required

Target Temperature for the PID Controller

responseTimenumber required

Pool response time in ms

responseShareBatchnumber

Number of shares acknowledged in the batch that produced responseTime (SV2; 1 = single share, >1 = batched ack)

rotationnumber required

Screen rotation setting (0, 90, 180, 270)

cpuUsagenumber required

CPU usage percentage

freeHeapnumber required

Available heap memory in bytes

freeHeapInternalnumber required

Available internal heap memory in bytes

freeHeapSpiramnumber required

Available Spiram heap memory in bytes

minFreeHeapnumber required

All-time low watermark for free heap memory in bytes

maxAllocHeapnumber required

Largest contiguous free block of internal heap memory in bytes

frequencynumber required

ASIC frequency in MHz

actualFrequencynumber required

Real-time ASIC frequency in MHz

hashRatenumber required

Current hashrate in Gh/s

hashRate_1mnumber required

Current hashrate 1m average

hashRate_10mnumber required

Current hashrate 10m average

hashRate_1hnumber required

Current hashrate 1h average

expectedHashratenumber required

Expected hashrate at current voltage/frequency settings, in Gh/s

errorPercentagenumber required

Hash error percentage

hostnamestring required

Device hostname

fullHostnamestring

Full hostname including .local domain for mDNS

mdnsHostnamestring

mDNS/Bonjour hostname for network discovery

idfVersionstring required

ESP-IDF version

invertscreennumber required

Screen invert setting (0=normal, 1=inverted)

isPSRAMAvailablenumber required

Whether PSRAM is available (0=no, 1=yes)

isUsingFallbackStratumnumber required

Whether using fallback stratum (0=no, 1=yes)

macAddrstring required

Device MAC address

manualFanSpeedinteger required

Fan speed when auto fan speed is disabled

maxPowerinteger required

Maxmium power draw of the board in watts

minFanSpeedinteger required

Minimum fan speed percentage when using auto fan control

nominalVoltageinteger required

Nominal board voltage

overheat_modenumber required

Overheat protection mode

overclockEnabledinteger required

Set custom voltage/frequency in AxeOS

useCustomWWW0 | 1 required

Whether to serve files from the SPIFFS www partition instead of the embedded Web UI (0=embedded, 1=custom/SPIFFS)

primaryPoolIndexinteger required

Index of the primary pool

secondaryPoolIndexinteger required

Index of the secondary pool (fallback)

poolConnectionInfostring required

Current pool address family

poolDifficultynumber required

Current pool difficulty

powernumber required

Power consumption in watts

power_faultstring

Voltage regulator fault reason, if any

hardware_faultstring

Hardware/Peripheral fault reason, if any

resetReasonstring required

Reason for the last system reset

runningPartitionstring required

Currently active OTA partition

sharesAcceptednumber required

Number of accepted shares

sharesRejectednumber required

Number of rejected shares

sharesPendingnumber

Shares submitted but not yet resolved by the pool (SV2; 0 for SV1). Rises while the pool batches/buffers acks, drops to 0 once it catches up.

smallCoreCountnumber required

Number of small cores

ssidstring required

Connected WiFi network SSID

ipv4string required

IPv4 address

ipv6string required

IPv6 address

stratumExtranonceSubscribeboolean required

Enable pool extranonce subscription

stratumPortnumber required

Primary stratum server port

stratumProtocol'SV1' | 'SV2' required

Configured stratum protocol

stratumV2AuthorityPubkeystring required

SV2 authority public key for certificate verification (base58-encoded)

stratumV2ChannelType'standard' | 'extended'

Configured SV2 channel type

stratumSuggestedDifficultynumber required

Pool suggested difficulty

stratumURLstring required

Primary stratum server URL

stratumUserstring required

Primary stratum username

stratumTLSboolean required

Enable primary pool TLS

stratumCertstring required

Primary stratum TLS cert

stratumDecodeCoinbaseboolean required

Enable primary pool coinbase transaction decoding

tempnumber required

Average chip temperature

temp2number required

Average chip temperature from second sensor

uptimeSecondsnumber required

System uptime in seconds

versionstring required

Firmware version

axeOSVersionstring required

AxeOS version

voltagenumber required

Input voltage

vrTempnumber required

Voltage regulator temperature

wifiStatusstring required

WiFi connection status

wifiRSSInumber required

WiFi signal strength

displayTimeoutnumber required

Turn off display after timeout

statsFrequencynumber required

Statistics frequency in seconds

blockHeightinteger required

Current block height

scriptsigstring required

Scriptsig extracted from coinbase transaction

networkDifficultynumber required

Current network difficulty

blockSignalsstring[] required

Active block signaling (e.g., BIP-110)

blockFoundnumber required

Number of blocks found

showNewBlockboolean

Whether to show the block found notification

coinbaseValueTotalSatoshisinteger required

Total value of coinbase transaction in satoshis

coinbaseValueUserSatoshisinteger required

User's portion of coinbase value in satoshis

miningPausedboolean required

Whether mining is currently paused

statsLimitinteger required

Maximum number of statistics data points

workReceivedinteger

Total number of mining jobs received from the pool

Example response

{
  "sharesRejectedReasons": [
    {
      "message": "Job not found"
    }
  ]
}