paradex_vault_summary
Retrieve a detailed summary of vaults on the Paradex platform, including balances, positions, and performance metrics. Filter, sort, or transform results using JMESPath expressions for targeted insights.
Instructions
Get a comprehensive summary of a specific vault or all vaults if no address is provided.
Retrieves a summary of all important information about a vault,
including balance, positions, recent activity, and performance metrics.
This provides a high-level overview of the vault's current state.
Use jmespath_filter to reduce the number of results as much as possible as number of vaults can be large.
You can use JMESPath expressions to filter, sort, or transform the results.
Examples:
- Filter by TVL: "[?to_number(tvl) > `10000`]"
- Filter by performance: "[?to_number(total_roi) > `5.0`]"
- Sort by TVL (descending): "reverse(sort_by([*], &to_number(tvl)))"
- Get top performers: "sort_by([*], &to_number(total_roi))[-3:]"
- Filter by recent returns: "[?to_number(roi_24h) > `0.5`]"
- Extract specific metrics: "[*].{address: address, tvl: tvl, total_roi: total_roi, volume_24h: volume_24h}"
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jmespath_filter | No | JMESPath expression to filter or transform the result. | |
| limit | No | Limit the number of results to the specified number. | |
| offset | No | Offset the results to the specified number. | |
| vault_address | No | The address of the vault to get summary for or None to get all vaults. |
Input Schema (JSON Schema)
{
"properties": {
"jmespath_filter": {
"default": null,
"description": "JMESPath expression to filter or transform the result.",
"title": "Jmespath Filter",
"type": "string"
},
"limit": {
"default": 10,
"description": "Limit the number of results to the specified number.",
"exclusiveMinimum": 0,
"maximum": 100,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Offset the results to the specified number.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"vault_address": {
"default": null,
"description": "The address of the vault to get summary for or None to get all vaults.",
"title": "Vault Address",
"type": "string"
}
},
"title": "get_vault_summaryArguments",
"type": "object"
}