REST API

Schemas(1.0.0)

TimestampType

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = integer

Properties for Variant 1:

string

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp format	Example	Supported request type
string (seconds)	`1495127793`	`POST` only
string (milliseconds)	`1495127793000`	`POST` only

Example: 1495127793000

Nonce

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = TimestampType
	type = integer

Properties for Variant 1:

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = integer

Properties for Variant 1:

string

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp format	Example	Supported request type
string (seconds)	`1495127793`	`POST` only
string (milliseconds)	`1495127793000`	`POST` only

Example: 1495127793000

ErrorResponse

result

string

Error

reason

string

A short description

message

string

Detailed error message

SymbolDetails

symbol

string

The requested symbol. See symbols and minimums

Example: BTCUSD

base_currency

string

CCY1 or the top currency. (i.e BTC in BTCUSD)

Example: BTC

quote_currency

string

CCY2 or the quote currency. (i.e USD in BTCUSD)

Example: USD

tick_size

number · decimal

The number of decimal places in the base_currency. (i.e 1e-8)

Example: 1e-8

quote_increment

number · decimal

The number of decimal places in the quote_currency (i.e 0.01)

Example: 0.01

min_order_size

string

The minimum order size in base_currency units (i.e 0.00001)

Example: 0.00001

status

string

Status of the current order book. Can be open, closed, cancel_only, post_only, limit_only.

Example: open

wrap_enabled

boolean

When True, symbol can be wrapped using this endpoint:
POST https://api.gemini.com/v1/wrap/:symbol

Example: false

product_type

string

Instrument type spot / swap -- where swap signifies perpetual swap.

Example: spot

contract_type

string

vanilla / linear / inverse where vanilla is for spot while linear is for perpetual swap and inverse is a special case perpetual swap where the perpetual contract will be settled in base currency.

Example: vanilla

contract_price_currency

string

CCY2 or the quote currency for spot instrument (i.e. USD in BTCUSD) Or collateral currency of the contract in case of perpetual swap instrument.

Example: USD

Ticker

bid

number · decimal

The highest bid currently available

Example: 977.59

ask

number · decimal

The lowest ask currently available

Example: 977.35

last

number · decimal

The price of the last executed trade

Example: 977.65

object

Information about the 24 hour volume on the exchange. See properties below

OrderBook

object[]

The bid price levels currently on the book. These are offers to buy at a given price.

object[]

The ask price levels currently on the book. These are offers to sell at a given price.

OrderBookEntry

price

number · decimal

The price

amount

number · decimal

The total quantity remaining at the price

DO NOT USE - this field is included for compatibility reasons only and is just populated with a dummy value.

Trade

The time that the trade was executed

Example: 1547146811

The time that the trade was executed in milliseconds

Example: 1547146811357

tid

integer

The trade ID number

Example: 5335307668

price

string · decimal

The price the trade was executed at

Example: 3610.85

amount

string · decimal

The amount that was traded

Example: 0.27413495

exchange

string

Will always be "gemini"

Example: gemini

type

string · enum

buy means that an ask was removed from the book by an incoming buy order.
sell means that a bid was removed from the book by an incoming sell order.

Enum values:

buy

sell

Example: buy

broken

boolean

Whether the trade was broken or not. Broken trades will not be displayed by default; use the include_breaks to display them.

Example: false

Heartbeat

request

string

The literal string /v1/heartbeat

The nonce, as described in Private API Invocation

NewOrderRequest

request

string · required

The literal string "/v1/order/new"

Example: /v1/order/new

nonce

number · required

The nonce, as described in Private API Invocation

symbol

string · required

The symbol for the new order

Example: BTCUSD

amount

string · required

Quoted decimal amount to purchase

Example: 5

price

string · required

Quoted decimal amount to spend per unit

Example: 3633.00

side

string · enum · required

Enum values:

buy

sell

Example: buy

type

string · enum · required

The order type. "exchange limit" for all order types except for stop-limit orders. "exchange stop limit" for stop-limit orders.

Enum values:

exchange limit

exchange stop limit

exchange market

Example: exchange limit

client_order_id

string

