Vaults

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.

post/vaults

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

Changed in 8 of the 65 revisions of this API.43220

  • f1370c46e9e837See the full diff
    • added the new BLOCK_TRADE_REPLAYED_SIGNATURE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new EVM_VAULT_OPERATORS_DISABLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new VAULT_DATA_PRIVATE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • removed the INVALID_RHINOFI_QUOTE enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the INVALID_RHINOFI_QUOTE_COMMIT enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the INVALID_RHINOFI_REQUEST enum value from the //// response property for the response status

      response-property-enum-value-removed

  • 7861dbd35cf524See the full diff
    • added the new IP_NOT_ALLOWED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new MARKET_NOT_SETTLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new optional request property

      new-optional-request-property

    • added the new optional request property

      new-optional-request-property

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the new BLOCK_TRADE_INVALID_SIGNATURE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_SIGNER_KEY_UNAUTHORIZED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new EVM_ADDRESS_ALREADY_ONBOARDED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new INSUFFICIENT_EVM_BALANCE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PORTFOLIO_MARGIN_INVALID_ACCOUNT_KIND enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PORTFOLIO_MARGIN_ONBOARDING_DISABLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • removed the BAD_STARKNET_REQUEST enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the INVALID_PRICE_PRECISION enum value from the //// response property for the response status

      response-property-enum-value-removed

    • removed the TRANSACTION_NOT_FOUND enum value from the //// response property for the response status

      response-property-enum-value-removed

  • 46a57608a7903211See the full diff
    • the response's property type changed from object to no type for status

      response-property-type-changed

    • the response's property type changed from object to no type for status

      response-property-type-changed

    • the response's property type changed from object to no type for status

      response-property-type-changed

    • added the new BLOCK_TRADE_ACCOUNT_MISMATCH enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_ALREADY_CANCELLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_EXPIRED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_INVALID_STATUS enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_MISSING_SIGNATURE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_MISSING_SIGNERS enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_MISSING_TRADES enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_NOT_ENABLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_NOT_FOUND enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new BLOCK_TRADE_UNAUTHORIZED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new EVM_SIGNATURE_VERIFICATION_FAILED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new INVALID_EVM_SIGNATURE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new MEDIA_NOT_FOUND enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new OFFER_ALREADY_CANCELLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new OFFER_INVALID_STATUS enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new OFFER_PARENT_MISMATCH enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new OFFER_PARENT_NOT_ACCEPTING enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new OFFER_UNAUTHORIZED enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new PORTFOLIO_MARGIN_CONFIG_NOT_FOUND enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new SUBKEY_NOT_ACTIVATABLE enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new XP_TRANSFERS_DISABLED enum value to the //// response property for the response status

      response-property-enum-value-added

    • removed the INVALID_JOIN_WAITLIST_REQUEST enum value from the //// response property for the response status

      response-property-enum-value-removed

  • 846a2e2b455b12See the full diff
    • added required request body

      request-body-added-required

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the media type application/json for the response with the status

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog