---
title: "Get system information"
method: GET
path: "/api/system/info"
tags: ["system"]
---

# Get system information

`GET /api/system/info`

Returns current system status and information

## Response `200`

Successful operation

- SystemInfo
  - `ASICModel` string, required — ASIC model identifier
  - `apEnabled` number, required — Whether AP mode is enabled (0=no, 1=yes)
  - `autofanspeed` number, required — Automatic fan speed control (0=manual, 1=auto)
  - `bestDiff` number, required — Best difficulty achieved
  - `bestSessionDiff` number, required — Best difficulty achieved in current session
  - `boardVersion` string, required — Hardware board version
  - `coreVoltage` number, required — Configured ASIC core voltage
  - `coreVoltageActual` number, required — Actual measured ASIC core voltage
  - `current` number, required — Current draw in milliamps
  - `display` string, required — The configured display
  - `fallbackStratumExtranonceSubscribe` boolean, required — Enable fallback pool extranonce subscription
  - `fallbackStratumPort` number, required — Fallback stratum server port
  - `fallbackStratumSuggestedDifficulty` number, required — Fallback pool suggested difficulty
  - `fallbackStratumURL` string, required — Fallback stratum server URL
  - `fallbackStratumUser` string, required — Fallback stratum username
  - `fallbackStratumTLS` boolean, required — Enable fallback stratum TLS
  - `fallbackStratumCert` string, required — Fallback stratum TLS cert
  - `fallbackStratumDecodeCoinbase` boolean, required — Enable fallback pool coinbase transaction decoding
  - `fallbackStratumProtocol` 'SV1' | 'SV2' — Configured fallback stratum protocol
  - `fallbackStratumV2AuthorityPubkey` string — Fallback SV2 authority public key for certificate verification (base58-encoded)
  - `fallbackStratumV2ChannelType` 'standard' | 'extended' — Configured fallback SV2 channel type
  - `fanrpm` number, required — Current fan speed in RPM
  - `fan2rpm` number, required — Current secondary fan speed in RPM
  - `fanspeed` number, required — Current fan speed percentage
  - `temptarget` number, required — Target Temperature for the PID Controller
  - `responseTime` number, required — Pool response time in ms
  - `responseShareBatch` number — Number of shares acknowledged in the batch that produced responseTime (SV2; 1 = single share, >1 = batched ack)
  - `rotation` number, required — Screen rotation setting (0, 90, 180, 270)
  - `cpuUsage` number, required — CPU usage percentage
  - `freeHeap` number, required — Available heap memory in bytes
  - `freeHeapInternal` number, required — Available internal heap memory in bytes
  - `freeHeapSpiram` number, required — Available Spiram heap memory in bytes
  - `minFreeHeap` number, required — All-time low watermark for free heap memory in bytes
  - `maxAllocHeap` number, required — Largest contiguous free block of internal heap memory in bytes
  - `frequency` number, required — ASIC frequency in MHz
  - `actualFrequency` number, required — Real-time ASIC frequency in MHz
  - `hashRate` number, required — Current hashrate in Gh/s
  - `hashRate_1m` number, required — Current hashrate 1m average
  - `hashRate_10m` number, required — Current hashrate 10m average
  - `hashRate_1h` number, required — Current hashrate 1h average
  - `expectedHashrate` number, required — Expected hashrate at current voltage/frequency settings, in Gh/s
  - `errorPercentage` number, required — Hash error percentage
  - `hostname` string, required — Device hostname
  - `fullHostname` string — Full hostname including .local domain for mDNS
  - `mdnsHostname` string — mDNS/Bonjour hostname for network discovery
  - `idfVersion` string, required — ESP-IDF version
  - `invertscreen` number, required — Screen invert setting (0=normal, 1=inverted)
  - `isPSRAMAvailable` number, required — Whether PSRAM is available (0=no, 1=yes)
  - `isUsingFallbackStratum` number, required — Whether using fallback stratum (0=no, 1=yes)
  - `macAddr` string, required — Device MAC address
  - `manualFanSpeed` integer, required — Fan speed when auto fan speed is disabled
  - `maxPower` integer, required — Maxmium power draw of the board in watts
  - `minFanSpeed` integer, required — Minimum fan speed percentage when using auto fan control
  - `nominalVoltage` integer, required — Nominal board voltage
  - `overheat_mode` number, required — Overheat protection mode
  - `overclockEnabled` integer, required — Set custom voltage/frequency in AxeOS
  - `useCustomWWW` 0 | 1, required — Whether to serve files from the SPIFFS www partition instead of the embedded Web UI (0=embedded, 1=custom/SPIFFS)
  - `primaryPoolIndex` integer, required — Index of the primary pool
  - `secondaryPoolIndex` integer, required — Index of the secondary pool (fallback)
  - `pools` Pool[], required — Configured stratum pools
    - `stratumProtocol` 'SV1' | 'SV2' — Stratum protocol
    - `stratumURL` string, required — Stratum server URL
    - `stratumPort` integer, required — Stratum server port
    - `stratumUser` string, required — Stratum username
    - `stratumPassword` string — Stratum password
    - `stratumSuggestedDifficulty` number — Suggested difficulty
    - `stratumExtranonceSubscribe` boolean — Enable extranonce subscribe
    - `stratumTLS` integer — Enable stratum TLS (0=disabled, 1=enabled, 2=enabled with verification)
    - `stratumCert` string — Stratum TLS cert
    - `stratumDecodeCoinbase` boolean — Enable pool coinbase transaction decoding
    - `stratumV2ChannelType` 'standard' | 'extended' — SV2 channel type
    - `stratumV2AuthorityPubkey` string — SV2 authority public key for certificate verification (base58-encoded)
    - `stratumV2RequireAuth` boolean — Refuse to connect unless the SV2 server certificate is verified against the authority pubkey
    - `id` integer — Pool NVS slot index (0 to 7)
  - `poolConnectionInfo` string, required — Current pool address family
  - `poolDifficulty` number, required — Current pool difficulty
  - `power` number, required — Power consumption in watts
  - `power_fault` string — Voltage regulator fault reason, if any
  - `hardware_fault` string — Hardware/Peripheral fault reason, if any
  - `resetReason` string, required — Reason for the last system reset
  - `runningPartition` string, required — Currently active OTA partition
  - `sharesAccepted` number, required — Number of accepted shares
  - `sharesRejected` number, required — Number of rejected shares
  - `totalUptimeSeconds` number — Total uptime in seconds
  - `totalHashes` number — Total hashes done by the device
  - `totalLog2Work` number — Log2 of total hashes
  - `sharesPending` number — 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.
  - `sharesRejectedReasons` SharesRejectedReason[], required — Reason(s) shares were rejected
    - `message` string, required — Rejection reason from pool
    - `count` integer, required — Shares rejected for this reason
  - `smallCoreCount` number, required — Number of small cores
  - `ssid` string, required — Connected WiFi network SSID
  - `ipv4` string, required — IPv4 address
  - `ipv6` string, required — IPv6 address
  - `stratumExtranonceSubscribe` boolean, required — Enable pool extranonce subscription
  - `stratumPort` number, required — Primary stratum server port
  - `stratumProtocol` 'SV1' | 'SV2', required — Configured stratum protocol
  - `stratumV2AuthorityPubkey` string, required — SV2 authority public key for certificate verification (base58-encoded)
  - `stratumV2ChannelType` 'standard' | 'extended' — Configured SV2 channel type
  - `stratumSuggestedDifficulty` number, required — Pool suggested difficulty
  - `stratumURL` string, required — Primary stratum server URL
  - `stratumUser` string, required — Primary stratum username
  - `stratumTLS` boolean, required — Enable primary pool TLS
  - `stratumCert` string, required — Primary stratum TLS cert
  - `stratumDecodeCoinbase` boolean, required — Enable primary pool coinbase transaction decoding
  - `temp` number, required — Average chip temperature
  - `temp2` number, required — Average chip temperature from second sensor
  - `uptimeSeconds` number, required — System uptime in seconds
  - `version` string, required — Firmware version
  - `axeOSVersion` string, required — AxeOS version
  - `voltage` number, required — Input voltage
  - `vrTemp` number, required — Voltage regulator temperature
  - `wifiStatus` string, required — WiFi connection status
  - `wifiRSSI` number, required — WiFi signal strength
  - `displayTimeout` number, required — Turn off display after timeout
  - `statsFrequency` number, required — Statistics frequency in seconds
  - `blockHeight` integer, required — Current block height
  - `scriptsig` string, required — Scriptsig extracted from coinbase transaction
  - `networkDifficulty` number, required — Current network difficulty
  - `blockSignals` string[], required — Active block signaling (e.g., BIP-110)
  - `blockFound` number, required — Number of blocks found
  - `showNewBlock` boolean — Whether to show the block found notification
  - `coinbaseOutputs` object[] — Coinbase transaction outputs
    - `value` integer, required — Output value in satoshis
    - `address` string, required — Output address
  - `coinbaseValueTotalSatoshis` integer, required — Total value of coinbase transaction in satoshis
  - `coinbaseValueUserSatoshis` integer, required — User's portion of coinbase value in satoshis
  - `hashrateMonitor` object
    - `asics` HashrateMonitorAsic[], required — Hashrate register value per ASIC
      - `total` number, required — Hashrate
      - `domains` number[], required — Hashrate per domain
      - `errorCount` number, required — Number of errors
  - `miningPaused` boolean, required — Whether mining is currently paused
  - `statsLimit` integer, required — Maximum number of statistics data points
  - `workReceived` integer — Total number of mining jobs received from the pool
  - `partitions` SystemPartition[], required — List of available app partitions and their firmware versions
    - `label` string, required — Partition label (e.g., ota_0, ota_1, factory)
    - `version` string, nullable — Firmware version on this partition
    - `compileDate` string, nullable — Compile date of the firmware on this partition
    - `compileTime` string, nullable — Compile time of the firmware on this partition
    - `isCurrent` boolean, required — Whether this is the currently running partition
    - `isFactory` boolean, required — Whether this is a factory partition
    - `usagePercent` integer, nullable — Partition space usage percentage (0-100)