Recommended. A client-specified order id

options

string[]

An optional array containing at most one supported order execution option. See Order execution options for details.

Enum values:

maker-or-cancel

immediate-or-cancel

fill-or-kill

Example: ["maker-or-cancel"]

stop_price

string

The price to trigger a stop-limit order. Only available for stop-limit orders.

margin_order

boolean

Set to true to place this order on a margin account using borrowed funds. Defaults to false. Only available for margin-enabled accounts. See Margin Trading for details.

Example: false

account

string

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to place the order. Only available for exchange accounts.

CancelOrderRequest

request

string · required

The literal string "/v1/order/cancel"

Example: /v1/order/cancel

TimestampType · required

timestamp

order_id

integer · required

The order ID given by /order/new

Example: 106817811

account

string

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Specifies the account on which you intend to cancel the order. Only available for exchange accounts.

Example: primary

CancelAllOrdersRequest

request

string · required

The literal string "/v1/order/cancel/all"

Example: /v1/order/cancel/all

TimestampType · required

timestamp

account

string

Example: primary

CancelAllOrdersBySessionRequest

request

string · required

The literal string "/v1/order/cancel/session"

Example: /v1/order/cancel/session

TimestampType · required

timestamp

account

string

Example: primary

OrderStatusRequest

request

string · required

The API endpoint path

Example: /v1/order/status

TimestampType · required

timestamp

order_id

integer · required

The order id to get information on. The order_id represents a whole number and is transmitted as an unsigned 64-bit integer in JSON format. order_id cannot be used in combination with client_order_id.

Example: 123456789012345

account

string

Example: primary

client_order_id

string

The client_order_id used when placing the order. client_order_id cannot be used in combination with order_id

include_trades

boolean

Either True or False. If True the endpoint will return individual trade details of all fills from the order.

MyTradesRequest

request

string · required

The API endpoint path

Example: /v1/mytrades

TimestampType · required

timestamp

account

string

Example: primary

symbol

string

The symbol to retrieve trades for

Example: btcusd

limit_trades

integer

The maximum number of trades to return. Default is 50, max is 500.

Example: 50

Only return trades on or after this timestamp. See Data Types: Timestamps for more information. If not present, will show the most recent orders.

Example: 1591084414000

LimitOrderResponse

order_id

string

id

string

symbol

string

exchange

string

avg_execution_price

string

side

string · enum

Enum values:

buy

sell

type

string · enum

Enum values:

exchange limit

exchange stop limit

exchange market

TimestampType

timestamp

TimestampType

timestamp

is_live

boolean

is_cancelled

boolean

is_hidden

boolean

was_forced

boolean

executed_amount

string

remaining_amount

string · double

client_order_id

string

options

string[]

price

string · double

original_amount

string · double

StopLimitOrderResponse

order_id

string

id

string

symbol

string

exchange

string

avg_execution_price

string

side

string · enum

Enum values:

buy

sell

type

string · enum

Enum values:

exchange stop limit

timestamp

is_live

boolean

is_cancelled

boolean

is_hidden

boolean

was_forced

boolean

executed_amount

string

options

string[]

stop_price

string · double

price

string · double

original_amount

string · double

CancelOrderResponse

order_id

string · integer

id

string · integer

symbol

string

exchange

string

avg_execution_price

string · double

side

string · enum

Enum values:

buy

sell

type

string · enum

Enum values:

exchange limit

exchange stop limit

exchange market

timestamp

is_live

boolean

is_cancelled

boolean

is_hidden

boolean

was_forced

boolean

executed_amount

string · double

remaining_amount

string · double

reason

string · enum

Enum values:

MakerOrCancelWouldTake

ExceedsPriceLimits

SelfCrossPrevented

ImmediateOrCancelWouldPost

FillOrKillWouldNotFill

Requested

MarketClosed

TradingClosed

options

string[]

price

string · double

original_amount

string · double

Order

order_id

string · integer

The order id

client_order_id

string · integer

An optional client-specified order id

symbol

string

The symbol of the order

exchange

string

Will always be "gemini"

price

string · decimal

The price the order was issued at

avg_execution_price

string · decimal

