Vaults

Get vaults

Get list of available vaults.

GEThttps://api.prod.paradex.trade/v1/vaults
Query parameters
Response

OK

Body
resultsarray of responses.VaultResp (object)

List of vaults

Request
const response = await fetch('https://api.prod.paradex.trade/v1/vaults', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "results": [
    {
      "address": "0x1234567890abcdef",
      "created_at": 1517171717,
      "description": "My description",
      "kind": "user",
      "last_updated_at": 1617171717,
      "lockup_period": 1,
      "max_tvl": 1000000,
      "name": "MyVault",
      "operator_account": "0x1234567890abcdef",
      "owner_account": "0x0234567890abcdef",
      "profit_share": 10,
      "status": "ACTIVE",
      "token_address": "text"
    }
  ]
}

Get vault account summary

Get current user summary metrics for all vaults or for the single vault specified by address. User metrics are only returned if the current user is a depositor for the vault.

GEThttps://api.prod.paradex.trade/v1/vaults/account-summary
Authorization
Query parameters
Response

OK

Body
resultsarray of responses.VaultAccountSummaryResp (object)

List of vaults account summaries

Request
const response = await fetch('https://api.prod.paradex.trade/v1/vaults/account-summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "results": [
    {
      "address": "0x1234567890abcdef",
      "created_at": 1717171717,
      "deposited_amount": "123.45",
      "total_pnl": "149.12",
      "total_roi": "0.724",
      "vtoken_amount": "123.45"
    }
  ]
}

Get vaults config

Get vaults global configuration.

GEThttps://api.prod.paradex.trade/v1/vaults/config
Response

OK

Body
max_lockup_period_daysstring

Maximum lockup period in days an owner can configure for a vault

Example: "4"
max_profit_share_percentagestring

Maximum profit share percentage (0-100) an owner can configure for a vault

Example: "50"
min_initial_depositstring

Minimum initial collateral deposit (in currency units) at vault creation. Only applies to the owner

Example: "1000"
min_lockup_period_daysstring

Minimum lockup period in days an owner can configure for a vault

Example: "1"
min_owner_share_percentagestring

Minimum share percentage (0-100) the vault owner must maintain on the vault

Example: "5"
vault_factory_addressstring

Address of the vault factory contract

Example: "0x1234567890abcdef"
Request
const response = await fetch('https://api.prod.paradex.trade/v1/vaults/config', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "max_lockup_period_days": "4",
  "max_profit_share_percentage": "50",
  "min_initial_deposit": "1000",
  "min_lockup_period_days": "1",
  "min_owner_share_percentage": "5",
  "vault_factory_address": "0x1234567890abcdef"
}

Get vault historical data

Get PnL and Account value historical timeseries for the given vault.

GEThttps://api.prod.paradex.trade/v1/vaults/history
Query parameters
Response

OK

Body
resultsarray of responses.VaultHistoricalDataResp (object)

List of requested vault timeseries

Request
const response = await fetch('https://api.prod.paradex.trade/v1/vaults/history?address=text&type=text&resolution=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "results": [
    {
      "address": "0x1234567890abcdef",
      "data": [
        0
      ],
      "timestamps": []
    }
  ]
}

Get vault positions

Get positions opened by the given vault.

GEThttps://api.prod.paradex.trade/v1/vaults/positions
Query parameters
Response

OK

Body
resultsarray of responses.PositionResp (object)

List of the vault's positions

Request
const response = await fetch('https://api.prod.paradex.trade/v1/vaults/positions?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "results": [
    {
      "average_entry_price": "29001.34",
      "average_entry_price_usd": "29001.34",
      "cached_funding_index": "1234.3",
      "cost": "-10005.4623",
      "cost_usd": "-10005.4623",
      "id": "1234234",
      "last_fill_id": "1234234",
      "last_updated_at": 1681493939981,
      "leverage": "text",
      "liquidation_price": "text",
      "market": "BTC-USD-PERP",
      "realized_positional_pnl": "text",
      "seq_no": 1681471234972000000,
      "side": "SHORT",
      "size": "-0.345",
      "status": "OPEN",
      "unrealized_funding_pnl": "12.234",
      "unrealized_pnl": "-123.23"
    }
  ]
}

Get vault summary

Get vaults summary metrics for all vaults or for the single vault specified by address.

GEThttps://api.prod.paradex.trade/v1/vaults/summary
Query parameters
Response

OK

Body
resultsarray of responses.VaultSummaryResp (object)

List of vaults summaries

Request
const response = await fetch('https://api.prod.paradex.trade/v1/vaults/summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "results": [
    {
      "address": "0x1234567890abcdef",
      "last_month_return": "0.023",
      "max_drawdown": "0.1916",
      "max_drawdown_24h": "0.0138",
      "max_drawdown_30d": "0.1821",
      "max_drawdown_7d": "0.1124",
      "net_deposits": "1000000",
      "num_depositors": 100,
      "owner_equity": "0.145",
      "pnl_24h": "13.41",
      "pnl_30d": "114.19",
      "pnl_7d": "91.31",
      "roi_24h": "0.034",
      "roi_30d": "0.003",
      "roi_7d": "0.123",
      "total_pnl": "149.12",
      "total_roi": "0.724",
      "tvl": "1000000",
      "volume": "12345678.16",
      "volume_24h": "45678.16",
      "volume_30d": "2345678.16",
      "volume_7d": "345678.16",
      "vtoken_price": "1.23",
      "vtoken_supply": "1000000"
    }
  ]
}
PreviousTransfersNextTestnet Documentation

Last updated