# Quick Start

{% hint style="info" %}
**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!
{% endhint %}

## 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:

{% tabs %}
{% tab title="Derivative" %}

```
https://fapi.api.finextree.com
https://fapi.fixt.io
```

{% endtab %}

{% tab title="Spot" %}

```
https://sapi.api.finextree.com
https://sapi.fixt.io
```

{% endtab %}
{% endtabs %}

* All endpoints return either a JSON object or array.
* All time and timestamp related fields are in **milliseconds**.

## HTTP Return Codes

* HTTP <mark style="color:red;">`4XX`</mark> return codes are used for malformed requests; the issue is on the sender's side.
* HTTP <mark style="color:red;">`403`</mark> return code is used when the WAF Limit (Web Application Firewall) has been violated.
* HTTP <mark style="color:red;">`5XX`</mark> 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 <mark style="color:red;">`GET`</mark> endpoints, parameters must be sent as a <mark style="color:red;">`query string`</mark>.
* For <mark style="color:red;">`POST`</mark>, <mark style="color:red;">`PUT`</mark>, and <mark style="color:red;">`DELETE`</mark> endpoints, the parameters may be sent as a <mark style="color:red;">`query string`</mark> or in the <mark style="color:red;">`request body`</mark> with content type <mark style="color:red;">`application/x-www-form-urlencoded`</mark>. You may mix parameters between both the <mark style="color:red;">`query string`</mark> and <mark style="color:red;">`request body`</mark> if you wish to do so.
* Parameters may be sent in any order.
* If a parameter sent in both the <mark style="color:red;">`query string`</mark> and <mark style="color:red;">`request body`</mark>, the <mark style="color:red;">`query string`</mark> parameter will be used.

## Make your first request

To make your first request, please request the contract endpoint below.

## Contracts

<mark style="color:green;">`GET`</mark> <https://fapi.fixt.io/api/v0/market/contracts>

Returns all Contracts information.

#### Response Body

| Name                | Type    | Description                                                                |
| ------------------- | ------- | -------------------------------------------------------------------------- |
| 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                                                       |

{% tabs %}
{% tab title="200" %}

```javascript
{
    "status":"true",
    "msg":"success",
    "result": [
        {
            "ticker_id": "BTC_USDT",
            "base_currency": "BTC",
            "quote_currency": "USDT",
            "last_price": 70000,
            "base_volume": 1,
            "quote_volume": 70000,
            "usd_volume": 70000,
            "bid": 70000,
            "ask": 70000,
            "high": 71000,
            "low": 69000,
            "product_type": "Perpetual",
            "open_interest": 70000,
            "open_interest_usd": 70000,
            "index_price": 70000,
            "funding_rate": 0.000024,
            "newxt_funding_timestap": 1713398400000,
            "maker_fee": 0.0008,
            "taker_fee": 0.001,
        }, ... , ...
    ]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fixt.gitbook.io/apis/quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.