Get Stake

Endpoint

GET /api/stake/v1

Try it

API key

Remember on this browser Get a free API key →

coldkey*SS58 or hex formathotkeySS58 or hex formatblock_startStart of block range (inclusive)block_endEnd of block range (inclusive)timestamp_startStart of timestamp range in Unix timestamp (seconds since 1970-01-01) (inclusive)timestamp_endEnd of timestamp range in Unix timestamp (seconds since 1970-01-01) (inclusive)pagepagelimitlimitorderorder

curl

Parameters

Name	In	Type	Required	Description
`coldkey`	query	`string`	✅	SS58 or hex format
`hotkey`	query	`string`		SS58 or hex format
`block_start`	query	`integer`		Start of block range (inclusive)
`block_end`	query	`integer`		End of block range (inclusive)
`timestamp_start`	query	`integer`		Start of timestamp range in Unix timestamp (seconds since 1970-01-01) (inclusive)
`timestamp_end`	query	`integer`		End of timestamp range in Unix timestamp (seconds since 1970-01-01) (inclusive)
`page`	query	`integer`
`limit`	query	`integer`
`order`	query	`—`

Responses

`200` — Stakes retrieved successfully

Media: application/json

Schema

{
  "type": "object",
  "required": [
    "pagination",
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "block_number",
          "timestamp",
          "hotkey",
          "coldkey",
          "stake"
        ],
        "properties": {
          "block_number": {
            "type": "integer",
            "format": "int32"
          },
          "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"
              }
            }
          },
          "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"
              }
            }
          },
          "stake": {
            "type": "string"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "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"
        }
      }
    }
  }
}

Examples

{
  "Result": {
    "value": "{\n  \"pagination\": {\n    \"current_page\": 1,\n    \"per_page\": 2,\n    \"total_items\": 110,\n    \"total_pages\": 55,\n    \"next_page\": 2,\n    \"prev_page\": null\n  },\n  \"data\": [\n    {\n      \"block_number\": 4202794,\n      \"timestamp\": \"2024-11-05T23:59:48.004Z\",\n      \"hotkey\": {\n        \"ss58\": \"5GKH9FPPnWSUoeeTJp19wVtd84XqFW4pyK2ijV2GsFbhTrP1\",\n        \"hex\": \"0xbc0e6b701243978c1fe73d721c7b157943a713fca9f3c88cad7a9f7799bc6b26\"\n      },\n      \"coldkey\": {\n        \"ss58\": \"5FNqfWE5DvzHiUZqyep3Bt4M9c5W3TTwu1PwDdbehYn17AwZ\",\n        \"hex\": \"0x9289666bacb76d306cd32affc6f0237e3634280a8975054f88adc8a7db8c1117\"\n      },\n      \"stake\": \"2404415797\"\n    },\n    {\n      \"block_number\": 4195605,\n      \"timestamp\": \"2024-11-04T23:59:48.004Z\",\n      \"hotkey\": {\n        \"ss58\": \"5GKH9FPPnWSUoeeTJp19wVtd84XqFW4pyK2ijV2GsFbhTrP1\",\n        \"hex\": \"0xbc0e6b701243978c1fe73d721c7b157943a713fca9f3c88cad7a9f7799bc6b26\"\n      },\n      \"coldkey\": {\n        \"ss58\": \"5FNqfWE5DvzHiUZqyep3Bt4M9c5W3TTwu1PwDdbehYn17AwZ\",\n        \"hex\": \"0x9289666bacb76d306cd32affc6f0237e3634280a8975054f88adc8a7db8c1117\"\n      },\n      \"stake\": \"2403386507\"\n    }\n  ]\n}"
  }
}

`400` — Bad request

`404` — Stakes not found

`500` — Internal server error

Authentication

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