Vaults

Create vault

Changed on

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.

To create a Starknet vault operator, send the vault owner's main-key session JWT as the bearer token. Subkey, readonly and RPC tokens do not prove ownership. A request without that token is rejected with VAULT_OPERATOR_OWNER_PROOF_REQUIRED.

post/vaults

Request

  • Base URL
    https://api.prod.paradex.trade/v1
  • URL
    https://api.prod.paradex.trade/v1/vaults
  • Auth
    API key in header Authorization

Headers

PARADEX-PARENT-ACCOUNTstring required

Onboarded by prdx:0xa123456789

PARADEX-STARKNET-SIGNATUREstring required

Starknet signature

PARADEX-STARKNET-ACCOUNTstring required

Starknet address

PARADEX-STARKNET-ACCOUNT-DERIVATION-PATHstring required

Account derivation path - m/44'/9004'/0'/0/1

Request body

curator_namestring

Curator name for the vault (optional)

deposit_tx_signaturestring

Initial deposit transfer by vault owner

descriptionstring

Description for the vault

lockup_periodinteger

User's deposits lockup period in days

max_tvlinteger

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

namestring

Unique name for the vault

operator_eth_addressstring

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

operator_indexinteger

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

operator_signer_typestring

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

profit_shareinteger

Vault owner profit share (percentage)

public_keystring

Public key of vault operator

show_balancesboolean

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

show_positionsboolean

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

strategy_descriptionstring

Strategy description for the vault (optional)

Example request

{
  "curator_name": "Some Curator",
  "deposit_tx_signature": "[",
  "description": "My vault description",
  "lockup_period": 1,
  "max_tvl": 1000000,
  "name": "MyVault",
  "operator_eth_address": "0x1234567890abcdef1234567890abcdef12345678",
  "operator_index": 1,
  "operator_signer_type": "eip191",
  "profit_share": 10,
  "public_key": "0x1234567890abcdef",
  "show_balances": true,
  "show_positions": true,
  "strategy_description": "Delta Neutral"
}

Response

Created

addressstring

Contract address of the vault

created_atinteger

Unix timestamp in milliseconds of when the vault has been created

curator_namestring

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

descriptionstring

Description of the vault

kind'user' | 'protocol'
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%

status'INITIALIZING' | 'ACTIVE' | 'CLOSED' | 'FAILED'
strategy_descriptionstring

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

token_addressstring

LP token address

Example response

{
  "address": "0x1234567890abcdef",
  "created_at": 1517171717,
  "curator_name": "Some Curator",
  "description": "My description",
  "last_updated_at": 1617171717,
  "lockup_period": 1,
  "max_tvl": 1000000,
  "name": "MyVault",
  "operator_account": "0x1234567890abcdef",
  "owner_account": "0x0234567890abcdef",
  "profit_share": 10,
  "strategies": [
    {
      "address": "0x29464b79b02543ed8746bba6e71c8a15401dd27b7279a5fa2f2fe8e8cdfabb",
      "name": "Alpha Strategy",
      "visibility": {
        "balances": true,
        "positions": true
      }
    }
  ],
  "strategy_description": "Delta Neutral",
  "visibility": {
    "balances": true,
    "positions": true
  }
}

Changes

  • f33feb7333eaRevision changes
    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

  • 72c125c93c2bRevision changes
    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status