The average price at which this order as been executed so far. 0 if the order has not been executed at all.

side

string · enum

Enum values:

buy

sell

type

string · enum

Description of the order

Enum values:

exchange limit

exchange stop limit

exchange market

options

string[]

An array containing at most one supported order execution option. See Order execution options for details.

The timestamp the order was submitted. Note that for compatibility reasons, this is returned as a string. We recommend using the timestampms field instead.

The timestamp the order was submitted in milliseconds.

is_live

boolean

true if the order is active on the book (has remaining quantity and has not been canceled)

is_cancelled

boolean

true if the order has been canceled. Note the spelling, "cancelled" instead of "canceled". This is for compatibility reasons.

reason

string

Populated with the reason your order was canceled, if available.

was_forced

boolean

Will always be false.

executed_amount

string · decimal

The amount of the order that has been filled.

remaining_amount

string · decimal

The amount of the order that has not been filled.

original_amount

string · decimal

The originally submitted amount of the order.

is_hidden

boolean

Will always return false.

object[]

Contains an array of JSON objects with trade details.

CancelAllResult

result

string

object

cancelledOrders/cancelRejects with IDs of both

MyTrade

price

string

amount

string

timestamp

Example: 1591084414

timestamp

Example: 1591084414622

type

string · enum

Enum values:

Buy

Sell

Example: Buy

aggressor

boolean

fee_currency

string

fee_amount

string

tid

integer

order_id

string

client_order_id

string

exchange

string

is_auction_fill

boolean

break

string · enum

Enum values:

trade correct

Example:

TradeVolume

symbol

string

base_currency

string

quote_currency

string

notional_currency

string

data_date

string

total_volume_base

string

maker_buy_sell_ratio

string

buy_maker_base

string

buy_maker_notional

string

buy_maker_count

integer

sell_maker_base

string

sell_maker_notional

string

sell_maker_count

integer

buy_taker_base

string

buy_taker_notional

string

buy_taker_count

integer

sell_taker_base

string

sell_taker_notional

string

sell_taker_count

integer

Balance

type

string · enum

Enum values:

exchange

Example: exchange

currency

string

The currency symbol

Example: BTC

amount

number

The amount available

Example: 10.5

available

number

The amount available for trading

Example: 9

availableForWithdrawal

number

The amount available for withdrawal

Example: 9

pendingWithdrawal

number

The amount pending withdrawal

Example: 1

pendingDeposit

number

The amount pending deposit

Example: 0.5

NotionalVolume

date

string · date

last_updated_ms

integer

web_maker_fee_bps

integer

web_taker_fee_bps

integer

web_auction_fee_bps

integer

api_maker_fee_bps

integer

api_taker_fee_bps

integer

api_auction_fee_bps

integer

fix_maker_fee_bps

integer

fix_taker_fee_bps

integer

fix_auction_fee_bps

integer

notional_30d_volume

string

object[]

api_notional_30d_volume

string

object

NotionalBalance

currency

string

Currency code, see symbols and minimums

amount

string

The current balance

amountNotional

string

Amount, in notional

available

string

The amount that is available to trade

availableNotional

string

Available, in notional

availableForWithdrawal

string

The amount that is available to withdraw

availableForWithdrawalNotional

string

AvailableForWithdrawal, in notional

Address

address

string

String representation of the cryptocurrency address

Creation date of the address

label

string

If you provided a label when creating the address, it will be echoed back here

memo

string

It would be present if applicable, it will be present for cosmos address

network

string

The blockchain network for the address

Transfer

type

string · enum

Enum values:

Deposit

Withdrawal

status

string · enum

Enum values:

Complete

Pending

The timestamp in milliseconds

eid

integer

The transfer ID

currency

string

The currency transferred

amount

string

The amount transferred

txHash

string

The transaction hash if applicable

InstantQuote

quoteId

integer

Unique ID for the quote. This is used in the execution of the order

maxAgeMs

integer

Number of milliseconds until this quote price expires. Once expired, you will need to request a new quote

pair

string

The symbol passed in the quote request

price

string

The quoted price of the asset. This will not change when attempting execution

