Production API ReferenceVaults

Create vault

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.

Headers

PARADEX-PARENT-ACCOUNTstringRequired

Onboarded by prdx:0xa123456789

PARADEX-STARKNET-SIGNATUREstringRequired
Starknet signature
PARADEX-STARKNET-ACCOUNTstringRequired
Starknet address
PARADEX-STARKNET-ACCOUNT-DERIVATION-PATHstringRequired

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

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
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
kindenum

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

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
strategieslist of objects
Strategies of the vault
strategy_descriptionstring

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

token_addressstring
LP token address
visibilityobject

Owner-controlled visibility settings for the vault

Errors

400
Bad Request Error