Luxor PlatformAPI DocumentationCommanderReporting

Get miner details (batch)

Returns detailed information for up to 500 miners scoped to a single site in a single request. Designed for polling workflows that would otherwise exceed rate limits with one-at-a-time GETs. Access is gated by two checks: the caller must have commander-read on `site_id`, and on every site that the requested `miner_ids` belong to — any miner ID owned by a site the caller can't read causes the whole request to return 403. Unknown miner IDs (that don't exist anywhere) are silently omitted from the response. Lift metrics may report 0 for miners that have been offline for more than an hour.

POST
/v2/commander/miners/details

Authorization

LuxorAPIKey
authorization<token>

Use your API key here.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v2/commander/miners/details" \  -H "Content-Type: application/json" \  -d '{    "site_id": "b0a5fad8-1234-5678-9abc-def012345678",    "miner_ids": [      "aaaa1111-bbbb-cccc-dddd-eeee11111111",      "aaaa2222-bbbb-cccc-dddd-eeee22222222"    ]  }'
{  "miners": [    {      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "ip_address": "10.0.1.42",      "mac_address": "AA:BB:CC:DD:EE:FF",      "model": "S19 Pro",      "firmware": {        "name": "LuxOS",        "version": "2024.12.1"      },      "hashing_status": "hashing",      "healthy_status": "healthy",      "site_id": "b0a5fad8-1234-5678-9abc-def012345678",      "agent_id": "056a4f62-1234-5678-9abc-def012345678",      "hashrate": "110000000000000",      "power": 3250,      "max_temperature": 65,      "fan_speed": [        4200,        4180,        4180,        4100      ],      "pool": {        "url": "stratum+tcp://pool.example.com:3333",        "username": "lux_phx_0",        "worker": "myworker.001"      },      "last_seen_at": "2026-02-20T12:00:00Z",      "url": "/v2/commander/miners/a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "hashboards": [        {          "index": 0,          "board_hashrate": "27500000000000",          "board_voltage": 15.1,          "board_frequency": 500,          "board_temperature": 62,          "chips_total": 114,          "chips_active": 114        }      ],      "pool_configs": [        {          "priority": 1,          "username": "lux_phx_0",          "worker": "myworker.001",          "url": "stratum+tcp://pool.example.com:3333",          "status": true,          "group": "Group 1"        }      ],      "atm": {        "enabled": true,        "startup_minutes": 10,        "post_ramp_minutes": 5,        "temp_window": 10,        "temp_buffer": 10,        "min_profile": "1",        "max_profile": "4",        "prevent_oc": true      }    }  ]}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}