Subaccounts

public/margin_watch

Calculates the mark-to-market value and initial/maintenance margin for a given subaccount, with per-position and per-collateral breakdowns, computed from live feed data at request time. Margins are reported on the margin basis actually in effect: when a delayed-liquidation override is active the response’s is_delayed_liquidation flag is true and the reported margins use the temporarily lowered requirements. A maintenance margin below zero means the subaccount is flagged for liquidation.

POST

public

margin_watch

public/margin_watch

curl --request POST \
  --url https://api.derive.xyz/v3/public/margin_watch \
  --header 'Content-Type: application/json' \
  --data '
{
  "subaccount_id": 1
}
'

import requests

url = "https://api.derive.xyz/v3/public/margin_watch"

payload = { "subaccount_id": 1 }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({subaccount_id: 1})
};

fetch('https://api.derive.xyz/v3/public/margin_watch', 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://api.derive.xyz/v3/public/margin_watch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subaccount_id' => 1
  ]),
  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://api.derive.xyz/v3/public/margin_watch"

	payload := strings.NewReader("{\n  \"subaccount_id\": 1\n}")

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/public/margin_watch")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subaccount_id\": 1\n}"

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

{
  "collaterals": [
    {
      "amount": "<string>",
      "amount_step": "<string>",
      "asset_name": "<string>",
      "asset_type": "<string>",
      "average_price": "<string>",
      "average_price_excl_fees": "<string>",
      "creation_timestamp": 123,
      "cumulative_interest": "<string>",
      "currency": "<string>",
      "delta": "<string>",
      "delta_currency": "<string>",
      "initial_margin": "<string>",
      "maintenance_margin": "<string>",
      "mark_price": "<string>",
      "mark_value": "<string>",
      "open_orders_margin": "<string>",
      "pending_interest": "<string>",
      "realized_pnl": "<string>",
      "realized_pnl_excl_fees": "<string>",
      "total_fees": "<string>",
      "unrealized_pnl": "<string>",
      "unrealized_pnl_excl_fees": "<string>"
    }
  ],
  "currency": [
    "<string>"
  ],
  "initial_margin": "<string>",
  "is_delayed_liquidation": true,
  "maintenance_margin": "<string>",
  "margin_type": "<string>",
  "positions": [
    {
      "amount": "<string>",
      "amount_step": "<string>",
      "average_price": "<string>",
      "average_price_excl_fees": "<string>",
      "creation_timestamp": 123,
      "cumulative_funding": "<string>",
      "delta": "<string>",
      "gamma": "<string>",
      "index_price": "<string>",
      "initial_margin": "<string>",
      "instrument_name": "<string>",
      "instrument_type": "option",
      "maintenance_margin": "<string>",
      "mark_price": "<string>",
      "mark_value": "<string>",
      "net_settlements": "<string>",
      "open_orders_margin": "<string>",
      "pending_funding": "<string>",
      "realized_pnl": "<string>",
      "realized_pnl_excl_fees": "<string>",
      "theta": "<string>",
      "total_fees": "<string>",
      "unrealized_pnl": "<string>",
      "unrealized_pnl_excl_fees": "<string>",
      "vega": "<string>",
      "leverage": "<string>",
      "liquidation_price": "<string>"
    }
  ],
  "risk_universe_id": 1,
  "subaccount_id": 1,
  "subaccount_value": "<string>",
  "valuation_timestamp": 123
}

Body

application/json

subaccount_id

integer<uint64>

required

Required range: x >= 0

Response

Success

Result of public/margin_watch: the margin state a liquidation watcher needs, computed on the margin basis actually in effect (a delayed- liquidation override, when installed, is already applied).

collaterals

object[]

required

Show child attributes

currency

string[]

required

initial_margin

string

required

is_delayed_liquidation

boolean

required

true when a delayed-liquidation margin override is active, i.e. the margins above are computed on the temporarily lowered basis.

maintenance_margin

string

required

Below zero the subaccount is flagged for liquidation.

margin_type

string

required

positions

object[]

required

Show child attributes

risk_universe_id

integer<uint32>

required

Required range: x >= 0

subaccount_id

integer<uint64>

required

Required range: x >= 0

subaccount_value

string

required

valuation_timestamp

integer<int64>

required

Unix seconds at which margin and MtM were computed.

public/margin_watch

curl --request POST \
  --url https://api.derive.xyz/v3/public/margin_watch \
  --header 'Content-Type: application/json' \
  --data '
{
  "subaccount_id": 1
}
'

import requests

url = "https://api.derive.xyz/v3/public/margin_watch"

payload = { "subaccount_id": 1 }
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({subaccount_id: 1})
};

fetch('https://api.derive.xyz/v3/public/margin_watch', 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://api.derive.xyz/v3/public/margin_watch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subaccount_id' => 1
  ]),
  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://api.derive.xyz/v3/public/margin_watch"

	payload := strings.NewReader("{\n  \"subaccount_id\": 1\n}")

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/public/margin_watch")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subaccount_id\": 1\n}"

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

{
  "collaterals": [
    {
      "amount": "<string>",
      "amount_step": "<string>",
      "asset_name": "<string>",
      "asset_type": "<string>",
      "average_price": "<string>",
      "average_price_excl_fees": "<string>",
      "creation_timestamp": 123,
      "cumulative_interest": "<string>",
      "currency": "<string>",
      "delta": "<string>",
      "delta_currency": "<string>",
      "initial_margin": "<string>",
      "maintenance_margin": "<string>",
      "mark_price": "<string>",
      "mark_value": "<string>",
      "open_orders_margin": "<string>",
      "pending_interest": "<string>",
      "realized_pnl": "<string>",
      "realized_pnl_excl_fees": "<string>",
      "total_fees": "<string>",
      "unrealized_pnl": "<string>",
      "unrealized_pnl_excl_fees": "<string>"
    }
  ],
  "currency": [
    "<string>"
  ],
  "initial_margin": "<string>",
  "is_delayed_liquidation": true,
  "maintenance_margin": "<string>",
  "margin_type": "<string>",
  "positions": [
    {
      "amount": "<string>",
      "amount_step": "<string>",
      "average_price": "<string>",
      "average_price_excl_fees": "<string>",
      "creation_timestamp": 123,
      "cumulative_funding": "<string>",
      "delta": "<string>",
      "gamma": "<string>",
      "index_price": "<string>",
      "initial_margin": "<string>",
      "instrument_name": "<string>",
      "instrument_type": "option",
      "maintenance_margin": "<string>",
      "mark_price": "<string>",
      "mark_value": "<string>",
      "net_settlements": "<string>",
      "open_orders_margin": "<string>",
      "pending_funding": "<string>",
      "realized_pnl": "<string>",
      "realized_pnl_excl_fees": "<string>",
      "theta": "<string>",
      "total_fees": "<string>",
      "unrealized_pnl": "<string>",
      "unrealized_pnl_excl_fees": "<string>",
      "vega": "<string>",
      "leverage": "<string>",
      "liquidation_price": "<string>"
    }
  ],
  "risk_universe_id": 1,
  "subaccount_id": 1,
  "subaccount_value": "<string>",
  "valuation_timestamp": 123
}

HTTP & WS Methods

WS-only Methods

WS Subscriptions

public/margin_watch

Body

Response