Class: Bybit::RestApi::BrokerService

Inherits:
BaseService show all
Defined in:
lib/bybit/rest_api/broker_service.rb

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from Bybit::RestApi::BaseService

Instance Method Details

#distribute_award(account_id:, award_id:, spec_code:, amount:, broker_id:, **kwargs) ⇒ Hash

Distribute voucher

POST /v5/broker/award/distribute-award

Parameters:

  • account_id (String) —

    Account ID

  • award_id (String) —

    Award ID

  • spec_code (String) —

    Spec code

  • amount (String) —

    Distribution amount

  • broker_id (String) —

    Broker ID

Returns:

  • (Hash) —

    Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).



16
17
18
19
20
 
# File 'lib/bybit/rest_api/broker_service.rb', line 16

def distribute_award(account_id:, award_id:, spec_code:, amount:, broker_id:, **kwargs)
  params = kwargs.merge(account_id: , award_id: award_id, spec_code: spec_code, amount: amount, broker_id: broker_id)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :post, path: '/v5/broker/award/distribute-award', body: params)
end

#get_award_info(id:, **kwargs) ⇒ Hash

Get voucher details

POST /v5/broker/award/info

Parameters:

  • id (String) —

    Voucher ID

Returns:

  • (Hash) —

    Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).



28
29
30
31
32
 
# File 'lib/bybit/rest_api/broker_service.rb', line 28

def get_award_info(id:, **kwargs)
  params = kwargs.merge(id: id)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :post, path: '/v5/broker/award/info', body: params)
end

#get_broker_account_info ⇒ Object

Get Broker Account Info

GET /v5/broker/account-info



52
53
54
 
# File 'lib/bybit/rest_api/broker_service.rb', line 52

def 
  @session.sign_request(method: :get, path: '/v5/broker/account-info')
end

#get_broker_rate_limit_cap ⇒ Object

Query Broker Rate Limit Cap

GET /v5/broker/apilimit/query-cap



73
74
75
 
# File 'lib/bybit/rest_api/broker_service.rb', line 73

def get_broker_rate_limit_cap
  @session.sign_request(method: :get, path: '/v5/broker/apilimit/query-cap')
end

#get_distribution_record(account_id:, award_id:, spec_code:, **kwargs) ⇒ Hash

Query voucher distribution record

POST /v5/broker/award/distribution-record

Parameters:

  • account_id (String) —

    Account ID

  • award_id (String) —

    Award ID

  • spec_code (String) —

    Spec code

  • kwargs (Hash) —

    a customizable set of options

Options Hash (**kwargs):

  • :with_used_amount (Boolean) —

    Include used amount flag

Returns:

  • (Hash) —

    Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).



43
44
45
46
47
 
# File 'lib/bybit/rest_api/broker_service.rb', line 43

def get_distribution_record(account_id:, award_id:, spec_code:, **kwargs)
  params = kwargs.merge(account_id: , award_id: award_id, spec_code: spec_code)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :post, path: '/v5/broker/award/distribution-record', body: params)
end

#list_broker_earnings(**kwargs) ⇒ Hash

Get Broker Earnings Info

GET /v5/broker/earnings-info

Parameters:

  • kwargs (Hash) —

    a customizable set of options

Options Hash (**kwargs):

  • :biz_type (String) —

    Business type

  • :begin_ (String) —

    Begin date

  • :end_ (String) —

    End date

  • :uid (String) —

    Sub UID

  • :limit (Integer) —

    Result limit

  • :cursor (String) —

    Pagination cursor

Returns:

  • (Hash) —

    Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).



88
89
90
91
92
93
94
 
# File 'lib/bybit/rest_api/broker_service.rb', line 88

def list_broker_earnings(**kwargs)
  params = kwargs.dup
  params[:begin] = params.delete(:begin_) if params.key?(:begin_)
  params[:end] = params.delete(:end_) if params.key?(:end_)
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/broker/earnings-info', params: params)
end

#list_broker_sub_uids(**kwargs) ⇒ Hash

Query Broker All UID Rate Limits

GET /v5/broker/apilimit/query-all

Parameters:

  • kwargs (Hash) —

    a customizable set of options

Options Hash (**kwargs):

  • :uids (String) —

    UIDs to query

  • :limit (Integer) —

    Result limit

  • :cursor (String) —

    Pagination cursor

Returns:

  • (Hash) —

    Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).



64
65
66
67
68
 
# File 'lib/bybit/rest_api/broker_service.rb', line 64

def list_broker_sub_uids(**kwargs)
  params = kwargs.dup
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :get, path: '/v5/broker/apilimit/query-all', params: params)
end

#set_api_limit(**kwargs) ⇒ Hash

Set Broker API Rate Limit

POST /v5/broker/apilimit/set

Parameters:

  • kwargs (Hash) —

    a customizable set of options

Options Hash (**kwargs):

  • :list (Array) —

    List of rate limit config entries

Returns:

  • (Hash) —

    Bybit V5 ApiResponse envelope (retCode / retMsg / result / retExtInfo / time).



102
103
104
105
106
 
# File 'lib/bybit/rest_api/broker_service.rb', line 102

def set_api_limit(**kwargs)
  params = kwargs.dup
  params = Bybit::Utils::WireKeys.camelize(params)
  @session.sign_request(method: :post, path: '/v5/broker/apilimit/set', body: params)
end