---
title: "Get miner details"
method: GET
path: "/api/v1/miner/details"
tags: ["Miner"]
---

# Get miner details

`GET /api/v1/miner/details`

## Request

- Base URL: `http://miner`
- URL: `http://miner/api/v1/miner/details`
- Auth: none declared
- TypeScript: <https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/docs/api/v1/miner/details/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves detailed information about the miner, such as hardware model, firmware version, serial number, and other identifying data.

## Response `200`

Successful response containing detailed miner information.

- GetMinerDetailsResponse: Structure to handle system details
  - `bos_mode` integer, required: BOS Mode
  - `bos_version` BosVersion: Structure to handle BOS version
    - `bos_plus` boolean, required
    - `current` string, required
    - `major` string, required
  - `bosminer_uptime_s` integer, required: Bosminer uptime. `0` means bosminer is not running
  - `control_board_soc_family` integer, required: Control board soc family
  - `hostname` string, required: Hostname
  - `kernel_version` string, required: Kernel version
  - `mac_address` string, required: MAC address
  - `miner_identity` MinerIdentity
    - `brand` integer, required
    - `miner_model` string, required
    - `model` integer, required: Deprecated: Use miner_model instead. This field is no longer supported.
    - `name` string, required
  - `platform` integer, required: Miner platform
  - `psu_info` PsuInfo
    - `fw_version` integer, nullable: PSU firmware version identifier
    - `max_voltage` Voltage
      - `volt` number, double, required
    - `min_voltage` Voltage
      - `volt` number, double, required
    - `model_name` string, nullable: PSU model/version name in human-readable form (e.g. "APW121215b")
    - `serial_number` string, nullable: PSU serial number (e.g. "DGAH335BDJDJG0782")
    - `version` integer, nullable: PSU hardware version identifier
  - `serial_number` string, nullable: Miner serial number
  - `status` integer, required: Miner status
  - `sticker_hashrate` GigaHashrate
    - `gigahash_per_second` number, double, required
  - `system_uptime` integer, required: Deprecated: Use system_uptime_s
  - `system_uptime_s` integer, required: System uptime
  - `uid` string, required: Miner ID

---

[API](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api.md) - [All operations](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/revisions/d341c8e1d506?raw)