## Other responses

- `401` — Unauthorized - Client not in allowed network range
- `500` — Internal server error

## Changes

> 56 revisions in range; 4 could not be searched.

- **2026-07-26** `18f45b6c79e4` — 1 info
  - added the optional property `sharesPending` to the response with the `200` status
- **2026-07-26** `f9fc54b617b3` — 1 info
  - added the optional property `workReceived` to the response with the `200` status
- **2026-07-25** `797de1929ad2` — 2 info
  - added the required property `partitions` to the response with the `200` status
  - added the required property `useCustomWWW` to the response with the `200` status
- **2026-07-19** `806c3286eef1` — 3 info
  - added the required property `pools` to the response with the `200` status
  - added the required property `primaryPoolIndex` to the response with the `200` status
  - added the required property `secondaryPoolIndex` to the response with the `200` status
- **2026-06-22** `58c66b9d1273` — 2 info
  - added the optional property `fullHostname` to the response with the `200` status
  - added the optional property `mdnsHostname` to the response with the `200` status

[Full history](https://skmtc.dev/bitaxeorg/apis/esp-miner-api/changes/api/system/info/get.md)

---

[API](https://skmtc.dev/bitaxeorg/apis/esp-miner-api.md) · [All operations](https://skmtc.dev/bitaxeorg/apis/esp-miner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bitaxeorg/esp-miner-api/revisions/997ee850648f/schema)
