Sanctum API

Sanctum API specification. It requires an API key distributed on demand

Get LST by mint or symbol

get

Retrieves information about a specific Liquid Staking Token (LST) by its mint address or symbol

Path parameters

mintOrSymbolstringRequired

Mint address or symbol of the LST

Query parameters

apiKeystringRequired

API key for authentication

Responses

200

Successful operation

application/json

404

Resource not found

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /lsts/{mintOrSymbol}?apiKey=text HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "mint": "text",
      "symbol": "text",
      "name": "text",
      "logoUri": "text",
      "decimals": 1,
      "website": "text",
      "holders": 1,
      "launchDate": "text",
      "mainValueProposition": "text",
      "oneLiner": "text",
      "bulletPoints": [
        "text"
      ],
      "twitter": "text",
      "telegramGroupLink": "text",
      "categories": [
        "text"
      ],
      "description": "text",
      "sanctumAutomated": true,
      "managerFeeConfig": {},
      "tvl": 1,
      "latestApy": 1,
      "avgApy": 1,
      "solValue": 1,
      "slug": "text"
    }
  ]
}

Get all LSTs

get

Retrieves a list of all Liquid Staking Tokens (LSTs) with their data

Query parameters

apiKeystringRequired

API key for authentication

Responses

200

Successful operation

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /lsts?apiKey=text HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "mint": "text",
      "symbol": "text",
      "name": "text",
      "logoUri": "text",
      "decimals": 1,
      "website": "text",
      "holders": 1,
      "launchDate": "text",
      "mainValueProposition": "text",
      "oneLiner": "text",
      "bulletPoints": [
        "text"
      ],
      "twitter": "text",
      "telegramGroupLink": "text",
      "categories": [
        "text"
      ],
      "description": "text",
      "sanctumAutomated": true,
      "managerFeeConfig": {},
      "tvl": 1,
      "latestApy": 1,
      "avgApy": 1,
      "solValue": 1,
      "slug": "text"
    }
  ]
}

Get LST APYs

get

Retrieves APY history for a specific Liquid Staking Token (LST)

Path parameters

mintOrSymbolstringRequired

Mint address or symbol of the LST

Query parameters

limitinteger · min: 1 · max: 1500Optional

Number of epochs to retrieve (max 1500, default 1)

Default: 1

apiKeystringRequired

API key for authentication

Responses

200

Successful operation

application/json

400

Bad request

application/json

404

Resource not found

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /lsts/{mintOrSymbol}/apys?apiKey=text HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "epoch": 1,
      "epochEndTs": 1,
      "apy": 1
    }
  ]
}