Kollider Docs (1.0.0)

Download OpenAPI specification:Download

Introduction

This is the official Kollider Api documentation. For code examples please head on over to our Github

Base Rest API Url: https://api.kollider.xyz/v1/
Base WS API Url: wss://api.kollider.xyz/v1/ws/

Authentication

You can authenticate using HMAC symmetric key signing. Every request you make to the api needs to contain the following header parameters.

Header Name Header Value
K-API-KEY Your API key
K-SIGNATURE HMAC Signature
K-TIMESTAMP Timestamp
K-PASSPHRASE Your Passphrase

Rate Limiting

We're currenlty limit the number of request a client can make to 20 requests/second.

Settlement

Kollider's technology allows users to choose between two different settlement types, namely Instant and Delayed. These parameters are passed into every Order or order manipulation action (Move or Cancel). Traders that select the Instant settlement type don't have to deposit funds prior to submitting an order. Instead when they submit an order, they will be prompted to pay a BTC Lighting invoice of exactly the margin requirement. When the payment is detected by the Kollider settlement engine, the order will be unlocked and it will be live in the order book. Conversely, when an order submitted by the trader decreases the size of a position and Instant settlement type is selected the trader will be prompted to generate a BTC Lightning invoice of the amount owed to them by the trading engine.

The Delayed settlement type behaves similar to traditional venues where settlements can be deffered to a later date. This type is recommended for HFT traders.

Products

Currently available products.

Get all tradable products

Responses

Request samples

curl https://api.kollider.xyz/v1/market/products

Response samples

Content type
application/json
{
  • "BTCUSD.PERP": {
    },
  • "LTCUSD.PERP": {
    }
}

Market

Market Data

Gets order book data.

query Parameters
level
integer

There are three levels of orderbook data.

symbol
string

The product symbol.

Responses

Request samples

curl https://api.kollider.xyz/v1/market/orderbook?symbol=BTCUSD.PERP&level=Level2&depth=9

Response samples

Content type
application/json
{
  • "level": 1,
  • "bids": [
    ],
  • "asks": [
    ]
}

Get price ticker for product.

The current trade price of a product.

query Parameters
symbol
string

The product symbol.

Responses

Request samples

curl https://api.kollider.xyz/v1/market/ticker?symbol=BTCUSD.PERP

Response samples

Content type
application/json
{
  • "best_bid": "12958.4",
  • "best_ask": "12972.2",
  • "mid": "12965.3",
  • "last_quantity": 1,
  • "last_price": 12958.4,
  • "last_side": "Ask",
  • "symbol": "BTCUSD.PERP"
}

Get hisotrical index prices.

For complete list of all indicies available, either check our website or query the products endpoint.

query Parameters
limit
integer

Max number of values to be returned.

symbol
string

The index symbol.

start
string

UNIX time since Epoch

end
string

UNIX time since Epoch

interval_size
string

5m, 15m, 1h, 1d

Responses

Request samples

curl https://api.kollider.xyz/v1/market/index_prices?symbol=.BTCUSD&offset_start='1h'

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Account

Access to user data.

Make a deposit.

Request Body schema: application/json

Make a BTC or LN deposit into your cash account.

type
string
amount
integer

Responses

Request samples

Content type
application/json
Example
{
  • "type": "Ln",
  • "amount": 1000
}

Response samples

Content type
application/json
Example
{
  • "payment_request": "lntb1u1pwz5w78pp5e8w8cr5c30xzws92v36sk45znhjn098rtc4pea6ertnmvu25ng3sdpywd6hyetyvf5hgueqv3jk6meqd9h8vmmfvdjsxqrrssy29mzkzjfq27u67evzu893heqex737dhcapvcuantkztg6pnk77nrm72y7z0rs47wzc09vcnugk2ve6sr2ewvcrtqnh3yttv847qqvqpvv398"
}

Make a withdrawal.

Request Body schema: application/json

Withdrawing funds from your exchange wallet into a wallet that is controlled by you.

One of
type
string
payment_request