Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 2.59 KB

UserAffiliatesApi.md

File metadata and controls

76 lines (54 loc) · 2.59 KB

SwaggerClient::UserAffiliatesApi

All URIs are relative to https://www.bitmex.com/api/v1

Method HTTP request Description
user_affiliates_get GET /userAffiliates Get user's affiliates to a given depth

user_affiliates_get

Array<XAny> user_affiliates_get(opts)

Get user's affiliates to a given depth

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiExpires
  config.api_key['api-expires'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-expires'] = 'Bearer'

  # Configure API key authorization: apiKey
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['api-signature'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-signature'] = 'Bearer'
end

api_instance = SwaggerClient::UserAffiliatesApi.new

opts = { 
  depth: 1.2, # Float | the depth of affiliates to return. Eg depth = 2 would return direct affiliates and their affiliates
  target_account_id: 1.2, # Float | AccountId of Sub-Affiliate Account
  select_user_id: 1.2 # Float | User id of result array to keep
}

begin
  #Get user's affiliates to a given depth
  result = api_instance.user_affiliates_get(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling UserAffiliatesApi->user_affiliates_get: #{e}"
end

Parameters

Name Type Description Notes
depth Float the depth of affiliates to return. Eg depth = 2 would return direct affiliates and their affiliates [optional]
target_account_id Float AccountId of Sub-Affiliate Account [optional]
select_user_id Float User id of result array to keep [optional]

Return type

Array<XAny>

Authorization

apiExpires, apiKey, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript