BinanceSpotRest.Client (Binance Spot Rest v0.2.1)

View Source

Low-level BinanceSpotRest REST client (internal/advanced use).

This module builds and executes HTTP requests based on a RequestSpec.

Important: Automatic retries are disabled. Users should implement their own retry logic if needed.

Overview

Responsibilities:

  • Constructing the full request URL
  • Adding required headers
  • Signing requests for endpoints that require authentication
  • Making the HTTP request via Req (retry disabled)

Note: This module is intended for advanced users. For most use cases, use BinanceSpotRest.request/2.

Options (opts)

All functions accept optional keyword list:

  • :base_url - Base API URL (default: BinanceSpotRest.Env.base_url())
  • :headers - List of headers (default: built from security_type)
  • :secret_key_fn - Function returning secret key (default: BinanceSpotRest.Env.secret_key())
  • :timestamp_fn - Function returning current timestamp (default: BinanceSpotRest.Client.Timestamp.create())
  • :signature_fn - Function that creates signature (default: BinanceSpotRest.Client.Signature.create())

Example

alias BinanceSpotRest.Endpoints.Trading.OrderPost.LimitQuery

query = %LimitQuery{...}

request =
  BinanceSpotRest.Client.create_request(query,
    base_url: "https://mock.url",
    timestamp_fn: fn -> 1_740_000_000_000 end,
    signature_fn: fn _qs, _key -> "mock-signature" end
  )

{:ok, response} = BinanceSpotRest.Client.make_request(request)

Summary

Types

opts()

Functions

create_request(request_spec, opts \\ [])

Creates a %Request{} from a RequestSpec.

make_request(r)

Executes a %Request{} using Req.

Types

opts()

@type opts() :: [
  base_url: String.t(),
  headers: [{String.t(), String.t()}],
  secret_key_fn: (-> String.t()),
  timestamp_fn: (-> integer()),
  signature_fn: (String.t(), String.t() -> String.t())
]

Functions

create_request(request_spec, opts \\ [])

Creates a %Request{} from a RequestSpec.

make_request(r)

Executes a %Request{} using Req.

Retries are strictly disabled. Users should implement retries themselves if needed.