> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.paradex.trade/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.paradex.trade/_mcp/server.

# Get vault summary

GET https://api.prod.paradex.trade/v1/vaults/summary

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


Reference: https://docs.paradex.trade/api/prod/vaults/get-summary

## Request

### Query parameters

- `address` (string, optional) — Vault Address

## Response

### 200

OK

- `results` (list of responses.VaultSummaryResp, optional) — Array of results

## Errors

### 400 Bad Request Error

Bad Request

- `data` (ResponsesApiErrorData, optional) — any additional data related to the error
- `error` (enum, optional) — unique immutable string identifier for specific error
  - Allowed values: `VALIDATION_ERROR`, `BINDING_ERROR`, `INTERNAL_ERROR`, `NOT_FOUND`, `SERVICE_UNAVAILABLE`, `INVALID_REQUEST_PARAMETER`, `ORDER_ID_NOT_FOUND`, `ORDER_IS_CLOSED`, `ORDER_IS_NOT_OPEN`, `INVALID_ORDER_SIZE`, `CLIENT_ORDER_ID_NOT_FOUND`, `DUPLICATED_CLIENT_ID`, `INVALID_SYMBOL`, `INVALID_TOKEN`, `INVALID_ETHEREUM_ADDRESS`, `INVALID_ETHEREUM_SIGNATURE`, `INVALID_STARKNET_ADDRESS`, `INVALID_STARKNET_SIGNATURE`, `STARKNET_SIGNATURE_VERIFICATION_FAILED`, `ETHEREUM_SIGNER_MISMATCH`, `ETHEREUM_HASH_MISMATCH`, `NOT_ONBOARDED`, `INVALID_TIMESTAMP`, `INVALID_BLOCK_EXPIRATION`, `ACCOUNT_NOT_FOUND`, `MEDIA_NOT_FOUND`, `INVALID_ORDER_SIGNATURE`, `PUBLIC_KEY_INVALID`, `UNAUTHORIZED_ETHEREUM_ADDRESS`, `UNAUTHORIZED_ERROR`, `ETHEREUM_ADDRESS_ALREADY_ONBOARDED`, `EVM_ADDRESS_ALREADY_ONBOARDED`, `MARKET_NOT_FOUND`, `ALLOWLIST_ENTRY_NOT_FOUND`, `USERNAME_IN_USE`, `GEO_IP_BLOCK`, `ETHEREUM_ADDRESS_BLOCKED`, `PROGRAM_NOT_FOUND`, `PROGRAM_NOT_SUPPORTED`, `INVALID_DASHBOARD`, `MARKET_NOT_OPEN`, `MARKET_NOT_SETTLED`, `INVALID_REFERRAL_CODE`, `REQUEST_NOT_ALLOWED`, `PARENT_ADDRESS_ALREADY_ONBOARDED`, `INVALID_PARENT_ACCOUNT`, `INVALID_VAULT_OPERATOR_CHAIN`, `VAULT_OPERATOR_ALREADY_ONBOARDED`, `VAULT_NAME_IN_USE`, `VAULT_NOT_FOUND`, `VAULT_STRATEGY_NOT_FOUND`, `VAULT_LIMIT_REACHED`, `VAULT_DATA_PRIVATE`, `BATCH_SIZE_OUT_OF_RANGE`, `ISOLATED_MARKET_ACCOUNT_MISMATCH`, `NO_ACCESS_TO_MARKET`, `POINTS_SUMMARY_NOT_FOUND`, `ALGO_ID_NOT_FOUND`, `INVALID_DERIVATION_PATH`, `PROFILE_STATS_NOT_FOUND`, `INVALID_CHAIN`, `INVALID_LAYERSWAP_SWAP`, `INVALID_DEPOSIT_ADDRESS`, `SOCIAL_USERNAME_IN_USE`, `INVALID_OAUTH_REQUEST`, `RPI_ACCOUNT_NOT_WHITELISTED`, `SYSTEM_STATUS_POST_ONLY`, `SYSTEM_STATUS_CANCEL_ONLY`, `INVALID_MARKETING_CODE`, `OFFER_NOT_FOUND`, `MARKET_MARGIN_RESTRICTED`, `NOT_UNIQUE`, `ACCOUNT_ALREADY_REFERRED`, `ONBOARDING_PERIOD_EXPIRED`, `ONBOARDING_RATE_LIMITED`, `RFQ_CREATE_BUDGET_EXCEEDED`, `SUBACCOUNTS_LIMIT_EXCEEDED`, `INSUFFICIENT_MIN_CHAIN_BALANCE`, `INSUFFICIENT_EVM_BALANCE`, `PORTFOLIO_MARGIN_ONBOARDING_DISABLED`, `PORTFOLIO_MARGIN_INVALID_ACCOUNT_KIND`, `EVM_VAULT_OPERATORS_DISABLED`, `VAULT_OPERATOR_OWNER_PROOF_REQUIRED`, `INVALID_EVM_SIGNATURE`, `EVM_SIGNATURE_VERIFICATION_FAILED`, `INVALID_SUBKEY`, `SUBKEY_NOT_ACTIVATABLE`, `SUBKEY_REVOKED`, `TOKEN_LIMIT_REACHED`, `INVALID_TOKEN_SCOPE`, `IP_NOT_ALLOWED`, `INSUFFICIENT_TRANSFERRABLE_XP`, `TRANSFER_LIMIT_REACHED`, `XP_TRANSFERS_DISABLED`, `BLOCK_TRADE_NOT_FOUND`, `BLOCK_TRADE_NOT_ENABLED`, `BLOCK_TRADE_EXPIRED`, `BLOCK_TRADE_ALREADY_CANCELLED`, `BLOCK_TRADE_INVALID_STATUS`, `BLOCK_TRADE_UNAUTHORIZED`, `BLOCK_TRADE_MISSING_TRADES`, `BLOCK_TRADE_MISSING_SIGNERS`, `BLOCK_TRADE_MISSING_SIGNATURE`, `BLOCK_TRADE_ACCOUNT_MISMATCH`, `BLOCK_TRADE_INVALID_SIGNATURE`, `BLOCK_TRADE_SIGNER_KEY_UNAUTHORIZED`, `BLOCK_TRADE_REPLAYED_SIGNATURE`, `BLOCK_TRADE_SELF_TRADE`, `OFFER_ALREADY_CANCELLED`, `OFFER_INVALID_STATUS`, `OFFER_UNAUTHORIZED`, `OFFER_PARENT_MISMATCH`, `OFFER_PARENT_NOT_ACCEPTING`, `PORTFOLIO_MARGIN_CONFIG_NOT_FOUND`, `MARGIN_CONFIG_NOT_FOUND`, `MMP_CONFIG_INVALID`, `MMP_NOT_ENABLED`, `MMP_MIN_FREEZE_NOT_ELAPSED`, `MMP_NOT_CONFIGURED`, `RFQ_VENUE_UNAVAILABLE`, `ADDRESS_BOOK_ENTRY_NOT_FOUND`, `ADDRESS_BOOK_INVALID_LABEL`, `ADDRESS_BOOK_OWN_ACCOUNT`, `ADDRESS_BOOK_DUPLICATE_ADDRESS`, `ADDRESS_BOOK_LIMIT_REACHED`