priceCurrency

string

The currency in which the order is priced. Matches CCY2 in the symbol

side

string · enum

Either "buy" or "sell"

Enum values:

buy

sell

quantity

string

The quantity of the asset to be bought or sold

quantityCurrency

string

The currency label for the quantity field. Matches CCY1 in the symbol

fee

string

The fee quantity to be taken for the order upon execution

feeCurrency

string

The currency label for the order

depositFee

string

The deposit fee quantity. Will be applied if a debit card is used for the order. Will return 0 if there is no depositFee

depositFeeCurrency

string

Currency in which depositFee is taken

totalSpend

string

Total quantity to spend for the order. Will be the sum inclusive of all fees and amount to be traded.

totalSpendCurrency

string

Currency of the totalSpend to be spent on the order

ClearingOrder

clearing_id

string

The clearing ID

symbol

string

The trading pair

price

string

The order price

amount

string

The order amount

side

string · enum

Enum values:

buy

sell

status

string

The order status

The timestamp

timestampms

integer

The timestamp in milliseconds

is_confirmed

boolean

Whether the order is confirmed

Account

name

string

The account name

account_id

string

The account ID

is_default

boolean

Whether the account is the default account

created

string

The creation date

Transaction

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Trade Reponse:

Trade Reponse

account

string

The account.

amount

string

The quantity that was executed.

clientOrderId

string

The client order ID, if defined. Otherwise an empty string.

price

string

The price that the execution happened at.

The time that the trade happened in milliseconds.

side

string

Indicating the side of the original order.

isAggressor

boolean

If true, this order was the taker in the trade.

feeAssetCode

string

The symbol that the trade was for

feeAmount

string

The fee amount charged

orderId

integer · int64

The order that this trade executed against.

exchange

string

Will always be "gemini".

isAuctionFill

boolean

True if the trade was a auction trade and not an on-exchange trade.

isClearingFill

boolean

True if the trade was a clearing trade and not an on-exchange trade.

tid

integer · int64

The trade ID.

symbol

string

The symbol that the trade was for.

RevokeOauthTokenResponse

message

string

A message that indicates the token has been revoked for the account

NetworkToken

token

string

The requested token.

network

string[]

Network of the requested token.

FeePromos

symbols

string[]

Symbols that currently have fee promos

PriceFeedResponse

object[]

pair

string

Trading pair symbol. See symbols and minimums

price

string

Current price of the pair on the Gemini order book

percentChange24h

string

24 hour change in price of the pair on the Gemini order book

ApprovedAddress

network

string

The network of the approved address. Network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin, dogecoin, tezos, solana, polkadot, avalanche, cosmos, or xrpl

scope

string

Will return the scope of the address as either "account" or "group"

label

string

The label assigned to the address

status

string

The status of the address that will return as "active", "pending-time" or "pending-mua". The remaining time is exactly 7 days after the initial request. "pending-mua" is for multi-user accounts and will require another administator or fund manager on the account to approve the address.

createdAt

string

UTC timestamp in millisecond of when the address was created.

address

string

The address on the approved address list.

OpenPosition

symbol

string

The symbol of the order.

instrument_type

string

The type of instrument. Either "spot" or "perp".

quantity

string · decimal

The position size. Value will be negative for shorts.

notional_value

string · decimal

The value of position; calculated as (quantity * mark_price). Value will be negative for shorts.

realised_pnl

string · decimal

The current P&L that has been realised from the position.

unrealised_pnl

string · decimal

Current Mark to Market value of the positions.

average_cost

string · decimal

The average price of the current position.

mark_price

string · decimal

The current Mark Price for the Asset or the position.

FundingAmountResponse

symbol

string

The requested symbol. See symbols and minimums

fundingDateTime

string

UTC date time in format yyyy-MM-ddThh:mm:ss.SSSZ format

fundingTimestampMilliSecs

number · long

Current funding amount Epoc time.

nextFundingTimestamp

number · long

Next funding amount Epoc time.

amount

number · decimal

The dollar amount for a Long 1 position held in the symbol for funding period (1 hour)

estimatedFundingAmount

number · decimal

