Api/OrderBookApi

Order Book API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->orderBook();

// TestNet API Call
$sdk->testnet()->api()->orderBook();

Methods

Method	Description
chartRequest()	Obtain chart data from historical closed trades
createFutureTrade()	Store buy / sell trade
createTrade()	Store buy / sell trade
deleteAccountTrades()	Cancel all existing trades for account
deleteTrade()	Cancel existing trade
getBuyTradesBody()	List all active buy trades
getHistoricalTradesBody()	List all historical trades
getMatchedTrades()	List all matched orders from FUTURE_SELL/FUTURE_BUY trades
getSellTradesBody()	List all active sell trades
getTradeById()	Get existing trade

`chartRequest()`

Example

#️⃣ Execute command in terminal

✨ php -f chartRequest.php

Request

POST /v3/trade/chart

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->chartRequest(
    \Tatum\Model\ChartRequest $chart_request
): \Tatum\Model\Chart[]

Parameters

Name	Type	Description	Notes
$chart_request	\Tatum\Model\ChartRequest

Return type

\Tatum\Model\Chart[]

Description

Obtain chart data from historical closed trades

2 credits for API call.

Obtain data from the closed trades for entering in the chart. Time interval is set between from and to and there is defined time frame. There can be obtained at most 200 time points in the time interval.

`createFutureTrade()`

Example

#️⃣ Execute command in terminal

✨ php -f createFutureTrade.php

Request

POST /v3/trade

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->createFutureTrade(
    \Tatum\Model\CreateFutureTrade $create_future_trade
): \Tatum\Model\Id

Parameters

Name	Type	Description	Notes
$create_future_trade	\Tatum\Model\CreateFutureTrade

Return type

\Tatum\Model\Id

Description

Store buy / sell trade

`createTrade()`

Example

#️⃣ Execute command in terminal

✨ php -f createTrade.php

Request

POST /v3/trade

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->createTrade(
    \Tatum\Model\CreateTrade $create_trade
): \Tatum\Model\Id

Parameters

Name	Type	Description	Notes
$create_trade	\Tatum\Model\CreateTrade

Return type

\Tatum\Model\Id

Description

Store buy / sell trade

2 credits for API call, 2 credits for each fill of the counter trade. 1 API call + 2 fills = 6 credits.

Store new buy / sell trade. If there is trade already available to fill, fill as much trades as possible. It is possible to charge fees for the trades. Fees are an extra amount on top of the trade amount and are paid in the currency that you going to block e.g.: - BUY BTC/USDT - fees will be paid in USDT - SELL BTC/ETH - fees will be paid in BTC

If you fill type of the trade with FUTURE_BUY or FUTURE_SELL the trade will behave as a trade future. The trade is concluded now but will be fulfilled in future. The date of fulfillment is by the “Seal Date” field. You can also block a percentage of the amount until the future trade has expired.

Futures can also penalize contracting parties if they don’t have the agreed balance available in their accounts. The penalty is calculated in the following way: Penalty amount = (Percentage of incomplete deal amount because of shortage from user) × (Maximum Penalty percentage of futures deal based on blocked amount and time interval) × (total blocked value).

Example of the BTC/USDT trade future:

The maker creates a sell with the following properties: 1 BTC at a price of 60000 USDT, with a blocking percentage of 22%, a penalty percentage of 45%, a system commision of 1% and with an expiration time of within 12 hours.

` { “type”: “FUTURE_SELL”, “price”: “60000”, “amount”: “1”, “pair”: “BTC/USDT”, “currency1AccountId”: “60a236db1b57f60d62612bf3”, “currency2AccountId”: “609d0696bf835c241ac2920f”, “fee”: 1, “feeAccountId”: “609d0696bf835c251ac2920a”, “attr”: { “sealDate”: 1621990960631, “percentBlock”: 22, “percentPenalty”: 45 } } ` The taker accepts the offer with a buy and blocks 13200 USDT (60000 USDT × 0.22) in their account. ` { “type”: “FUTURE_BUY”, “price”: “60000”, “amount”: “1”, “pair”: “BTC/USDT”, “currency1AccountId”: “60a236db1b57f60d62612bf2”, “currency2AccountId”: “609d0696bf835c241ac2920a”, “attr”: { “sealDate”: 1621990960631, “percentBlock”: 22, “percentPenalty”: 45 } } `

At the time of the trade, the maker and taker have the following conditions. The maker has 0.65 BTC (35% deficit) in their account and the taker has 49200 USDT (18% deficit) in their account.

