Deribit · Schema

Currency With Apr

DerivativesCryptocurrencyBitcoinEthereumOptionsFuturesPerpetualsTradingMarket DataBlock TradingWebSocketFinancial

Properties

Name	Type	Description
withdrawal_fee	number	The total transaction fee paid for withdrawals
withdrawal_priorities	array
min_withdrawal_fee	number	The minimum transaction fee paid for withdrawals
currency	string	The abbreviation of the currency. This abbreviation is used elsewhere in the API to identify the currency.
currency_long	string	The full name for the currency.
min_confirmations	integer	Minimum number of block chain confirmations before deposit is accepted.
coin_type	string	The type of the currency.
in_cross_collateral_pool	boolean	`true` if the currency is part of the cross collateral pool
apr	number	Simple Moving Average (SMA) of the last 7 days of rewards. If fewer than 7 days of reward data are available, the APR is calculated as the average of the available rewards. Only applicable to yield-ge
network_fee	number	The network fee
network_currency	string	The currency of the network
decimals	integer	The number of decimal places for the currency

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/deribit/json-schema/currency_with_apr.json",
  "title": "Currency With Apr",
  "properties": {
    "withdrawal_fee": {
      "type": "number",
      "example": 0.0001,
      "description": "The total transaction fee paid for withdrawals"
    },
    "withdrawal_priorities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/key_number_pair"
      }
    },
    "min_withdrawal_fee": {
      "type": "number",
      "example": 0.0001,
      "description": "The minimum transaction fee paid for withdrawals"
    },
    "currency": {
      "type": "string",
      "example": "BTC",
      "description": "The abbreviation of the currency. This abbreviation is used elsewhere in the API to identify the currency."
    },
    "currency_long": {
      "type": "string",
      "example": "Bitcoin",
      "description": "The full name for the currency."
    },
    "min_confirmations": {
      "type": "integer",
      "example": 2,
      "description": "Minimum number of block chain confirmations before deposit is accepted."
    },
    "coin_type": {
      "type": "string",
      "enum": [
        "BITCOIN",
        "ETHER"
      ],
      "description": "The type of the currency."
    },
    "in_cross_collateral_pool": {
      "type": "boolean",
      "description": "`true` if the currency is part of the cross collateral pool"
    },
    "apr": {
      "type": "number",
      "description": "Simple Moving Average (SMA) of the last 7 days of rewards. If fewer than 7 days of reward data are available, the APR is calculated as the average of the available rewards. Only applicable to yield-generating tokens (`USDE`, `STETH`, `USDC`, `BUILD`)."
    },
    "network_fee": {
      "type": "number",
      "example": 0.0001,
      "description": "The network fee"
    },
    "network_currency": {
      "type": "string",
      "example": "BTC",
      "description": "The currency of the network"
    },
    "decimals": {
      "type": "integer",
      "example": 6,
      "description": "The number of decimal places for the currency"
    }
  },
  "required": [
    "currency",
    "currency_long",
    "min_confirmations",
    "withdrawal_fee",
    "coin_type",
    "in_cross_collateral_pool"
  ],
  "type": "object"
}