private/create_subaccount

Creates a new subaccount under the authenticated main account. Subaccounts allow you to organize trading activities and manage risk separately from the main account.

This method takes no parameters. The new subaccount will be created with default settings and can be configured using other subaccount management methods.

📖 Related Article: Managing Subaccounts

Scope: account:read_write and mainaccount

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/create_subaccount \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 5414,
  "method": "private/create_subaccount",
  "params": {}
}
'

200

{
  "jsonrpc": "2.0",
  "id": 5414,
  "result": {
    "email": "[e-mail]",
    "id": 13,
    "is_password": false,
    "login_enabled": false,
    "portfolio": {
      "eth": {
        "available_funds": 0,
        "available_withdrawal_funds": 0,
        "balance": 0,
        "currency": "eth",
        "equity": 0,
        "initial_margin": 0,
        "maintenance_margin": 0,
        "margin_balance": 0
      },
      "btc": {
        "available_funds": 0,
        "available_withdrawal_funds": 0,
        "balance": 0,
        "currency": "btc",
        "equity": 0,
        "initial_margin": 0,
        "maintenance_margin": 0,
        "margin_balance": 0
      }
    },
    "receive_notifications": false,
    "system_name": "user_1_4",
    "security_keys_enabled": false,
    "type": "subaccount",
    "username": "user_1_4"
  }
}

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. email · string · required

User email

Example:

"[e-mail]"

result. login_enabled · boolean · required

Informs whether login to the subaccount is enabled

result. is_password · boolean · required

true when password for the subaccount has been configured

result. receive_notifications · boolean · required

When true - receive all notification emails on the main email

result. system_name · string · required

System generated user nickname

Example:

"username_1"

result. security_keys_enabled · boolean · required

Whether the Security Keys authentication is enabled

result. security_keys_assignments · string[] · required

Names of assignments with Security Keys assigned

result. username · string · required

Account name (given by user)

result. type · enum<string> · required

Account type

Available options: subaccount

result. id · integer · required

Subaccount identifier

result. margin_model · string · required

Margin model

result. disabled_trading_products · string[] · required

List of disabled trading products

result. proof_id · string · required

hashed identifier used in the Proof Of Liability for the subaccount. This identifier allows you to find your entries in the Deribit Proof-Of-Reserves files. IMPORTANT: Keep it secret to not disclose your entries in the Proof-Of-Reserves.

result. proof_id_signature · string · required

signature used as a base string for proof_id hash. IMPORTANT: Keep it secret to not disclose your entries in the Proof-Of-Reserves.

result. trading_products_details · object[] · required

Details about trading products availability

Hide child attributes

result.trading_products_details. enabled · boolean

result.trading_products_details. product · string

result.trading_products_details. overwriteable · boolean

result.trading_products_details. requires_consent · boolean

result. referrals_count · integer · required

Number of referrals

result. portfolio · object

Portfolio information for the subaccount

Hide child attributes

result.portfolio. btc(example) · object

Hide child attributes

result.portfolio.btc(example). margin_balance · number · required

The account's margin balance. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.

result.portfolio.btc(example). currency · enum<string> · required

The selected currency

Available options: btc, eth

result.portfolio.btc(example). maintenance_margin · number · required

The maintenance margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.

result.portfolio.btc(example). initial_margin · number · required

The account's initial margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.

result.portfolio.btc(example). equity · number · required

The account's current equity

result.portfolio.btc(example). balance · number · required

The account's balance

result.portfolio.btc(example). available_withdrawal_funds · number · required

The account's available to withdrawal funds

result.portfolio.btc(example). available_funds · number · required

The account's available funds. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value to the given currency, using each cross collateral currency's index.

result.portfolio.btc(example). additional_reserve · number · required

The account's balance reserved in other orders

Example:

0.3

result.portfolio.btc(example). spot_reserve · number · required

The account's balance reserved in active spot orders

id · integer

The id that was sent in the request