REST API

Schemas(1.0.0)

TimestampType

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

integer · int64

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp format	Example	Supported request type
whole number (seconds)	`1495127793`	`GET`, `POST`
whole number (milliseconds)	`1495127793000`	`GET`, `POST`

Example: 1495127793000

Nonce

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

integer · int64

Gemini strongly recommends using milliseconds instead of seconds for timestamps.

Timestamp format	Example	Supported request type
whole number (seconds)	`1495127793`	`GET`, `POST`
whole number (milliseconds)	`1495127793000`	`GET`, `POST`

Example: 1495127793000

integer

Example: 1495127793000

ErrorResponse

resultstring
Error
reasonstring
A short description
messagestring
Detailed error message

SymbolDetails

symbolstring
The requested symbol. See symbols and minimums
Example: BTCUSD
base_currencystring
CCY1 or the top currency. (i.e BTC in BTCUSD)
Example: BTC
quote_currencystring
CCY2 or the quote currency. (i.e USD in BTCUSD)
Example: USD
tick_sizenumber · decimal
The number of decimal places in the base_currency. (i.e 1e-8)
Example: 1e-8
quote_incrementnumber · decimal
The number of decimal places in the quote_currency (i.e 0.01)
Example: 0.01
min_order_sizestring
The minimum order size in base_currency units (i.e 0.00001)
Example: 0.00001
statusstring
Status of the current order book. Can be open, closed, cancel_only, post_only, limit_only.
Example: open
wrap_enabledboolean
When True, symbol can be wrapped using this endpoint:
POST https://api.gemini.com/v1/wrap/:symbol
product_typestring
Instrument type spot / swap -- where swap signifies perpetual swap.
Example: spot
contract_typestring
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_currencystring
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

bidnumber · decimal
The highest bid currently available
Example: 977.59
asknumber · decimal
The lowest ask currently available
Example: 977.35
lastnumber · decimal
The price of the last executed trade
Example: 977.65
volumeobject
Information about the 24 hour volume on the exchange. See properties below

OrderBook

bidsobject[]
The bid price levels currently on the book. These are offers to buy at a given price.
asksobject[]
The ask price levels currently on the book. These are offers to sell at a given price.

OrderBookEntry

pricenumber · decimal
The price
amountnumber · decimal
The total quantity remaining at the price
timestamp
timestamp

Trade

timestamp
timestamp
timestampms
timestamp
tidinteger
The trade ID number
Example: 5335307668
pricestring · decimal
The price the trade was executed at
Example: 3610.85
amountstring · decimal
The amount that was traded
Example: 0.27413495
exchangestring
Will always be "gemini"
Example: gemini
typestring · 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
brokenboolean
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

requeststring
The literal string /v1/heartbeat
nonce
The nonce, as described in Private API Invocation

NewOrderRequest

requeststring · required
The literal string "/v1/order/new"
Example: /v1/order/new
noncenumber · required
The nonce, as described in Private API Invocation
symbolstring · required
The symbol for the new order
Example: BTCUSD
amountstring · required
Quoted decimal amount to purchase
Example: 5
pricestring · required
Quoted decimal amount to spend per unit
Example: 3633.00
sidestring · enum · required
Enum values:
buy
sell
Example: buy
typestring · 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_idstring
Recommended. A client-specified order id
optionsstring[]
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_pricestring
The price to trigger a stop-limit order. Only available for stop-limit orders.
accountstring
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

requeststring · required
The literal string "/v1/order/cancel"
Example: /v1/order/cancel
noncerequired
timestamp
order_idinteger · required
The order ID given by /order/new
Example: 106817811

accountstring
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

requeststring · required
The literal string "/v1/order/cancel/all"
Example: /v1/order/cancel/all
noncerequired
timestamp

accountstring
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 orders. Only available for exchange accounts.
Example: primary

CancelAllOrdersBySessionRequest

requeststring · required
The literal string "/v1/order/cancel/session"
Example: /v1/order/cancel/session
noncerequired
timestamp

