Bitaxe API Endpoints

The Bitaxe features the following endpoints:

GET

• /api/system/info Get system information
• /api/system/asic Get ASIC settings information
• /api/system/statistics Get system statistics (data logging should be activated)
• /api/system/statistics/dashboard Get system statistics for dashboard
• /api/system/wifi/scan Scan for available WiFi networks

POST

• /api/system/restart Restart the system
• /api/system/OTA Update system firmware
• /api/system/OTAWWW Update AxeOS

PATCH

• /api/system/ Update system settings

---

Examples

GET

Get system information:

curl http://YOUR-BITAXE-IP/api/system/info

POST

With POST command is it possible to restart the Bitaxe:

curl -X POST http://YOUR-BITAXE-IP/api/system/restart

PATCH

The PATCH functionallity allows it to change settings on the Bitaxe.

Some settings still require a restart but changing the fanspeed can be achieve live:

curl -X PATCH http://YOUR-BITAXE-IP/api/system \
     -H "Content-Type: application/json" \
     -d '{"fanspeed": "desired_speed_value"}'

---

Response

The file openapi.yaml contains response values for each API endpoint. For example, general information about the Bitaxe can be collected using the /api/system/info, which provides the following data:

    "power": 58.35174560546875,
    "voltage": 11906.25,
    "current": 16281.25,
    "temp": 58.0,
    "vrTemp": 45,
    "maxPower": 40,
    "nominalVoltage": 12,
    "hashRate": 2372.7583341893742,
    "bestDiff":  "4.29G",
    "bestNonceDiff": 4292734826,
    "bestSessionDiff": "3.83M",
    "bestSessionNonceDiff": 3828108,
    "stratumDiff": 1000,
    "isUsingFallbackStratum": 0,
    "isPSRAMAvailable":  1,
    "freeHeap": 178368,
    "coreVoltage": 1200,
    "coreVoltageActual": 1194,
    "frequency": 525,
    "ssid": "Haus1",
    "macAddr":  "C0-FA-38-6A-6E-B2",
    "hostname":  "bitaxe",
    "wifiStatus": "Connected!",
    "wifiRSSI":  -44,
    "apEnabled": 0,
    "sharesAccepted": 19739,
    "sharesRejected": 6,
    "sharesRejectedReasons": [{
      "message": "Above target",
      "count": 6
  }],
    "uptimeSeconds": 212115,
    "asicCount": 1,
    "smallCoreCount": 894,
    "ASICModel": "BM1366",
    "stratumURL": "public-pool.io",
    "fallbackStratumURL": "solo.ckpool.org",
    "stratumPort": 21496,
    "fallbackStratumPort": 3333,
    "stratumUser": "bc1qnp980s5fpp8l94p5cvttmtdqy8rvrq74qly2yrfmzkdsntqzlc5qkc4rkq.bitaxe",
    "fallbackStratumUser": "bc1qnp980s5fpp8l94p5cvttmtdqy8rvrq74qly2yrfmzkdsntqzlc5qkc4rkq.bitaxe",
    "version": "v2.6.0",
    "idfVersion": "v5.4",
    "boardVersion": "302",
    "runningPartition": "factory",
    "flipscreen": 1,
    "overheat_mode": 0,
    "overclockEnabled":  0,
    "invertscreen": 0,
    "invertfanpolarity": 1,
    "autofanspeed": 0,
    "fanspeed": 35,
    "fanrpm": 5515
}