BinanceApi.HTTP (binance_api v0.2.0) View Source

This module constructs a request for binance using authentication information that is set in by the opts param

By default the opts will use the api_key and secret_key set in the config

Options

:secured? - The default value is false.
:secret_key - The default value is "<BINANCE_SECRET_KEY>".
:api_key - The default value is "<BINANCE_API_KEY>".
:base_url - The default value is "https://api.binance.com".
:secure_receive_window - The default value is 5000.
:pool_timeout - The default value is 5000.
:receive_timeout - The default value is 15000.

Link to this section Summary

Types

error()

opts()

res()

res_multi()

res_single()

Functions

build_v1_url(path)

build_v3_url(path)

delete(url, params \\ nil, opts)

get(url, params \\ nil, opts)

opts_definitions()

post(url, body, opts)

Link to this section Types

error()

Specs

error() :: {:error, %{code: atom(), message: String.t()}}

opts()

Specs

opts() :: [
  secured?: boolean(),
  secret_key: String.t(),
  api_key: String.t(),
  base_url: String.t(),
  secure_receive_window: non_neg_integer(),
  pool_timeout: non_neg_integer(),
  receive_timeout: non_neg_integer()
]

res()

Specs

res() :: {:ok, map() | list()} | error()

res_multi()

Specs

res_multi() :: {:ok, list()} | error()

res_single()

Specs

res_single() :: {:ok, map()} | error()

Link to this section Functions

build_v1_url(path)

Specs

build_v1_url(String.t()) :: String.t()

build_v3_url(path)

Specs

build_v3_url(String.t()) :: String.t()

delete(url, params \\ nil, opts)

Specs

delete(String.t(), nil | map(), Keyword.t()) :: res()

get(url, params \\ nil, opts)

Specs

get(String.t(), nil | map(), Keyword.t()) :: res()

opts_definitions()

Specs

opts_definitions() :: Keyword.t()

post(url, body, opts)

Specs

post(String.t(), nil | map(), Keyword.t()) :: res()