ListMinerStateSnapshots | Proto Fleet Documentation

{
  "page_size": 42,
  "cursor": "example",
  "filter": {
    "device_status": [
      0
    ],
    "error_component_types": [
      0
    ],
    "models": [
      "example"
    ],
    "pairing_statuses": [
      0
    ],
    "group_ids": [
      42
    ],
    "rack_ids": [
      42
    ]
  },
  "sort": [
    {
      "field": 0,
      "direction": 0
    }
  ]
}

{
  "miners": [
    {
      "device_identifier": "example",
      "name": "example",
      "mac_address": "example",
      "serial_number": "example",
      "power_usage": [
        {
          "timestamp": {
            "seconds": 42,
            "nanos": 42
          },
          "value": 42,
          "unit": 0
        }
      ],
      "temperature": [
        {
          "timestamp": {
            "seconds": 42,
            "nanos": 42
          },
          "value": 42,
          "unit": 0
        }
      ],
      "hashrate": [
        {
          "timestamp": {
            "seconds": 42,
            "nanos": 42
          },
          "value": 42,
          "unit": 0
        }
      ],
      "efficiency": [
        {
          "timestamp": {
            "seconds": 42,
            "nanos": 42
          },
          "value": 42,
          "unit": 0
        }
      ],
      "timestamp": {
        "seconds": 42,
        "nanos": 42
      },
      "ip_address": "example",
      "url": "example",
      "device_status": 0,
      "pairing_status": 0,
      "model": "example",
      "manufacturer": "example",
      "capabilities": {
        "manufacturer": "example",
        "authentication": {
          "supported_methods": [
            0
          ]
        },
        "commands": {
          "reboot_supported": true,
          "mining_start_supported": true,
          "mining_stop_supported": true,
          "led_blink_supported": true,
          "factory_reset_supported": true,
          "air_cooling_supported": true,
          "immersion_cooling_supported": true,
          "pool_switching_supported": true,
          "pool_max_count": 42,
          "pool_priority_supported": true,
          "logs_download_supported": true,
          "power_mode_efficiency_supported": true,
          "update_miner_password_supported": true
        },
        "telemetry": {
          "realtime_telemetry_supported": true,
          "historical_data_supported": true,
          "hashrate_reported": true,
          "power_usage_reported": true,
          "temperature_reported": true,
          "fan_speed_reported": true,
          "efficiency_reported": true,
          "uptime_reported": true,
          "error_count_reported": true,
          "miner_status_reported": true,
          "pool_stats_reported": true,
          "per_chip_stats_reported": true,
          "per_board_stats_reported": true,
          "psu_stats_reported": true
        },
        "firmware": {
          "ota_update_supported": true,
          "manual_upload_supported": true
        }
      },
      "temperature_status": 0,
      "firmware_version": "example",
      "group_labels": [
        "example"
      ],
      "rack_label": "example",
      "driver_name": "example",
      "worker_name": "example",
      "rack_position": "example"
    }
  ],
  "cursor": "example",
  "total_miners": 42,
  "total_state_counts": {
    "hashing_count": 42,
    "broken_count": 42,
    "offline_count": 42,
    "sleeping_count": 42
  },
  "models": [
    "example"
  ]
}

List all devices in the fleet (paired and/or unpaired) optionally with their telemetry data Returns a paginated list of devices with their operational status and metrics Use the pairing_status filter to control whether to return paired, unpaired, or both

ListMinerStateSnapshotsRequest

Request

This endpoint expects an object.

page_sizeinteger

Maximum number of miners to return in a single response Server may return fewer miners than specified If not specified, a default of 50 will be used Maximum allowed value is 1000

cursorstring

A pagination cursor returned by a previous call to this endpoint Provide this cursor to retrieve the next set of results for the original query Leave empty for first request

filterobject

Filter criteria for the miners to return

sortlist of objects

Sort configuration for results ordering If not specified or empty, uses default sort by name ASC (alphabetical) Currently only the first element is used; multi-column sorting reserved for future

ListMinerStateSnapshotsResponse

Response

This endpoint returns an object.

minerslist of objects

List of miners with their telemetry data Contains either snapshot or time series data based on the request

cursorstring

The pagination cursor to be used in a subsequent request If empty, this is the final page of results

total_minersinteger

Total number of miners available across all pages Useful for UI pagination controls

total_state_countsobject

Counts of miners in different states This includes counts for all miners, not just the ones in the current page Status filters do not affect these counts, because they act as OR condition.

modelslist of strings

List of all device models that exist in the user’s fleet Useful for dynamically building model filter options in the UI This includes all models across all pages, not just the current page (e.g., “S21 XP”, “M60”)