Create vault

POST

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

This endpoint expects an object.
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

addressstringOptional

Contract address of the vault

created_atintegerOptional

Unix timestamp in milliseconds of when the vault has been created

descriptionstringOptional

Description of the vault

kind"user" or "protocol"Optional
Allowed values: userprotocol

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
Allowed values: INITIALIZINGACTIVECLOSEDFAILED

Status of the vault

token_addressstringOptional

LP token address

Errors

Built with