For the complete documentation index, see llms.txt. This page is also available as Markdown.

Vault

Query Vault Detail

get
/info/vault/detail

Returns vault info (TVL, APR, PnL). If userAddress is provided, also returns user position data. When querying a parent vault, TVL/PnL/APR aggregate all sub-vaults.

Query parameters
vaultAddressstringRequired
userAddressstringOptional

Include user position data

Responses
200

Vault detail

application/json
get/info/vault/detail
const resp = await fetch(
  `${BASE_URL}/info/vault/detail?vaultAddress=0x4b90...&userAddress=0xfc84...`
);
200

Vault detail

{
  "code": 0,
  "message": "success",
  "data": {
    "vaultAddress": "0x4b90BBE5...",
    "ownerAddress": "0xfc846581...",
    "vaultName": "test",
    "tvl": "100.000000",
    "price": "1.000000",
    "apr": null,
    "status": 1,
    "yourDeposits": "100.000000",
    "userCurrentValue": "100.000000"
  }
}

Query User's Vault List

get
/info/vault/user-list

Returns all vaults where user holds shares > 0.

Query parameters
userAddressstringRequired
Responses
200

List of vaults with user holdings

No content

get/info/vault/user-list
const resp = await fetch(
  `${BASE_URL}/info/vault/user-list?userAddress=0xabc...`
);
200

List of vaults with user holdings

No content

Query User Vault Position

get
/info/vault/user

Returns user's full position info in a specific vault.

Query parameters
vaultAddressstringRequired
userAddressstringRequired
Responses
200

User vault position detail

No content

get/info/vault/user
const resp = await fetch(
  `${BASE_URL}/info/vault/user?vaultAddress=0x4b90...&userAddress=0xfc84...`
);
200

User vault position detail

No content

Query All Vaults

get
/info/vault/list

Returns all parent vaults (Active and Closed). Sub-vaults not listed. TVL and APR aggregate sub-vault data.

Query parameters
userAddressstringOptional

Include yourDeposit field when provided

Responses
200

Vault list with total locked value

No content

get/info/vault/list
const resp = await fetch(`${BASE_URL}/info/vault/list`);
200

Vault list with total locked value

No content

Query Vault History

get
/info/vault/history

Returns vault TVL or PnL time-series data.

interval
Range
Granularity

24h

Last 24 hours

1 hour

7d

Last 7 days

12 hours

30d

Last 30 days

1 day

all-time

All history

1 month

Query parameters
vaultAddressstringRequired
typestring · enumOptionalDefault: tvlPossible values:
intervalstring · enumOptionalDefault: 24hPossible values:
Responses
200

Time-series data

No content

get/info/vault/history
const resp = await fetch(
  `${BASE_URL}/info/vault/history?vaultAddress=0x4b90...&type=tvl&interval=7d`
);
200

Time-series data

No content

Query Vault Deposit/Withdraw Events

get
/info/vault/events
Query parameters
vaultAddressstringRequired
pageintegerOptionalDefault: 1
pageSizeintegerOptionalDefault: 20
Responses
200

Paginated deposit/withdraw events

No content

get/info/vault/events
const resp = await fetch(
  `${BASE_URL}/info/vault/events?vaultAddress=0x4b90...&page=1`
);
200

Paginated deposit/withdraw events

No content

Query Vault Depositors

get
/info/vault/depositors

Returns all depositors with shares > 0.

Query parameters
vaultAddressstringRequired
Responses
200

Depositor list

No content

get/info/vault/depositors
const resp = await fetch(
  `${BASE_URL}/info/vault/depositors?vaultAddress=0x4b90...`
);
200

Depositor list

No content

Last updated