---
title: "Stream miner status updates"
method: GET
path: "/api/v1/miner/status"
tags: ["Miner"]
---

# Stream miner status updates

`GET /api/v1/miner/status`

## Request

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

Streams the current status of the miner in real-time. The status can be one of: `unspecified`, `not_started`, `normal`, `paused`, `suspended`, or `restricted`. The response is a continuous JSON stream.

## Response `200`

Stream of miner status updates.

- GetMinerStatusResponse
  - `status` integer, required

---

[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)