accountstring
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 orders. Only available for exchange accounts.
Example: primary

OrderStatusRequest

requeststring · required
The API endpoint path
Example: /v1/order/status
noncerequired
timestamp
order_idinteger · 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

accountstring
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.
Example: primary
client_order_idstring
The client_order_id used when placing the order. client_order_id cannot be used in combination with order_id
include_tradesboolean
Either True or False. If True the endpoint will return individual trade details of all fills from the order.

MyTradesRequest

requeststring · required
The API endpoint path
Example: /v1/mytrades
noncerequired
timestamp

accountstring
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.
Example: primary
symbolstring
The symbol to retrieve trades for
Example: btcusd
limit_tradesinteger
The maximum number of trades to return. Default is 50, max is 500.
Example: 50
timestamp
timestamp

LimitOrderResponse

order_idstring
idstring
symbolstring
exchangestring
avg_execution_pricestring
sidestring · enum
Enum values:
buy
sell
typestring · enum
Enum values:
exchange limit
exchange stop limit
exchange market
timestamp
timestamp
timestampms
timestamp
is_liveboolean
is_cancelledboolean
is_hiddenboolean
was_forcedboolean
executed_amountstring
remaining_amountstring · double
client_order_idstring
optionsstring[]
pricestring · double
original_amountstring · double

StopLimitOrderResponse

order_idstring
idstring
symbolstring
exchangestring
avg_execution_pricestring
sidestring · enum
Enum values:
buy
sell
typestring · enum
Enum values:
exchange stop limit
timestamp
timestamp
timestampms
timestamp
is_liveboolean
is_cancelledboolean
is_hiddenboolean
was_forcedboolean
executed_amountstring
optionsstring[]
stop_pricestring · double
pricestring · double
original_amountstring · double

CancelOrderResponse

order_idstring · integer
idstring · integer
symbolstring
exchangestring
avg_execution_pricestring · double
sidestring · enum
Enum values:
buy
sell
typestring · enum
Enum values:
exchange limit
exchange stop limit
exchange market
timestamp
timestamp
timestampms
timestamp
is_liveboolean
is_cancelledboolean
is_hiddenboolean
was_forcedboolean
executed_amountstring · double
remaining_amountstring · double
reasonstring · enum
Enum values:
MakerOrCancelWouldTake
ExceedsPriceLimits
SelfCrossPrevented
ImmediateOrCancelWouldPost
FillOrKillWouldNotFill
Requested
MarketClosed
TradingClosed
optionsstring[]
pricestring · double
original_amountstring · double

Order

order_idstring · integer
The order id
client_order_idstring · integer
An optional client-specified order id
symbolstring
The symbol of the order
exchangestring
Will always be "gemini"
pricestring · decimal
The price the order was issued at
avg_execution_pricestring · decimal
The average price at which this order as been executed so far. 0 if the order has not been executed at all.
sidestring · enum
Enum values:
buy
sell
typestring · enum
Description of the order
Enum values:
exchange limit
exchange stop limit
exchange market
optionsstring[]
An array containing at most one supported order execution option. See Order execution options for details.
timestamp
timestamp
timestampms
timestamp
is_liveboolean
true if the order is active on the book (has remaining quantity and has not been canceled)
is_cancelledboolean
true if the order has been canceled. Note the spelling, "cancelled" instead of "canceled". This is for compatibility reasons.
reasonstring
Populated with the reason your order was canceled, if available.
was_forcedboolean
Will always be false.
executed_amountstring · decimal
The amount of the order that has been filled.
remaining_amountstring · decimal
The amount of the order that has not been filled.
original_amountstring · decimal
The originally submitted amount of the order.
is_hiddenboolean
Will always return false.
tradesobject[]
Contains an array of JSON objects with trade details.

CancelAllResult

resultstring
Example: ok
detailsobject
cancelledOrders/cancelRejects with IDs of both

MyTrade

