Miner API Command Reference — cgminer/BOSminer on Port 4028

Every ASIC miner exposes a JSON API on TCP port 4028 — the cgminer/BMMiner/BOSminer socket that fleet tools and pyasic use to read your miners and switch pools. This reference is the firmware-family support matrix: which commands work as read or control across Stock Antminer, BraiinsOS-family, LuxOS-family and DCENT_OS.

Transports, ports and authentication, firmware by firmware

The matrix above says what each command does. This table says how to reach it. Cells marked Unknown stay Unknown: the vendor does not publish the answer and we are not going to guess it.

Copy-paste examples

Every address below is in the RFC 5737 documentation range (192.0.2.0/24) — substitute your own miner's IP.

# cgminer / bmminer / LuxOS — raw TCP, plain text or JSON, port 4028
echo '{"command":"summary"}' | nc 192.0.2.10 4028

# Braiins OS+ legacy CGMiner-compatible socket (still served; Braiins says it will be deprecated)
echo '{"command":"pools"}' | nc 192.0.2.10 4028

# LuxOS HTTP API — port 8080
curl -X POST -d '{"command":"version"}' -H 'Content-Type: application/json' http://192.0.2.10:8080/api

# AxeOS — plain HTTP on port 80, no authentication
curl http://192.0.2.10/api/system/info

# Braiins OS+ REST (since 25.07) — log in, then read the live OpenAPI document
curl -X POST http://192.0.2.10/api/v1/auth/login -d '{"username":"root","password":"..."}'
curl http://192.0.2.10/api/v1/docs/openapi.json

# MicroBT Whatsminer — 4433, NOT 4028, on API v3.0.0
nc 192.0.2.10 4433

Read versus control: the API is off, local-only and read-only until you change that

The canonical document for the 4028 socket is cgminer's own API-README, and it is worth reading before you open anything up. Verbatim: “By default, you cannot access any privileged command that affects the miner — you will receive an access denied status message.” The two flags that govern it are --api-listen, documented as “Enable API, default: disabled”, and --api-network, whose default is “only 127.0.0.1”. That is three separate answers in one place: the API is off, it is local-only, and it is read-only until an operator deliberately changes all three. Credit: Con Kolivas and the cgminer contributors, whose API-README is still the reference document the whole category is built on.

What stock Antminer firmware actually implements

Bitmain's own GPL source drop bitmaintech/bmminer-mix carries an api.c whose cmds[] table has an explicit iswritemode flag, so the split is not inferred — it is read off the table.

• Write-mode: switchpool addpool poolpriority poolquota enablepool disablepool removepool save quit privileged restart failover-only debug setconfig zero hotplug ascenable ascdisable ascidentify ascset lockstats
• Read-only: version config devs edevs pools summary noncenum pgacount notify devdetails stats estats check coin usbstats asccount lcd
• That is upstream cgminer's set plus a Bitmain-specific noncenum.
• Braiins-only additions on its legacy 4028 socket: fans tempctrl temps tunerstatus pause resume

The caveat that matters. bmminer-mix is the S9/C5-era drop. No S19 or S21 bmminer source drop is available to read, so the current stock command set is Unknown and the list above should be treated as the S9-generation answer, not a present-day one.