Create vault

POST

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

POST

/v1/vaults

curl -X POST https://api.prod.paradex.trade/v1/vaults \
     -H "PARADEX-PARENT-ACCOUNT: PARADEX-PARENT-ACCOUNT" \
     -H "PARADEX-STARKNET-SIGNATURE: PARADEX-STARKNET-SIGNATURE" \
     -H "PARADEX-STARKNET-ACCOUNT: PARADEX-STARKNET-ACCOUNT" \
     -H "PARADEX-STARKNET-ACCOUNT-DERIVATION-PATH: PARADEX-STARKNET-ACCOUNT-DERIVATION-PATH" \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "address": "0x1234567890abcdef",
  "created_at": 1517171717,
  "curator_name": "Some Curator",
  "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",
  "strategies": [
    {
      "address": "0x29464b79b02543ed8746bba6e71c8a15401dd27b7279a5fa2f2fe8e8cdfabb",
      "name": "Alpha Strategy",
      "visibility": {
        "balances": true,
        "positions": true
      }
    }
  ],
  "strategy_description": "Delta Neutral",
  "token_address": "string",
  "visibility": {
    "balances": true,
    "positions": true
  }
}

Create a new vault by providing deployment parameters.Current user will be set as owner of the account and a new sub-account will be deployed as vault operator.

Request

Vault parameters

curator_namestringOptional

Curator name for the vault (optional)

deposit_tx_signaturestringOptional

Initial deposit transfer by vault owner

descriptionstringOptional

Description for the vault

lockup_periodintegerOptional

User's deposits lockup period in days

max_tvlintegerOptional

Max TVL locked by the Vault, if any. 0 for unlimited

namestringOptional

Unique name for the vault

operator_eth_addressstringOptional

EVM address of the vault operator (empty for legacy Starknet operator)

operator_indexintegerOptional

Index of the operator sub-account (0 for legacy Starknet operator)

operator_signer_typestringOptional

Signer type for the operator: “starknet” (default when empty) or “eip191”

profit_shareintegerOptional

Vault owner profit share (percentage)

public_keystringOptional

Public key of vault operator

show_balancesbooleanOptional

Whether the vault's balances are publicly visible. Defaults to true when omitted.

show_positionsbooleanOptional

Whether the vault's positions are publicly visible. Defaults to true when omitted.

strategy_descriptionstringOptional

Strategy description for the vault (optional)

Response

Created

addressstringOptional

Contract address of the vault

created_atintegerOptional

Unix timestamp in milliseconds of when the vault has been created

curator_namestringOptional

Curator name of the vault (empty string if not set)

descriptionstringOptional

Description of the vault

kindenumOptional

Kind of the vault: ‘user’ for user-defined vaults, ‘protocol’ for vaults controlled by Paradex

last_updated_atintegerOptional

Unix timestamp in milliseconds of when the vault was last updated

lockup_periodintegerOptional

Lockup period of the vault in days

max_tvlintegerOptional

Maximum amount of assets the vault can hold in USDC

namestringOptional

Name of the vault

operator_accountstringOptional

Operator account of the vault

owner_accountstringOptional

Owner account of the vault

profit_shareintegerOptional

Profit share of the vault in percentage, i.e. 10 means 10%

statusenumOptional

Status of the vault

strategieslist of objectsOptional

Strategies of the vault

strategy_descriptionstringOptional

Strategy description of the vault (empty string if not set)

token_addressstringOptional

LP token address

visibilityobjectOptional

Owner-controlled visibility settings for the vault

Errors

400

Bad Request Error

Headers

Request

Response

Errors