pricestring
Example: 9100
amountstring
Example: 1.5
timestamp
timestamp
timestampms
timestamp
typestring · enum
Enum values:
Buy
Sell
Example: Buy
aggressorboolean
Example:
fee_currencystring
Example: USD
fee_amountstring
Example: 13.65
tidinteger
Example: 123456789
order_idstring
Example: 123456789
client_order_idstring
exchangestring
Example: gemini
is_auction_fillboolean
breakstring · enum
Enum values:
trade correct

TradeVolume

symbolstring
Example: btcusd
base_currencystring
Example: BTC
quote_currencystring
Example: USD
notional_currencystring
Example: USD
data_datestring
Example: 2020-06-02
total_volume_basestring
Example: 10.5
maker_buy_sell_ratiostring
Example: 1.2
buy_maker_basestring
Example: 5.5
buy_maker_notionalstring
Example: 50050
buy_maker_countinteger
Example: 10
sell_maker_basestring
Example: 5
sell_maker_notionalstring
Example: 45500
sell_maker_countinteger
Example: 8
buy_taker_basestring
Example: 8.5
buy_taker_notionalstring
Example: 77350
buy_taker_countinteger
Example: 15
sell_taker_basestring
Example: 7.5
sell_taker_notionalstring
Example: 68250
sell_taker_countinteger
Example: 12

Balance

typestring · enum
Enum values:
exchange
Example: exchange
currencystring
The currency symbol
Example: BTC
amountnumber
The amount available
Example: 10.5
availablenumber
The amount available for trading
Example: 9.5
availableForWithdrawalnumber
The amount available for withdrawal
Example: 9.5

NotionalVolume

datestring · date
Example: 2020-06-02
last_updated_msinteger
Example: 1591084414622
web_maker_fee_bpsinteger
Example: 25
web_taker_fee_bpsinteger
Example: 35
web_auction_fee_bpsinteger
Example: 25
api_maker_fee_bpsinteger
Example: 10
api_taker_fee_bpsinteger
Example: 35
api_auction_fee_bpsinteger
Example: 20
fix_maker_fee_bpsinteger
Example: 10
fix_taker_fee_bpsinteger
Example: 35
fix_auction_fee_bpsinteger
Example: 20
notional_30d_volumestring
Example: 1000000
notional_1d_volumeobject[]
api_notional_30d_volumestring
Example: 750000
fee_tierobject

NotionalBalance

currencystring
Currency code, see symbols and minimums
amountstring
The current balance
amountNotionalstring
Amount, in notional
availablestring
The amount that is available to trade
availableNotionalstring
Available, in notional
availableForWithdrawalstring
The amount that is available to withdraw
availableForWithdrawalNotionalstring
AvailableForWithdrawal, in notional

Address

addressstring
String representation of the cryptocurrency address
timestamp
timestamp
labelstring
If you provided a label when creating the address, it will be echoed back here
memostring
It would be present if applicable, it will be present for cosmos address
networkstring
The blockchain network for the address

Transfer

typestring · enum
Enum values:
Deposit
Withdrawal
statusstring · enum
Enum values:
Complete
Pending
timestampms
timestamp
eidinteger
The transfer ID
currencystring
The currency transferred
amountstring
The amount transferred
txHashstring
The transaction hash if applicable

InstantQuote

quoteIdinteger
Unique ID for the quote. This is used in the execution of the order
maxAgeMsinteger
Number of milliseconds until this quote price expires. Once expired, you will need to request a new quote
pairstring
The symbol passed in the quote request
pricestring
The quoted price of the asset. This will not change when attempting execution
priceCurrencystring
The currency in which the order is priced. Matches CCY2 in the symbol
sidestring · enum
Either "buy" or "sell"
Enum values:
buy
sell
quantitystring
The quantity of the asset to be bought or sold
quantityCurrencystring
The currency label for the quantity field. Matches CCY1 in the symbol
feestring
The fee quantity to be taken for the order upon execution
feeCurrencystring
The currency label for the order
depositFeestring
The deposit fee quantity. Will be applied if a debit card is used for the order. Will return 0 if there is no depositFee
depositFeeCurrencystring
Currency in which depositFee is taken
totalSpendstring
Total quantity to spend for the order. Will be the sum inclusive of all fees and amount to be traded.
totalSpendCurrencystring
Currency of the totalSpend to be spent on the order