The estimated dollar amount for a Long 1 position held in the symbol for next funding period (1 hour)

StakingBalance

type

string

Will always be "Staking"

Example: Staking

currency

string

Currency code, see symbols and minimums

Example: MATIC

balance

number · decimal

The current Staking balance

Example: 10

available

number · decimal

The amount that is available to trade

Example: 0

availableForWithdrawal

number · decimal

The Staking amount that is available to redeem to exchange account

Example: 10

object

StakingDeposit

transactionId

string

A unique identifier for the staking transaction

Example: 65QN4XM5

providerId

string

Provider Id, in uuid4 format

Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d

currency

string

Currency code, see symbols

Example: MATIC

amount

number · decimal

The amount deposited

Example: 30

accrualTotal

number · decimal

The total accrual

object

A JSON object including one or many rates. If more than one rate it would be an array of rates.

StakingTransaction

transactionId

string

A unique identifier for the staking transaction

Example: MPZ7LDD8

transactionType

string · enum

Can be any one of the following - Deposit, Redeem, Interest, RedeemPayment, AdminRedeem, AdminCreditAdjustment, AdminDebitAdjustment

Enum values:

Deposit

Redeem

Interest

RedeemPayment

AdminRedeem

AdminCreditAdjustment

AdminDebitAdjustment

Example: Redeem

amountCurrency

string

Currency code

Example: MATIC

amount

number · decimal

The amount that is defined by the transactionType above

Example: 20

priceCurrency

string

A supported three-letter fiat currency code, e.g. usd

Example: USD

priceAmount

number · decimal

Current market price of the underlying token at the time of the reward

Example: 0.1

The time of the transaction in milliseconds

Example: 1667418560153

StakingHistory

providerId

string

Provider Id, in uuid4 format

Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d

object[]

StakingRate

providerId

string

Provider Id, in uuid4 format

Example: 62bb4d27-a9c8-4493-a737-d4fa33994f1f

rate

integer

Staking interest rate in bps (Expressed as a simple rate. Interest on Staking balances compounds daily. In mobile and web applications, APYs are derived from this rate and rounded to 1/10th of a percent.)

Example: 429.386

apyPct

number · decimal

Staking interest APY (Expressed as a percentage derived from the rate and rounded to 1/10th of a percent.)

Example: 4.39

ratePct

number · decimal

rate expressed as a percentage

Example: 4.29386

depositUsdLimit

integer

Maximum new amount in USD notional of this crypto that can participate in Gemini Staking per account per month

Example: 500000

StakingRateProvider

Currency Symbol Keys

object

StakingRateResponse

Provider UUID Keys

object

Currency Symbol Keys

StakingRewardPeriod

providerId

string

Provider Id, in uuid4 format

Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d

currency

string

Currency code, see symbols

Example: MATIC

apyPct

number · decimal

Staking reward rate expressed as an APY at time of accrual. Interest on Staking balances compounds daily based on the simple rate which is available from /v1/staking/rates/

Example: 5.75

ratePct

number · decimal

Rate expressed as a percentage

Example: 5.592369

numberOfAccruals

integer

Number of accruals in the specific aggregate, typically one per day. If the rate is adjusted, new accruals are added.

Example: 1

accrualTotal

number · decimal

The total accrual

Example: 0.0065678

firstAccrualAt

string

Time of first accrual. In iso datetime with timezone format

Example: 2022-08-23T20:00:00.000Z

lastAccrualAt

string

Time of last accrual. In iso datetime with timezone format

Example: 2022-08-23T20:00:00.000Z

StakingRewards

providerId

string

Provider Id, in uuid4 format

Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d

currency

string

Currency code, see symbols

Example: MATIC

accrualTotal

number · decimal

The total accrual

Example: 0.103994

object[]

Array of JSON objects with period accrual information

StakingRewardsProvider

Currency Symbol Keys

object

StakingRewardsResponse

Provider UUID Keys

object

Currency Symbol Keys

StakingWithdrawal

transactionId

string

A unique identifier for the staking transaction

Example: MPZ7LDD8

amount

number · decimal

The amount deposited

Example: 20

amountPaidSoFar