The maker penalty is equal to 0.35 × 0.22 × (0.45 × 1 BTC) = 0.03465 BTC. The taker penalty is equal to 0.18 × 0.22 × (0.45 × 60000 USDT) = 1069.2 USDT.

The system commission for the maker is 1 BTC × 1% = 0.01 BTC. The system commission for the taker is 60000 USDT × 1% = 600 USDT.

The maker’s assets after deducting penalties and commissions equals 0.65 - 0.03465 - 0.01 = 0.60535 BTC. The taker’s assets after deducting penalties and commissions equals 49200 - 1069.2 - 600 = 47530.8 USDT.

The amount received by the maker after the trade is (0.60535 × 60000) + 1069.2 = 37390.2 USDT and the taker receives 0.60535 + 0.03465 = 0.64 BTC.

`deleteAccountTrades()`

Example

#️⃣ Execute command in terminal

✨ php -f deleteAccountTrades.php

Request

DELETE /v3/trade/account/{id}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->deleteAccountTrades(
    string $id
)

Parameters

Name	Type	Description	Notes
$id	string	Account ID

Return type

void (empty response body)

Description

Cancel all existing trades for account

1 credit for API call, 1 credit for each cancelled trade. 1 API call + 2 cancellations = 3 credits.

Cancel all trades for account.

`deleteTrade()`

Example

#️⃣ Execute command in terminal

✨ php -f deleteTrade.php

Request

DELETE /v3/trade/{id}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->deleteTrade(
    string $id
)

Parameters

Name	Type	Description	Notes
$id	string	Trade ID

Return type

void (empty response body)

Description

Cancel existing trade

1 credit for API call

Cancel existing trade.

`getBuyTradesBody()`

Example

#️⃣ Execute command in terminal

✨ php -f getBuyTradesBody.php

Request

POST /v3/trade/buy

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->getBuyTradesBody(
    \Tatum\Model\ListOderBookActiveBuyBody $list_oder_book_active_buy_body
): \Tatum\Model\Trade[]

Parameters

Name	Type	Description	Notes
$list_oder_book_active_buy_body	\Tatum\Model\ListOderBookActiveBuyBody

Return type

\Tatum\Model\Trade[]

Description

List all active buy trades

1 credit per API call.

List all active buy trades.

`getHistoricalTradesBody()`

Example

#️⃣ Execute command in terminal

✨ php -f getHistoricalTradesBody.php

Request

POST /v3/trade/history

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->getHistoricalTradesBody(
    [ \Tatum\Model\ListOderBookHistoryBody $list_oder_book_history_body ]
): \Tatum\Model\Trade[]

Parameters

Name	Type	Description	Notes
$list_oder_book_history_body	\Tatum\Model\ListOderBookHistoryBody		[optional]

Return type

\Tatum\Model\Trade[]

Description

List all historical trades

1 credit per API call.

List all historical trades. It is possible to list all trades, trades for specific trading pair and/or account.

`getMatchedTrades()`

Example

#️⃣ Execute command in terminal

✨ php -f getMatchedTrades.php

Request

POST /v3/trade/matched

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->getMatchedTrades(
    \Tatum\Model\ListOderBookMatchedBody $list_oder_book_matched_body
): \Tatum\Model\Trade[]

Parameters

Name	Type	Description	Notes
$list_oder_book_matched_body	\Tatum\Model\ListOderBookMatchedBody

Return type

\Tatum\Model\Trade[]

Description

List all matched orders from FUTURE_SELL/FUTURE_BUY trades

1 credit per API call.

List all matched orders from the FUTURE_BUY OR FUTURE_SELL orders.

`getSellTradesBody()`

Example

#️⃣ Execute command in terminal

✨ php -f getSellTradesBody.php

Request

POST /v3/trade/sell

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->getSellTradesBody(
    \Tatum\Model\ListOderBookActiveSellBody $list_oder_book_active_sell_body
): \Tatum\Model\Trade[]

Parameters

Name	Type	Description	Notes
$list_oder_book_active_sell_body	\Tatum\Model\ListOderBookActiveSellBody

Return type

\Tatum\Model\Trade[]

Description

List all active sell trades

1 credit per API call.

List all active sell trades.

`getTradeById()`

Example

#️⃣ Execute command in terminal

✨ php -f getTradeById.php

Request

GET /v3/trade/{id}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->orderBook()->getTradeById(
    string $id
): \Tatum\Model\Trade

Parameters

Name	Type	Description	Notes
$id	string	Trade ID

Return type

\Tatum\Model\Trade

Description

Get existing trade

1 credit for API call

Get existing opened trade.