Skip to content
Taostats Docs

Get Miner Coldkey

Endpoint

Section titled “Endpoint”
GET /api/miner/coldkey/v1

Try it

Section titled “Try it”
Fills the fields below — runs automatically if your API key is saved.
Get a free API key →
curl

Parameters

Section titled “Parameters”
NameInTypeRequiredDescription
coldkeyquerystring✅SS58 or hex format
daysqueryinteger✅

Responses

Section titled “Responses”

200 — Miner coldkey retrieved successfully

Section titled “200 — Miner coldkey retrieved successfully”

Media: application/json

Schema
{
  "type": "object",
  "required": [
    "pagination",
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "coldkey",
          "total_balance",
          "free_balance",
          "total_staked_balance_as_tao",
          "total_staked_mining_balance_as_tao",
          "total_staked_non_mining_balance_as_tao",
          "active_subnets",
          "total_active_hotkeys",
          "total_immune_hotkeys",
          "total_hotkeys_in_danger",
          "total_immune_hotkeys_during_period",
          "total_hotkeys_in_danger_during_period",
          "total_deregistered_hotkeys",
          "total_mining_emission_as_tao",
          "average_mining_emission_as_tao_per_hotkey",
          "hotkeys",
          "alpha_balances"
        ],
        "properties": {
          "active_subnets": {
            "type": "integer",
            "format": "int32"
          },
          "alpha_balances": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "balance",
                "balance_as_tao",
                "hotkey",
                "coldkey",
                "netuid"
              ],
              "properties": {
                "balance": {
                  "type": "string"
                },
                "balance_as_tao": {
                  "type": "string"
                },
                "coldkey": {
                  "type": "string"
                },
                "hotkey": {
                  "type": "string"
                },
                "netuid": {
                  "type": "integer",
                  "format": "int32"
                }
              }
            }
          },
          "average_mining_emission_as_tao_per_hotkey": {
            "type": "string"
          },
          "coldkey": {
            "type": "object",
            "required": [
              "ss58",
              "hex"
            ],
            "properties": {
              "hex": {
                "type": "string",
                "description": "The hex format of the hot key"
              },
              "ss58": {
                "type": "string",
                "description": "The SS58 format of the hot key"
              }
            }
          },
          "free_balance": {
            "type": "string"
          },
          "hotkeys": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "hotkey",
                "coldkey",
                "netuid",
                "uid",
                "immune",
                "in_danger",
                "deregistered",
                "alpha_balance",
                "alpha_balance_as_tao",
                "trust",
                "consensus",
                "incentive",
                "mech_incentive",
                "emission",
                "total_emission",
                "total_emission_as_tao",
                "axon",
                "registration_block"
              ],
              "properties": {
                "alpha_balance": {
                  "type": "string"
                },
                "alpha_balance_as_tao": {
                  "type": "string"
                },
                "axon": {
                  "type": "string"
                },
                "coldkey": {
                  "type": "object",
                  "required": [
                    "ss58",
                    "hex"
                  ],
                  "properties": {
                    "hex": {
                      "type": "string",
                      "description": "The hex format of the hot key"
                    },
                    "ss58": {
                      "type": "string",
                      "description": "The SS58 format of the hot key"
                    }
                  }
                },
                "consensus": {
                  "type": "string"
                },
                "deregistered": {
                  "type": "boolean"
                },
                "deregistration_timestamp": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true
                },
                "emission": {
                  "type": "string"
                },
                "hotkey": {
                  "type": "object",
                  "required": [
                    "ss58",
                    "hex"
                  ],
                  "properties": {
                    "hex": {
                      "type": "string",
                      "description": "The hex format of the hot key"
                    },
                    "ss58": {
                      "type": "string",
                      "description": "The SS58 format of the hot key"
                    }
                  }
                },
                "immune": {
                  "type": "boolean"
                },
                "in_danger": {
                  "type": "boolean"
                },
                "incentive": {
                  "type": "string"
                },
                "mech_incentive": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "miner_rank": {
                  "type": "integer",
                  "format": "int32",
                  "nullable": true
                },
                "netuid": {
                  "type": "integer",
                  "format": "int32"
                },
                "registration_block": {
                  "type": "integer",
                  "format": "int32"
                },
                "total_emission": {
                  "type": "string"
                },
                "total_emission_as_tao": {
                  "type": "string"
                },
                "trust": {
                  "type": "string"
                },
                "uid": {
                  "type": "integer",
                  "format": "int32"
                },
                "validator_rank": {
                  "type": "integer",
                  "format": "int32",
                  "nullable": true
                }
              }
            }
          },
          "total_active_hotkeys": {
            "type": "integer",
            "format": "int32"
          },
          "total_balance": {
            "type": "string"
          },
          "total_deregistered_hotkeys": {
            "type": "integer",
            "format": "int32"
          },
          "total_hotkeys_in_danger": {
            "type": "integer",
            "format": "int32"
          },
          "total_hotkeys_in_danger_during_period": {
            "type": "integer",
            "format": "int32"
          },
          "total_immune_hotkeys": {
            "type": "integer",
            "format": "int32"
          },
          "total_immune_hotkeys_during_period": {
            "type": "integer",
            "format": "int32"
          },
          "total_mining_emission_as_tao": {
            "type": "string"
          },
          "total_staked_balance_as_tao": {
            "type": "string"
          },
          "total_staked_mining_balance_as_tao": {
            "type": "string"
          },
          "total_staked_non_mining_balance_as_tao": {
            "type": "string"
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "required": [
        "current_page",
        "per_page",
        "total_items",
        "total_pages"
      ],
      "properties": {
        "current_page": {
          "type": "integer",
          "format": "int32"
        },
        "next_page": {
          "type": "integer",
          "format": "int32",
          "nullable": true
        },
        "per_page": {
          "type": "integer",
          "format": "int32"
        },
        "prev_page": {
          "type": "integer",
          "format": "int32",
          "nullable": true
        },
        "total_items": {
          "type": "integer",
          "format": "int32"
        },
        "total_pages": {
          "type": "integer",
          "format": "int32"
        }
      }
    }
  }
}

400 — Bad request

Section titled “400 — Bad request”

404 — Miner coldkey not found

Section titled “404 — Miner coldkey not found”

500 — Internal server error

Section titled “500 — Internal server error”

Authentication

Section titled “Authentication”

All Taostats API requests require an Authorization header containing your API key. See Getting Started.