paradex_vault_balance
Read-only
Retrieve current vault balance including available, locked, and total funds to assess financial state before trading or withdrawals.
Instructions
Get the current balance of a specific vault.
Retrieves the current balance information for a specific vault, including available funds, locked funds, and total balance. This is essential for understanding the financial state of a vault before executing trades or withdrawals.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vault_address | Yes | The address of the vault to get balance for. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/mcp_paradex/tools/vaults.py:124-149 (handler)The main handler function for the 'paradex_vault_balance' tool. It fetches vault balance from the Paradex API, validates the response against the VaultBalance model, and returns it.
@server.tool(name="paradex_vault_balance", annotations=ToolAnnotations(readOnlyHint=True)) async def get_vault_balance( vault_address: Annotated[ str, Field(description="The address of the vault to get balance for.") ], ) -> list[VaultBalance]: """ Get the current balance of a specific vault. Retrieves the current balance information for a specific vault, including available funds, locked funds, and total balance. This is essential for understanding the financial state of a vault before executing trades or withdrawals. """ try: client = await get_paradex_client() response = await api_call(client, "vaults/balance", params={"address": vault_address}) if "error" in response: raise Exception(response["error"]) results = response["results"] balances = vault_balance_adapter.validate_python(results) return balances except Exception as e: logger.error(f"Error fetching balance for vault {vault_address}: {e!s}") raise e - src/mcp_paradex/models.py:265-271 (schema)The VaultBalance Pydantic model used for input/output validation of the vault balance data, with fields: token, size, and last_updated_at.
class VaultBalance(BaseModel): """Model representing the balance of a vault.""" token: Annotated[str, Field(description="Name of the token")] size: Annotated[str, Field(description="Balance amount of settlement token")] last_updated_at: Annotated[int, Field(description="Balance last updated time")] - TypeAdapter for list[VaultBalance] used to validate and parse the API response into a list of VaultBalance objects.
vault_balance_adapter = TypeAdapter(list[VaultBalance]) - src/mcp_paradex/tools/vaults.py:124-129 (registration)Tool registration via @server.tool(name='paradex_vault_balance', ...) decorator on the get_vault_balance async function.
@server.tool(name="paradex_vault_balance", annotations=ToolAnnotations(readOnlyHint=True)) async def get_vault_balance( vault_address: Annotated[ str, Field(description="The address of the vault to get balance for.") ], ) -> list[VaultBalance]: - src/mcp_paradex/tools/__init__.py:8-12 (registration)The vaults module is imported in __init__.py, which triggers the registration of all vault-related tools including paradex_vault_balance.
from . import market, system, vaults # Only register auth-required tools when authenticated if config.is_configured(): from . import account, orders