Conventions And Definitions

Server Time

The server time is in Coordinated Universal Time (UTC).
 

Unique Identifiers

The system constructs unique identifiers according to the Universally Unique Identifier standard.
Example    c18f0c17-9971-40e6-8e5b-10df05d422f0 
 
 

Dates and Times

The API requires dates and time arguments in the ISO8601 datetime format and returns all dates and times in the same format. The syntax of this format is <yyyy>-<mm>-<dd>T<HH>:<MM>:SS>.<sss>Z where <yyyy> is the year, <mm> is the month, <dd> is the day, <HH> is the hour, <MM> is the  minute, <SS> is the second and <sss> is the millisecond. When provided as an argument, <sss> is optional. Z denotes that the datetime is in UTC.
Examples             
  2016-02-26T12:09:38.830Z       
  2016-02-26T12:09:38Z                         
 
 

Symbols

The system identifies cash accounts, margin accounts, futures contracts and indices through ticker symbols. Please refer to the platform documentation for details on the ticker symbol syntax. The following shows some sample ticker symbols. 

Example Symbols

Description

xbt Bitcoin
xrp Ripple XRP
fi_xbtusd
Bitcoin-Dollar Futures Margin Account
ti_xbtusd
Bitcoin-Dollar Turbo Futures Margin Account
fi_xrpusd
Ripple-Dollar Futures Margin Account
fi_xbtusd_180615
Bitcoin-Dollar Futures, maturing at 16:00 UTC on 15 June 2018
ti_xbtusd_180615
Bitcoin-Dollar Turbo, maturing at 16:00 UTC on 15 June 2018
fi_xrpusd_180615
 
Ripple-Dollar Futures, maturing at 16:00 UTC on 15 June 2018
fi_xrpxbt_180615
Ripple-Bitcoin Futures, maturing at 16:00 UTC on 15 June 2018
in_xbtusd
Bitcoin-Dollar Real-Time Index
rr_xbtusd
Bitcoin-Dollar Reference Rate
in_xrpusd
Ripple-Dollar Real-Time Index
 
 

Order of Arguments

When calling endpoints with required arguments, all arguments must be provided in the order they are listed (see section REST API resources).
Example  
 
When calling the tickers endpoint, the structure for rr_xbtusd will not contain the  keys suspended, lastSizevol24h, bid, bidSizeask, askSize and markPrice. This is because rr_xbtusd is an index such that these keys do not apply.
 
{  
   "symbol":"rr_xbtusd",
   "last":4225,
   "lastTime":"2016-02-25T11:05:21.000Z",
   "open24h":4179,
   "high24h":4264,
   "low24h":4177
}