HomeDocumentationAPI Reference
Log In
API Reference

Create Subaccount

Method Name

private/create_subaccount

Create a new subaccount under a given wallet, and deposit an asset into that subaccount.

See public/create_subaccount_debug for debugging invalid signature issues or go to guides in Documentation.
Required minimum session key permission level is admin

Parameters

amountstringrequired
Amount of the asset to deposit
asset_namestringrequired
Name of asset to deposit
margin_typestringrequired
PM (Portfolio Margin), PM2 (Portfolio Margin 2), orSM` (Standard Margin))
enum PMSMPM2
nonceintegerrequired
Unique nonce defined as (UTC_timestamp in ms)(random_number_up_to_6_digits) (e.g. 1695836058725001, where 001 is the random number)
signaturestringrequired
Ethereum signature of the deposit
signature_expiry_secintegerrequired
Unix timestamp in seconds. Expiry MUST be >5min from now
signerstringrequired
Ethereum wallet address that is signing the deposit
walletstringrequired
Ethereum wallet address
currencystring
Base currency of the subaccount (only for PM)

Response

idstring or integerrequired
resultobjectrequired
result.statusstringrequired
requested
result.transaction_idstringrequired
Transaction id of the request

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}