- `message` (string, optional) — detailed description of error and how to address it

## Types

### responses.VaultSummaryResp

- `address` (string, optional) — Contract address of the vault
- `last_month_return` (string, optional) — Annualized return of the vault over the last 30 days, in percentage, i.e. 0.1 means 10%
- `max_drawdown` (string, optional) — Max all time drawdown realized by the vault, as a positive magnitude in percentage, i.e. 0.1 means a 10% fall
- `max_drawdown_24h` (string, optional) — Max drawdown realized by the vault in the last 24 hours, as a positive magnitude in percentage, i.e. 0.1 means a 10% fall
- `max_drawdown_30d` (string, optional) — Max drawdown realized by the vault in the last 30 days, as a positive magnitude in percentage, i.e. 0.1 means a 10% fall
- `max_drawdown_7d` (string, optional) — Max drawdown realized by the vault in the last 7 days, as a positive magnitude in percentage, i.e. 0.1 means a 10% fall
- `net_deposits` (string, optional) — Net deposits of the vault in USDC
- `next_fee_settlement_at` (integer, optional, nullable) — Estimated time of the vault's next profit-share fee settlement, as a Unix timestamp in milliseconds. Null when the next settlement time is not yet known.
- `num_depositors` (integer, optional) — Number of depositors on the vault
- `owner_equity` (string, optional) — Vault equity of the owner (% of ownership) in percentage, i.e. 0.1 means 10%
- `pnl_24h` (string, optional) — P&L of the vault in the last 24 hours in USDC
- `pnl_30d` (string, optional) — P&L of the vault in the last 30 days in USDC
- `pnl_7d` (string, optional) — P&L of the vault in the last 7 days in USDC
- `profit_share_period` (string, optional) — How often THIS vault settles profit-share fees, in seconds. Falls back to the exchange-wide default when the vault carries none of its own; 0 means not configured
- `roi_24h` (string, optional) — Return of the vault in the last 24 hours in percentage, i.e. 0.1 means 10%
- `roi_30d` (string, optional) — Return of the vault in the last 30 days in percentage, i.e. 0.1 means 10%
- `roi_7d` (string, optional) — Return of the vault in the last 7 days in percentage, i.e. 0.1 means 10%
- `strategies` (list of responses.VaultSummaryStrategy, optional) — Profit-share terms and performance index for each of the vault's strategies
- `total_pnl` (string, optional) — Total P&L of the vault in USDC
- `total_roi` (string, optional) — Total ROI of the vault in percentage, i.e. 0.1 means 10%
- `tvl` (string, optional) — Total Value Locked (deposits + unrealized PnL) in USDC
- `volume` (string, optional) — All time volume traded by the vault in USD
- `volume_24h` (string, optional) — Volume traded by the vault in the last 24 hours in USD
- `volume_30d` (string, optional) — Volume traded by the vault in the last 30 days in USD
- `volume_7d` (string, optional) — Volume traded by the vault in the last 7 days in USD
- `vtoken_price` (string, optional) — Current value of vault token price in USD
- `vtoken_supply` (string, optional) — Total amount of available vault tokens

### ResponsesApiErrorData

any additional data related to the error

### responses.VaultSummaryStrategy

- `fee_recipient` (string, optional) — Address that receives this strategy's profit-share fees. Set per strategy and need not match the strategy address. Empty when no recipient is set.
- `pnl_index` (string, optional) — Latest performance index recorded for this strategy
- `profit_share_percentage` (string, optional) — Profit share percentage agreed for this strategy, i.e. 10 means 10%. 0 for a strategy that predates per-strategy profit share, which charges nothing. Empty when terms exist but the rate has not been seen, in which case the charged rate is unknown.
- `strategy` (string, optional) — Strategy address

## Examples

**Response**

```json
{
  "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",
      "next_fee_settlement_at": 1719191919000,
      "num_depositors": 100,
      "owner_equity": "0.145",
      "pnl_24h": "13.41",
      "pnl_30d": "114.19",
      "pnl_7d": "91.31",
      "profit_share_period": "86400",
      "roi_24h": "0.034",
      "roi_30d": "0.003",
      "roi_7d": "0.123",
      "strategies": [
        {
          "fee_recipient": "0x7f2c5a1e9b48d3f06a1c8e5b2d94f7a3c60e18b5d4a29f7c3e8b1a6d05f24c9",
          "pnl_index": "1.0512",
          "profit_share_percentage": "10",
          "strategy": "0x29464b79b02543ed8746bba6e71c8a15401dd27b7279a5fa2f2fe8e8cdfabb"
        }
      ],
      "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"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.prod.paradex.trade/v1/vaults/summary"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.prod.paradex.trade/v1/vaults/summary';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prod.paradex.trade/v1/vaults/summary"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prod.paradex.trade/v1/vaults/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.prod.paradex.trade/v1/vaults/summary")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prod.paradex.trade/v1/vaults/summary');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.prod.paradex.trade/v1/vaults/summary");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prod.paradex.trade/v1/vaults/summary")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```