ClearingOrder

clearing_idstring
The clearing ID
symbolstring
The trading pair
pricestring
The order price
amountstring
The order amount
sidestring · enum
Enum values:
buy
sell
statusstring
The order status
timestamp
timestamp
timestampmsinteger
The timestamp in milliseconds
is_confirmedboolean
Whether the order is confirmed

Account

namestring
The account name
account_idstring
The account ID
is_defaultboolean
Whether the account is the default account
createdstring
The creation date

Transaction

accountstring
The account.
amountstring
The quantity that was executed.
pricestring
The price that the execution happened at.
timestampms
timestamp
sidestring
Indicating the side of the original order.
isAggressorboolean
If true, this order was the taker in the trade.
feeAssetCodestring
The symbol that the trade was for
feeAmountstring
The fee amount charged
orderIdinteger · int64
The order that this trade executed against.
exchangestring
Will always be "Gemini Trust Co".
isAuctionFillboolean
True if the trade was a auction trade and not an on-exchange trade.
isClearingFillboolean
True if the trade was a clearing trade and not an on-exchange trade.
symbolstring
The symbol that the trade was for.

timestampms
timestamp
sourcestring
The account you are transferring from.
destinationstring
The account you are transferring to.
operationReasonstring
The operation reason.
statusstring
The status of the transfer.
eidinteger · int64
Transfer event id.
currencystring
Currency code, see symbols
amountstring
The quantity that was transferred.
methodstring
Type of transfer method.
correlationIdinteger · int64
Correlation ID.
transferTypestring
Transfer type.
bankIdstring
Bank ID.
purposestring
Purpose.
transactionHashstring
Supplies the transaction hash when available.
transferIdstring
Transfer ID.
withdrawalIdstring
Withdrawal ID.
clientTransferIdstring
Client Transfer ID. Client transfer ID is an optional client-supplied unique identifier for each withdrawal or internal transfer.
advanceEidinteger · int64
Deposit advance event ID.
pendingEidinteger · int64
Pending event ID.
withdrawalEidinteger · int64
Withdrawal event ID.
feeIdstring
Fee ID.

RevokeOauthTokenResponse

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

NetworkToken

tokenstring
The requested token.
networkstring[]
Network of the requested token.

FeePromos

symbolsstring[]
Symbols that currently have fee promos

PriceFeedResponse

pairstring
Trading pair symbol. See symbols and minimums
pricestring
Current price of the pair on the Gemini order book
percentChange24hstring
24 hour change in price of the pair on the Gemini order book

ApprovedAddress

networkstring
The network of the approved address. Network can be bitcoin, ethereum, bitcoincash, litecoin, zcash, filecoin, dogecoin, tezos, solana, polkadot, avalanche, cosmos, or xrpl
scopestring
Will return the scope of the address as either "account" or "group"
labelstring
The label assigned to the address
statusstring
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.
createdAtstring
UTC timestamp in millisecond of when the address was created.
addressstring
The address on the approved address list.

OpenPosition

symbolstring
The symbol of the order.
instrument_typestring
The type of instrument. Either "spot" or "perp".
quantitystring · decimal
The position size. Value will be negative for shorts.
notional_valuestring · decimal
The value of position; calculated as (quantity * mark_price). Value will be negative for shorts.
realised_pnlstring · decimal
The current P&L that has been realised from the position.
unrealised_pnlstring · decimal
Current Mark to Market value of the positions.
average_coststring · decimal
The average price of the current position.
mark_pricestring · decimal
The current Mark Price for the Asset or the position.

FundingAmountResponse

