private/remove_subaccount

Permanently removes a subaccount. The subaccount must be empty (no positions, no open orders, and zero balance) before it can be removed.

This operation cannot be undone. All subaccount data will be permanently deleted.

TFA required

📖 Related Article: Managing Subaccounts

Scope: account:read_write

Try in API console

cURL

cURL

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

import requests

url = "https://test.deribit.com/api/v2/private/remove_subaccount"

payload = {
    "jsonrpc": "2.0",
    "id": 6,
    "method": "private/remove_subaccount",
    "params": { "subaccount_id": 120 }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 6,
    method: 'private/remove_subaccount',
    params: {subaccount_id: 120}
  })
};

fetch('https://test.deribit.com/api/v2/private/remove_subaccount', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/remove_subaccount",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 6,
    'method' => 'private/remove_subaccount',
    'params' => [
        'subaccount_id' => 120
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/remove_subaccount"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 6,\n  \"method\": \"private/remove_subaccount\",\n  \"params\": {\n    \"subaccount_id\": 120\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/remove_subaccount")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 6,\n  \"method\": \"private/remove_subaccount\",\n  \"params\": {\n    \"subaccount_id\": 120\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/remove_subaccount")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 6,\n  \"method\": \"private/remove_subaccount\",\n  \"params\": {\n    \"subaccount_id\": 120\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "jsonrpc": "2.0",
  "id": 1569,
  "result": "ok"
}

Query Parameters

subaccount_id · integer · required

The user id for the subaccount

Example:

120

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · enum<string> · required

Result of method execution. ok in case of success

Available options: ok

id · integer

The id that was sent in the request