Get Liquidity Position

Note

This endpoint’s description is auto-generated from the schema. Human-written copy is pending — see work/openapi/missing-descriptions.txt.

Endpoint

GET /api/dtao/liquidity/position/v1

Try it

API key

👁

Remember on this browser Get a free API key →

cURLTypeScriptPythonSDK

Run

ididcoldkeySS58 or hex formatnetuidnetuidpagepagelimitlimit

curlCopy

Parameters

Name	In	Type	Required	Description
id	query	string
coldkey	query	string		SS58 or hex format
netuid	query	integer
status	query	—
page	query	integer
limit	query	integer
order	query	—

Responses

200 — Liquidity positions retrieved successfully

Media: application/json

Schema

{
  "type": "object",
  "required": [
    "pagination",
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "coldkey",
          "netuid",
          "liquidity",
          "tick_low",
          "tick_high",
          "tao",
          "alpha",
          "max_price",
          "min_price",
          "tao_committed",
          "alpha_committed",
          "tao_withdrawn",
          "alpha_withdrawn",
          "fees_claimable_tao",
          "fees_claimable_alpha",
          "fees_claimed_tao",
          "fees_claimed_alpha",
          "block_number",
          "timestamp",
          "opened_block_number",
          "opened_timestamp"
        ],
        "properties": {
          "alpha": {
            "type": "string"
          },
          "alpha_committed": {
            "type": "string"
          },
          "alpha_withdrawn": {
            "type": "string"
          },
          "block_number": {
            "type": "integer",
            "format": "int32"
          },
          "closed_block_number": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "closed_timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "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"
              }
            }
          },
          "fees_claimable_alpha": {
            "type": "string"
          },
          "fees_claimable_tao": {
            "type": "string"
          },
          "fees_claimed_alpha": {
            "type": "string"
          },
          "fees_claimed_tao": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "last_modified_block_number": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "last_modified_timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "liquidity": {
            "type": "string"
          },
          "max_price": {
            "type": "string"
          },
          "min_price": {
            "type": "string"
          },
          "netuid": {
            "type": "integer",
            "format": "int32"
          },
          "opened_block_number": {
            "type": "integer",
            "format": "int32"
          },
          "opened_timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "tao": {
            "type": "string"
          },
          "tao_committed": {
            "type": "string"
          },
          "tao_withdrawn": {
            "type": "string"
          },
          "tick_high": {
            "type": "integer",
            "format": "int32"
          },
          "tick_low": {
            "type": "integer",
            "format": "int32"
          },
          "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"
        }
      }
    }
  }
}

400 — Bad request

404 — Liquidity positions not found

500 — Internal server error

Authentication

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