Deribit · Schema

Get Balance

DerivativesCryptocurrencyBitcoinEthereumOptionsFuturesPerpetualsTradingMarket DataBlock TradingWebSocketFinancial

Properties

Name Type Description
currency object
equity number Equity of the main account
available_withdrawal_funds number Funds available for withdrawal
total_equity number Equity of the main account + subaccounts
custody number Custody balance
pnl number Profit net loss of the user (total_equity - custody)
encrypted number The encrypted result json in base64 format. It can be used to verify that values are generated by Deribit.
View JSON Schema on GitHub

JSON Schema

get_balance.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/deribit/json-schema/get_balance.json",
  "title": "Get Balance",
  "properties": {
    "currency": {
      "$ref": "#/components/schemas/currency"
    },
    "equity": {
      "type": "number",
      "description": "Equity of the main account"
    },
    "available_withdrawal_funds": {
      "type": "number",
      "description": "Funds available for withdrawal"
    },
    "total_equity": {
      "type": "number",
      "description": "Equity of the main account + subaccounts"
    },
    "custody": {
      "type": "number",
      "description": "Custody balance"
    },
    "pnl": {
      "type": "number",
      "description": "Profit net loss of the user (total_equity - custody)"
    },
    "encrypted": {
      "type": "number",
      "description": "The encrypted result json in base64 format. It can be used to verify that values are generated by Deribit."
    }
  },
  "required": [
    "currency",
    "equity",
    "available_withdrawal_funds",
    "total_equity",
    "custody",
    "pnl"
  ],
  "type": "object"
}