number · decimal

The amount redeemed successfully

Example: 20

amountRemaining

number · decimal

The amount pending to be redeemed

Example: 0

currency

string

Currency code

Example: MATIC

requestInitiated

string

In ISO datetime with timezone format

Example: 2022-11-02T19:49:20.153Z

FeeEstimateRequest

request

string · required

The string /v1/withdraw/{currencyCodeLowerCase}/feeEstimate where :currencyCodeLowerCase is replaced with the currency code of a supported crypto-currency, e.g. eth, aave, etc. See Symbols and minimums

Example: /v1/withdraw/eth/feeEstimate

required

The nonce, as described in Private API Invocation

address

string · required

Standard string format of cryptocurrency address

Example: 0x31c2105b8dea834167f32f7ea7d877812e059230

amount

string · required

Quoted decimal amount to withdraw

Example: 0.01

account

string · required

The name of the account within the subaccount group.

Example: primary

FeeEstimateResponse

currency

string

Currency code, see symbols.

Example: ETH

fee

string

The estimated gas fee

Example: {currency: 'ETH', value: '0'}

isOverride

boolean

Value that shows if an override on the customer's account for free withdrawals exists

Example: false

monthlyLimit

integer

Total nunber of allowable fee-free withdrawals

Example: 1

monthlyRemaining

integer

Total number of allowable fee-free withdrawals left to use

Example: 1

RoleResponse

isAuditor

boolean · required

True if the Auditor role is assigned to the API keys. False otherwise.

isFundManager

boolean · required

True if the Fund Manager role is assigned to the API keys. False otherwise.

isTrader

boolean · required

True if the Trader role is assigned to the API keys. False otherwise.

counterparty_id

string

Only returned for master-level API keys. The Gemini clearing counterparty ID associated with the API key making the request.

isAccountAdmin

boolean

Only returned for master-level API keys.True if the Administrator role is assigned to the API keys. False otherwise.

MarginResponse

margin_assets_value

string · decimal

The $ equivalent value of all the assets available in the current trading account that can contribute to funding a derivatives position.

initial_margin

string · decimal

The $ amount that is being required by the accounts current positions and open orders.

available_margin

string · decimal

The difference between the margin_assets_value and initial_margin.

margin_maintenance_limit

string · decimal

The minimum amount of margin_assets_value required before the account is moved to liquidation status.

leverage

string · decimal

The ratio of Notional Value to Margin Assets Value.

notional_value

string · decimal

The $ value of the current position.

estimated_liquidation_price

string · decimal

The estimated price for the asset at which liquidation would occur.

initial_margin_positions

string · decimal

The contribution to initial_margin from open positions.

reserved_margin

string · decimal

The contribution to initial_margin from open orders.

reserved_margin_buys

string · decimal

The contribution to initial_margin from open BUY orders.

reserved_margin_sells

string · decimal

The contribution to initial_margin from open SELL orders.

buying_power

string · decimal

The amount of that product the account could purchase based on current initial_margin and margin_assets_value.

selling_power

string · decimal

The amount of that product the account could sell based on current initial_margin and margin_assets_value.

MoneyAmount

currency

string · required

The currency code (e.g., "USD", "BTC", "ETH")

Example: USD

value

string · decimal · required

The amount in the specified currency

Example: 10000.00

LiquidationRisk

lossPercentage

string · decimal · required

The percentage loss from current value that would trigger liquidation, formatted as decimal (e.g., "0.1550" = 15.50%)

Example: 0.1550

object

The estimated price at which liquidation would occur (optional, may not be present for all positions)

InterestRateInfo

rate

string · decimal · required

The interest rate as a decimal string

Example: 0.00001141552511

interval

string · enum · required

The time interval for the rate (currently only "hour" is supported)

Enum values:

hour

Example: hour

MarginAccountSummary

object · required

The total value of all assets available in the margin account that can contribute to funding positions

object · required

The amount of collateral available for new positions or withdrawals

object · required

The total value of all open positions

object · required

The total amount currently borrowed across all currencies

leverage

string · decimal · required

The current leverage ratio (notionalValue / marginAssetValue)