symbolstring
The requested symbol. See symbols and minimums
fundingDateTimestring
UTC date time in format yyyy-MM-ddThh:mm:ss.SSSZ format
fundingTimestampMilliSecsnumber · long
Current funding amount Epoc time.
nextFundingTimestampnumber · long
Next funding amount Epoc time.
amountnumber · decimal
The dollar amount for a Long 1 position held in the symbol for funding period (1 hour)
estimatedFundingAmountnumber · decimal
The estimated dollar amount for a Long 1 position held in the symbol for next funding period (1 hour)

StakingBalance

typestring
Will always be "Staking"
Example: Staking
currencystring
Currency code, see symbols and minimums
Example: MATIC
balancenumber · decimal
The current Staking balance
Example: 10
availablenumber · decimal
The amount that is available to trade
availableForWithdrawalnumber · decimal
The Staking amount that is available to redeem to exchange account
Example: 10
balanceByProviderobject

StakingDeposit

transactionIdstring
A unique identifier for the staking transaction
Example: 65QN4XM5
providerIdstring
Provider Id, in uuid4 format
Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d
currencystring
Currency code, see symbols
Example: MATIC
amountnumber · decimal
The amount deposited
Example: 30
accrualTotalnumber · decimal
The total accrual
ratesobject
A JSON object including one or many rates. If more than one rate it would be an array of rates.

StakingTransaction

transactionIdstring
A unique identifier for the staking transaction
Example: MPZ7LDD8
transactionTypestring · 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
amountCurrencystring
Currency code
Example: MATIC
amountnumber · decimal
The amount that is defined by the transactionType above
Example: 20
priceCurrencystring
A supported three-letter fiat currency code, e.g. usd
Example: USD
priceAmountnumber · decimal
Current market price of the underlying token at the time of the reward
Example: 0.1
dateTime
timestamp

StakingHistory

providerIdstring
Provider Id, in uuid4 format
Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d
transactionsobject[]

StakingRate

providerIdstring
Provider Id, in uuid4 format
Example: 62bb4d27-a9c8-4493-a737-d4fa33994f1f
rateinteger
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
apyPctnumber · decimal
Staking interest APY (Expressed as a percentage derived from the rate and rounded to 1/10th of a percent.)
Example: 4.39
ratePctnumber · decimal
rate expressed as a percentage
Example: 4.29386
depositUsdLimitinteger
Maximum new amount in USD notional of this crypto that can participate in Gemini Staking per account per month
Example: 500000

StakingRateProvider

currency_symbolobject

StakingRateResponse

provider_uuidobject
Currency Symbol Keys

StakingRewardPeriod

providerIdstring
Provider Id, in uuid4 format
Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d
currencystring
Currency code, see symbols
Example: MATIC
apyPctnumber · 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
ratePctnumber · decimal
Rate expressed as a percentage
Example: 5.592369
numberOfAccrualsinteger
Number of accruals in the specific aggregate, typically one per day. If the rate is adjusted, new accruals are added.
Example: 1
accrualTotalnumber · decimal
The total accrual
Example: 0.0065678
firstAccrualAtstring
Time of first accrual. In iso datetime with timezone format
Example: 2022-08-23T20:00:00.000Z
lastAccrualAtstring
Time of last accrual. In iso datetime with timezone format
Example: 2022-08-23T20:00:00.000Z

StakingRewards

providerIdstring
Provider Id, in uuid4 format
Example: 62b21e17-2534-4b9f-afcf-b7edb609dd8d
currencystring
Currency code, see symbols
Example: MATIC
accrualTotalnumber · decimal
The total accrual
Example: 0.103994
ratePeriodsobject[]
Array of JSON objects with period accrual information

StakingRewardsProvider

currency_symbolobject

StakingRewardsResponse

provider_uuidobject
Currency Symbol Keys

StakingWithdrawal

transactionIdstring
A unique identifier for the staking transaction
Example: MPZ7LDD8
amountnumber · decimal
The amount deposited
Example: 20
amountPaidSoFarnumber · decimal
The amount redeemed successfully
Example: 20
amountRemainingnumber · decimal
The amount pending to be redeemed
currencystring
Currency code
Example: MATIC
requestInitiatedstring
In ISO datetime with timezone format
Example: 2022-11-02T19:49:20.153Z

