Quick Start
Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!
Get your API keys
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.
You can generate an API key from your Dashboard at any time.
General Api Information
The following base endpoint:
All endpoints return either a JSON object or array.
All time and timestamp related fields are in milliseconds.
HTTP Return Codes
HTTP
4XX
return codes are used for malformed requests; the issue is on the sender's side.HTTP
403
return code is used when the WAF Limit (Web Application Firewall) has been violated.HTTP
5XX
return codes are used for internal errors; the issue is on FIXT's side. It is important to NOT treat this as a failure operation; the execution status is UNKNOWN and could have been a success.
Error Codes and Message
If there is an error, the API will return an error with a message of the reason.
Specific error codes and messages defined in Error Codes.
General Information on Endpoints
For
GET
endpoints, parameters must be sent as aquery string
.For
POST
,PUT
, andDELETE
endpoints, the parameters may be sent as aquery string
or in therequest body
with content typeapplication/x-www-form-urlencoded
. You may mix parameters between both thequery string
andrequest body
if you wish to do so.Parameters may be sent in any order.
If a parameter sent in both the
query string
andrequest body
, thequery string
parameter will be used.
Make your first request
To make your first request, please request the contract endpoint below.
Contracts
GET
https://fapi.api.finextree.com/api/v0/market/contracts
Returns all Contracts information.
Response Body
ticker_id
string
Identifier of a ticker with delimiter to separate base/quote, eg. BTC-USDT
base_currency
string
Symbol/currency code of base pair, eg. BTC
quote_currency
string
Symbol/currency code of quote pair, eg. ETH
last_price
decimal
Last transacted price of base currency based on given quote currency
base_volume
decimal
24 hour trading volume in BASE currency
usd_volume
decimal
24 hour trading volume in USD
quote_volume
decimal
24 hour trading volume in QUOTE currency
bid
decimal
Current highest bid price
ask
decimal
Current lowest ask price
high
decimal
Rolling 24-hour highest transaction price
low
decimal
Rolling 24-hour lowest transaction price
product_type
string
Futures, Perpetual, Options
open_interest
decimal
The number of outstanding derivatives contracts that have not been settled
open_interest_usd
decimal
The sum of the Open Positions (long or short) in USD Value of the contract
index_price
decimal
Last calculated index price for underlying of contract
funding_rate
decimal
Current funding rate
Last updated