binance_api v0.2.15

BinanceApi.HTTP (binance_api v0.2.15) 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

  • :secret_key - Required.

  • :api_key - Required.

  • :secured? - The default value is false.

  • :base_futures_url - The default value is "https://fapi.binance.com".

  • :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_futures_url(path)
build_v1_url(path)
build_v3_url(path)
delete(url, params \\ nil, opts)
futures_delete(url, params \\ nil, opts)
futures_get(url, params \\ nil, opts)
futures_post(url, body, opts)
get(url, params \\ nil, opts)
opts_definitions()
post(url, body, opts)

Link to this section Types

Link to this type

error()

View Source

Specs

error() :: {:error, %{code: atom(), message: String.t()}}
Link to this type

opts()

View Source

Specs

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

res()

View Source

Specs

res() :: {:ok, map() | list()} | error()
Link to this type

res_multi()

View Source

Specs

res_multi() :: {:ok, list()} | error()
Link to this type

res_single()

View Source

Specs

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

Link to this section Functions

Link to this function

build_futures_url(path)

View Source

Specs

build_futures_url(String.t()) :: String.t()
Link to this function

build_v1_url(path)

View Source

Specs

build_v1_url(String.t()) :: String.t()
Link to this function

build_v3_url(path)

View Source

Specs

build_v3_url(String.t()) :: String.t()
Link to this function

delete(url, params \\ nil, opts)

View Source

Specs

delete(String.t(), nil | map(), Keyword.t()) :: res()
Link to this function

futures_delete(url, params \\ nil, opts)

View Source

Specs

futures_delete(String.t(), nil | map(), Keyword.t()) :: res()
Link to this function

futures_get(url, params \\ nil, opts)

View Source

Specs

futures_get(String.t(), nil | map(), Keyword.t()) :: res()
Link to this function

futures_post(url, body, opts)

View Source

Specs

futures_post(String.t(), nil | map(), Keyword.t()) :: res()
Link to this function

get(url, params \\ nil, opts)

View Source

Specs

get(String.t(), nil | map(), Keyword.t()) :: res()
Link to this function

opts_definitions()

View Source

Specs

opts_definitions() :: Keyword.t()
Link to this function

post(url, body, opts)

View Source

Specs

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