Bingex.User (Bingex v0.1.7)

Provides an interface to interact with the BingX User API.

This module enables users to manage authentication tokens, retrieve referral details, and handle account-related requests. It facilitates secure API interactions by generating and extending listen keys for user data streams and retrieving referral information.

Key features:

Generate and extend listen keys for user data streams
Retrieve referral details for a specific user
Fetch lists of referred users
Secure request signing for authenticated API calls

All requests requiring authentication will be signed using an API key and secret key.

Summary

Functions

extend_listen_key(listen_key, api_key)

generate_listen_key(api_key)

get_referral(user_id, api_key, secret_key)

get_referrals(page_index \\ 0, page_size \\ 200, start_time \\ nil, end_time \\ nil, api_key, secret_key)

Functions

extend_listen_key(listen_key, api_key)

@spec extend_listen_key(listen_key :: binary(), api_key :: binary()) ::
  {:ok, Bingex.API.Reply.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}

generate_listen_key(api_key)

@spec generate_listen_key(api_key :: binary()) ::
  {:ok, Bingex.API.Reply.t(Bingex.User.GenerateListenKeyData.t()),
   Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}

get_referral(user_id, api_key, secret_key)

@spec get_referral(
  user_id :: binary(),
  api_key :: binary(),
  secret_key :: binary()
) ::
  {:ok, Bingex.API.Reply.t(Bingex.User.GetReferralData.t()),
   Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}

get_referrals(page_index \\ 0, page_size \\ 200, start_time \\ nil, end_time \\ nil, api_key, secret_key)

@spec get_referrals(
  page_index :: non_neg_integer(),
  page_size :: non_neg_integer(),
  start_time :: nil | non_neg_integer(),
  end_time :: nil | non_neg_integer(),
  api_key :: binary(),
  secret_key :: binary()
) ::
  {:ok, Bingex.API.Reply.t(Bingex.User.GetReferralsData.t()),
   Bingex.Types.request_metadata()}
  | {:error, Bingex.API.Error.t(), Bingex.Types.request_metadata()}
  | {:error, Bingex.HTTP.Error.t(), Bingex.Types.failed_request_metadata()}