HitBTC REST API

v0.1.1

HitBTC REST API v0.1.1 Hitbtc.TradingHistory View Source

Set of Trading history methods

This set of methods requires auth information. You could configure it into config.exs file of your application

Link to this section Summary

Functions

order(params \\ [])

List of all orders older then 24 hours without trades are deleted

order_trades(orderId)

List of trades by order OrderId have to be provided

trades(params \\ [])

Trades history

Link to this section Functions

Link to this function order(params \\ []) View Source 
order([tuple()]) :: {:ok, [map()]} | {:error, term()}

List of all orders older then 24 hours without trades are deleted.

Parameters:

  • symbol - String Optional parameter to filter active orders by symbol
  • clientOrderId - String If set, other parameters will be ignored. Without limit and pagination
  • from - DateTime
  • till - DateTime
  • limit - Number Default set to 100
  • offset - Number

## Example:

iex(1)> Hitbtc.TradingHistory.order
{:ok, []}

Or you could provide different parameters:

iex(1)> Hitbtc.TradingHistory.order([symbol: "ETHBTC"])
{:ok, []}
Link to this function order_trades(orderId) View Source 
order_trades(String.t()) :: {:ok, [map()]} | {:error, term()}

List of trades by order OrderId have to be provided

Example: 

iex(1)> Hitbtc.TradingHistory.order_trades("816088021")
{:ok, []}
Link to this function trades(params \\ []) View Source 
trades([tuple()]) :: {:ok, [map()]} | {:error, term()}

Trades history

Prameters:

  • symbol - String Optional parameter to filter active orders by symbol
  • sort - String DESC or ASC. Default value DESC
  • by - String timestamp by default, or id
  • from - DateTime
  • till - DateTime
  • limit - Number Default to 100
  • offset - Number

Example: 

iex(1)> Hitbtc.TradingHistory.trades
{:ok, []}
iex(2)> Hitbtc.TradingHistory.trades([symbol: "ETHBTC"])
{:ok, []}