Example: 1.5

object · required

The maximum value that can be purchased with available collateral

object · required

The maximum value that can be sold with available collateral

object · required

Collateral reserved for open buy orders

object · required

Collateral reserved for open sell orders

object

Liquidation risk information (only present if positions exist)

object

Current interest rate on borrowed amounts (only present if borrows exist)

MarginInterestRate

currency

string · required

The currency code (e.g., "BTC", "ETH", "USD")

Example: BTC

borrowRate

string · decimal · required

The hourly borrow rate as a decimal

Example: 0.00001141552511

borrowRateDaily

string · decimal · required

The daily borrow rate (hourly rate × 24)

Example: 0.00027397260264

borrowRateAnnual

string · decimal · required

The annualized borrow rate (daily rate × 365)

Example: 0.1

lastUpdated

integer · int64 · required

Unix timestamp in milliseconds when the rate was last updated

Example: 1700000000000

MarginRatesResponse

object[] · required

Array of interest rates for all borrowable currencies

MarginRiskStats

object · required

The total value of all assets available in the margin account

object · required

The amount of collateral available for new positions

object · required

The total value of all open positions

object · required

The total amount currently borrowed

leverage

string · decimal · required

The leverage ratio

Example: 1.5

object · required

Collateral reserved for open buy orders

object · required

Collateral reserved for open sell orders

object · required

The maximum value that can be purchased

object · required

The maximum value that can be sold

object

Liquidation risk information (only present if applicable)

MarginOrderPreview

object · required

Margin risk statistics before the order would be executed

object · required

Margin risk statistics after the order would be executed

Quantity

currency

string · required

The currency code of the quantity.

value

string · decimal · required

The value of the quantity.

FundingTransfer

eventType

string · required

Event type

required

Time of the funding payment

assetCode

string · required

Asset symbol

action

string · enum · required

Credit or Debit

Enum values:

Credit

Debit

object · required

A nested JSON object describing the transaction amount

instrumentSymbol

string

Symbol of the underlying instrument. Note that this is only attached to requests from 16th April 2024 onwards.

FundingPayment

eventType

string · enum · required

Event type

Enum values:

Hourly Funding Transfer

object · required

FundingPaymentReportItem

eventType

string · enum · required

Event type

Enum values:

Hourly Funding Transfer

required

Time of the funding payment

assetCode

string · required

Asset symbol

action

string · enum · required

Credit or Debit

Enum values:

Credit

Debit

object · required

A nested JSON object describing the transaction amount

instrumentSymbol

string

Symbol of the underlying instrument. Note that this is only attached to requests from 16th April 2024 onwards.

RiskStatsResponse

product_type

string · enum

Contract type for which the symbol data is fetched

Enum values:

PerpetualSwapContract

mark_price

string · decimal

Current mark price at the time of request

index_price

string · decimal

Current index price at the time of request

open_interest

string · decimal

string representation of decimal value of open interest

open_interest_notional

string · decimal

string representation of decimal value of open interest notional

FxRate

fxPair

string

The requested currency pair

Example: AUDUSD

rate

number · double

The exchange rate

Example: 0.69

The timestamp (in Epoch time format) that the requested fxrate has been retrieved for

Example: 1594651859000

provider

string

The market data provider

Example: bcb

benchmark

string

The market for which the retrieved price applies to

Example: Spot

Candle

array

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = integer
	type = number

Properties for Variant 1:

integer · int64

Timestamp in milliseconds

CandleResponse

array

TickerInfo

symbol

string

The trading pair symbol

Example: BTCUSD

open

string · decimal

Open price from 24 hours ago

Example: 9121.76

high

string · decimal

High price from 24 hours ago

Example: 9440.66

low

string · decimal

Low price from 24 hours ago

Example: 9106.51

close

string · decimal

Close price (most recent trade)

Example: 9347.66

changes

string[]

Hourly prices descending for past 24 hours

Example: ["9365.1","9386.16","9373.41","9322.56","9268.89","9265.38"]

bid

string · decimal

Current best bid

Example: 9345.70

ask

string · decimal

Current best offer

Example: 9347.67