> For the complete documentation index, see [llms.txt](https://docs.afx.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.afx.xyz/api-reference/info/vault.md).
# Vault
## Query 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.
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/detail":{"get":{"operationId":"getVaultDetail","summary":"Query Vault Detail","tags":["Vault"],"description":"Returns vault info (TVL, APR, PnL). If `userAddress` is provided, also returns user position data.\nWhen querying a parent vault, TVL/PnL/APR aggregate all sub-vaults.\n","parameters":[{"name":"vaultAddress","in":"query","required":true,"schema":{"type":"string"}},{"name":"userAddress","in":"query","schema":{"type":"string"},"description":"Include user position data"}],"responses":{"200":{"description":"Vault detail","content":{"application/json":{}}}}}}}}
```
## Query User's Vault List
> Returns all vaults where user holds shares > 0.
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/user-list":{"get":{"operationId":"getUserVaultList","summary":"Query User's Vault List","tags":["Vault"],"description":"Returns all vaults where user holds shares > 0.","parameters":[{"name":"userAddress","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of vaults with user holdings"}}}}}}
```
## Query User Vault Position
> Returns user's full position info in a specific vault.
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/user":{"get":{"operationId":"getUserVaultInfo","summary":"Query User Vault Position","tags":["Vault"],"description":"Returns user's full position info in a specific vault.","parameters":[{"name":"vaultAddress","in":"query","required":true,"schema":{"type":"string"}},{"name":"userAddress","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User vault position detail"}}}}}}
```
## Query All Vaults
> Returns all parent vaults (Active and Closed). Sub-vaults not listed.\
> TVL and APR aggregate sub-vault data.
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/list":{"get":{"operationId":"getVaultList","summary":"Query All Vaults","tags":["Vault"],"description":"Returns all parent vaults (Active and Closed). Sub-vaults not listed.\nTVL and APR aggregate sub-vault data.\n","parameters":[{"name":"userAddress","in":"query","schema":{"type":"string"},"description":"Include `yourDeposit` field when provided"}],"responses":{"200":{"description":"Vault list with total locked value"}}}}}}
```
## Query 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 |
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/history":{"get":{"operationId":"getVaultHistory","summary":"Query Vault History","tags":["Vault"],"description":"Returns vault TVL or PnL time-series data.\n\n| interval | Range | Granularity |\n|----------|-------|-------------|\n| 24h | Last 24 hours | 1 hour |\n| 7d | Last 7 days | 12 hours |\n| 30d | Last 30 days | 1 day |\n| all-time | All history | 1 month |\n","parameters":[{"name":"vaultAddress","in":"query","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string","default":"tvl","enum":["tvl","pnl"]}},{"name":"interval","in":"query","schema":{"type":"string","default":"24h","enum":["24h","7d","30d","all-time"]}}],"responses":{"200":{"description":"Time-series data"}}}}}}
```
## GET /info/vault/events
> Query Vault Deposit/Withdraw Events
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/events":{"get":{"operationId":"getVaultEvents","summary":"Query Vault Deposit/Withdraw Events","tags":["Vault"],"parameters":[{"name":"vaultAddress","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"Paginated deposit/withdraw events"}}}}}}
```
## Query Vault Depositors
> Returns all depositors with shares > 0.
```json
{"openapi":"3.0.3","info":{"title":"AFX DEX Info API","version":"1.0.0"},"servers":[{"url":"https://api.afx.xyz","description":"Mainnet"},{"url":"https://api-testnet.afx.xyz","description":"Testnet"}],"paths":{"/info/vault/depositors":{"get":{"operationId":"getVaultDepositors","summary":"Query Vault Depositors","tags":["Vault"],"description":"Returns all depositors with shares > 0.","parameters":[{"name":"vaultAddress","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Depositor list"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.afx.xyz/api-reference/info/vault.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.