FeeEstimateRequest

requeststring · 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
noncerequired
The nonce, as described in Private API Invocation
addressstring · required
Standard string format of cryptocurrency address
Example: 0x31c2105b8dea834167f32f7ea7d877812e059230
amountstring · required
Quoted decimal amount to withdraw
Example: 0.01
accountstring · required
The name of the account within the subaccount group.
Example: primary

FeeEstimateResponse

currencystring
Currency code, see symbols.
Example: ETH
feestring
The estimated gas fee
Example: {currency: 'ETH', value: '0'}
isOverrideboolean
Value that shows if an override on the customer's account for free withdrawals exists
monthlyLimitinteger
Total nunber of allowable fee-free withdrawals
Example: 1
monthlyRemaininginteger
Total number of allowable fee-free withdrawals left to use
Example: 1

RoleResponse

isAuditorboolean · required
True if the Auditor role is assigned to the API keys. False otherwise.
isFundManagerboolean · required
True if the Fund Manager role is assigned to the API keys. False otherwise.
isTraderboolean · required
True if the Trader role is assigned to the API keys. False otherwise.

counterparty_idstring
Only returned for master-level API keys. The Gemini clearing counterparty ID associated with the API key making the request.
isAccountAdminboolean
Only returned for master-level API keys.True if the Administrator role is assigned to the API keys. False otherwise.

MarginResponse

margin_assets_valuestring · decimal
The $ equivalent value of all the assets available in the current trading account that can contribute to funding a derivatives position.
initial_marginstring · decimal
The $ amount that is being required by the accounts current positions and open orders.
available_marginstring · decimal
The difference between the margin_assets_value and initial_margin.
margin_maintenance_limitstring · decimal
The minimum amount of margin_assets_value required before the account is moved to liquidation status.
leveragestring · decimal
The ratio of Notional Value to Margin Assets Value.
notional_valuestring · decimal
The $ value of the current position.
estimated_liquidation_pricestring · decimal
The estimated price for the asset at which liquidation would occur.
initial_margin_positionsstring · decimal
The contribution to initial_margin from open positions.
reserved_marginstring · decimal
The contribution to initial_margin from open orders.
reserved_margin_buysstring · decimal
The contribution to initial_margin from open BUY orders.
reserved_margin_sellsstring · decimal
The contribution to initial_margin from open SELL orders.
buying_powerstring · decimal
The amount of that product the account could purchase based on current initial_margin and margin_assets_value.
selling_powerstring · decimal
The amount of that product the account could sell based on current initial_margin and margin_assets_value.

Quantity

currencystring · required
The currency code of the quantity.
valuestring · decimal · required
The value of the quantity.

FundingTransfer

eventTypestring · required
Event type
timestamprequired
Time of the funding payment
assetCodestring · required
Asset symbol
actionstring · enum · required
Credit or Debit
Enum values:
Credit
Debit
quantityrequired
A nested JSON object describing the transaction amount

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

FundingPayment

eventTypestring · enum · required
Event type
Enum values:
Hourly Funding Transfer
hourlyFundingTransferobject · required

FundingPaymentReportItem

eventTypestring · enum · required
Event type
Enum values:
Hourly Funding Transfer
timestamprequired
Time of the funding payment
assetCodestring · required
Asset symbol
actionstring · enum · required
Credit or Debit
Enum values:
Credit
Debit
quantityrequired
A nested JSON object describing the transaction amount

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

RiskStatsResponse

product_typestring · enum
Contract type for which the symbol data is fetched
Enum values:
PerpetualSwapContract
mark_pricestring · decimal
Current mark price at the time of request
index_pricestring · decimal
Current index price at the time of request
open_intereststring · decimal
string representation of decimal value of open interest
open_interest_notionalstring · decimal
string representation of decimal value of open interest notional

