Create vault | Paradex | Documentation

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,
  "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"
    }
  ],
  "token_address": "string"
}

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

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

profit_shareintegerOptional

Vault owner profit share (percentage)

public_keystringOptional

Public key of vault operator

Response

Created

addressstring

Contract address of the vault

created_atinteger

Unix timestamp in milliseconds of when the vault has been created

descriptionstring

Description of the vault

kindenum

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

Allowed values:

last_updated_atinteger

Unix timestamp in milliseconds of when the vault was last updated

lockup_periodinteger

Lockup period of the vault in days

max_tvlinteger

Maximum amount of assets the vault can hold in USDC

namestring

Name of the vault

operator_accountstring

Operator account of the vault

owner_accountstring

Owner account of the vault

profit_shareinteger

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

statusenum

Status of the vault

Allowed values:

strategieslist of objects

Strategies of the vault

token_addressstring

LP token address

Errors

400

Bad Request Error

Headers

Request

Response

Errors