FxRate

fxPairstring
The requested currency pair
Example: AUDUSD
ratenumber · double
The exchange rate
Example: 0.69
asOf
timestamp
providerstring
The market data provider
Example: bcb
benchmarkstring
The market for which the retrieved price applies to
Example: Spot

Candle

integer · int64

Timestamp in milliseconds

number · double

Price or volume data

CandleResponse

Candlearray
Example: [[1559755800000,7781.6,7820.23,7776.56,7819.39,34.7624802159],[1559755800000,7781.6,7829.46,7776.56,7817.28,43.4228281059]]

TickerInfo

symbolstring
The trading pair symbol
Example: BTCUSD
openstring · decimal
Open price from 24 hours ago
Example: 9121.76
highstring · decimal
High price from 24 hours ago
Example: 9440.66
lowstring · decimal
Low price from 24 hours ago
Example: 9106.51
closestring · decimal
Close price (most recent trade)
Example: 9347.66
changesstring[]
Hourly prices descending for past 24 hours
Example: ["9365.1","9386.16","9373.41","9322.56","9268.89","9265.38"]
bidstring · decimal
Current best bid
Example: 9345.70
askstring · decimal
Current best offer
Example: 9347.67

​Schemas(1.0.0)

​TimestampType

​Nonce

​ErrorResponse

​SymbolDetails

​Ticker

​OrderBook

​OrderBookEntry

​Trade

​Heartbeat

​NewOrderRequest

​CancelOrderRequest

​CancelAllOrdersRequest

​CancelAllOrdersBySessionRequest

​OrderStatusRequest

​MyTradesRequest

​LimitOrderResponse

​StopLimitOrderResponse

​CancelOrderResponse

​Order

​CancelAllResult

​MyTrade

​TradeVolume

​Balance

​NotionalVolume

​NotionalBalance

​Address

​Transfer

​InstantQuote

​ClearingOrder

​Account

​Transaction

​RevokeOauthTokenResponse

​NetworkToken

​FeePromos

​PriceFeedResponse

​ApprovedAddress

​OpenPosition

​FundingAmountResponse

​StakingBalance

​StakingDeposit

​StakingTransaction

​StakingHistory

​StakingRate

​StakingRateProvider

​StakingRateResponse

​StakingRewardPeriod

​StakingRewards

​StakingRewardsProvider

​StakingRewardsResponse

​StakingWithdrawal

​FeeEstimateRequest

​FeeEstimateResponse

​RoleResponse

​MarginResponse

​Quantity

​FundingTransfer

​FundingPayment

​FundingPaymentReportItem

​RiskStatsResponse

​FxRate

​Candle

​CandleResponse

​TickerInfo

Schemas(1.0.0)

TimestampType

Nonce

ErrorResponse

SymbolDetails

Ticker

OrderBook

OrderBookEntry

Trade

Heartbeat

NewOrderRequest

CancelOrderRequest

CancelAllOrdersRequest

CancelAllOrdersBySessionRequest

OrderStatusRequest

MyTradesRequest

LimitOrderResponse

StopLimitOrderResponse

CancelOrderResponse

Order

CancelAllResult

MyTrade

TradeVolume

Balance

NotionalVolume

NotionalBalance

Address

Transfer

InstantQuote

ClearingOrder

Account

Transaction

RevokeOauthTokenResponse

NetworkToken

FeePromos

PriceFeedResponse

ApprovedAddress

OpenPosition

FundingAmountResponse

StakingBalance

StakingDeposit

StakingTransaction

StakingHistory

StakingRate

StakingRateProvider

StakingRateResponse

StakingRewardPeriod

StakingRewards

StakingRewardsProvider

StakingRewardsResponse

StakingWithdrawal

FeeEstimateRequest

FeeEstimateResponse

RoleResponse

MarginResponse

Quantity

FundingTransfer

FundingPayment

FundingPaymentReportItem

RiskStatsResponse

FxRate

Candle

CandleResponse

TickerInfo