BitMexApi.UserApi

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

Method	HTTP request	Description
userCancelWithdrawal	POST /user/cancelWithdrawal	Cancel a withdrawal.
userCheckReferralCode	GET /user/checkReferralCode	Check if a referral code is valid.
userCommunicationToken	POST /user/communicationToken	Register your communication token for mobile clients
userConfirm	POST /user/confirmEmail	Confirm your email address with a token.
userConfirmWithdrawal	POST /user/confirmWithdrawal	Confirm a withdrawal.
userGet	GET /user	Get your user model.
userGetAffiliateStatus	GET /user/affiliateStatus	Get your current affiliate/referral status.
userGetCommission	GET /user/commission	Get your account's commission status.
userGetDepositAddress	GET /user/depositAddress	Get a deposit address.
userGetExecutionHistory	GET /user/executionHistory	Get the execution history by day.
userGetMargin	GET /user/margin	Get your account's margin status. Send a currency of "all" to receive an array of all supported currencies.
userGetQuoteFillRatio	GET /user/quoteFillRatio	Get 7 days worth of Quote Fill Ratio statistics.
userGetWallet	GET /user/wallet	Get your current wallet information.
userGetWalletHistory	GET /user/walletHistory	Get a history of all of your wallet transactions (deposits, withdrawals, PNL).
userGetWalletSummary	GET /user/walletSummary	Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).
userLogout	POST /user/logout	Log out of BitMEX.
userMinWithdrawalFee	GET /user/minWithdrawalFee	Get the minimum withdrawal fee for a currency.
userRequestWithdrawal	POST /user/requestWithdrawal	Request a withdrawal to an external wallet.
userSavePreferences	POST /user/preferences	Save user preferences.

userCancelWithdrawal

Transaction userCancelWithdrawal(token)

Cancel a withdrawal.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.UserApi();

var token = "token_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userCancelWithdrawal(token, callback);

Parameters

Name	Type	Description	Notes
token	String

Return type

Transaction

Authorization

No authorization required

HTTP request headers

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

userCheckReferralCode

'Number' userCheckReferralCode(opts)

Check if a referral code is valid.

If the code is valid, responds with the referral code's discount (e.g. 0.1 for 10%). Otherwise, will return a 404 or 451 if invalid.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'referralCode': "referralCode_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userCheckReferralCode(opts, callback);

Parameters

Name	Type	Description	Notes
referralCode	String		[optional]

Return type

'Number'

Authorization

No authorization required

HTTP request headers

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

userCommunicationToken

[CommunicationToken] userCommunicationToken(token, platformAgent)

Register your communication token for mobile clients

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var token = "token_example"; // String | 

var platformAgent = "platformAgent_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userCommunicationToken(token, platformAgent, callback);

Parameters

Name	Type	Description	Notes
token	String
platformAgent	String

Return type

[CommunicationToken]

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

userConfirm

AccessToken userConfirm(token)

Confirm your email address with a token.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.UserApi();

var token = "token_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userConfirm(token, callback);

Parameters

Name	Type	Description	Notes
token	String

Return type

AccessToken

Authorization

No authorization required

HTTP request headers

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

userConfirmWithdrawal

Transaction userConfirmWithdrawal(token)

Confirm a withdrawal.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.UserApi();

var token = "token_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userConfirmWithdrawal(token, callback);

Parameters

Name	Type	Description	Notes
token	String

Return type

Transaction

Authorization

No authorization required

HTTP request headers

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

userGet

User userGet()

Get your user model.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

User

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

userGetAffiliateStatus

Affiliate userGetAffiliateStatus()

Get your current affiliate/referral status.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetAffiliateStatus(callback);

Parameters

This endpoint does not need any parameter.

Return type

Affiliate

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

userGetCommission

UserCommissionsBySymbol userGetCommission()

Get your account's commission status.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetCommission(callback);

Parameters

This endpoint does not need any parameter.

Return type

UserCommissionsBySymbol

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

userGetDepositAddress

'String' userGetDepositAddress(opts)

Get a deposit address.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'currency': "XBt" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetDepositAddress(opts, callback);

Parameters

Name	Type	Description	Notes
currency	String		[optional] [default to XBt]

Return type

'String'

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

userGetExecutionHistory

Object userGetExecutionHistory(symbol, timestamp)

Get the execution history by day.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var symbol = "XBTUSD"; // String | 

var timestamp = new Date("2017-02-13T12:00:00.000Z"); // Date | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetExecutionHistory(symbol, timestamp, callback);

Parameters

Name	Type	Description	Notes
symbol	String		[default to XBTUSD]
timestamp	Date		[default to 2017-02-13T12:00:00.000Z]

Return type

Object

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

userGetMargin

Margin userGetMargin(opts)

Get your account's margin status. Send a currency of "all" to receive an array of all supported currencies.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'currency': "XBt" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetMargin(opts, callback);

Parameters

Name	Type	Description	Notes
currency	String		[optional] [default to XBt]

Return type

Margin

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

userGetQuoteFillRatio

QuoteFillRatio userGetQuoteFillRatio()

Get 7 days worth of Quote Fill Ratio statistics.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetQuoteFillRatio(callback);

Parameters

This endpoint does not need any parameter.

Return type

QuoteFillRatio

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

userGetWallet

Wallet userGetWallet(opts)

Get your current wallet information.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'currency': "XBt" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetWallet(opts, callback);

Parameters

Name	Type	Description	Notes
currency	String		[optional] [default to XBt]

Return type

Wallet

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

userGetWalletHistory

[Transaction] userGetWalletHistory(opts)

Get a history of all of your wallet transactions (deposits, withdrawals, PNL).

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'currency': "XBt", // String | 
  'count': 100, // Number | Number of results to fetch.
  'start': 0 // Number | Starting point for results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetWalletHistory(opts, callback);

Parameters

Name	Type	Description	Notes
currency	String		[optional] [default to XBt]
count	Number	Number of results to fetch.	[optional] [default to 100]
start	Number	Starting point for results.	[optional] [default to 0]

Return type

[Transaction]

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

userGetWalletSummary

[Transaction] userGetWalletSummary(opts)

Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'currency': "XBt" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGetWalletSummary(opts, callback);

Parameters

Name	Type	Description	Notes
currency	String		[optional] [default to XBt]

Return type

[Transaction]

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

userLogout

userLogout()

Log out of BitMEX.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.UserApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.userLogout(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

userMinWithdrawalFee

Object userMinWithdrawalFee(opts)

Get the minimum withdrawal fee for a currency.

This is changed based on network conditions to ensure timely withdrawals. During network congestion, this may be high. The fee is returned in the same currency.

Example

var BitMexApi = require('bit_mex_api');

var apiInstance = new BitMexApi.UserApi();

var opts = { 
  'currency': "XBt" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userMinWithdrawalFee(opts, callback);

Parameters

Name	Type	Description	Notes
currency	String		[optional] [default to XBt]

Return type

Object

Authorization

No authorization required

HTTP request headers

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

userRequestWithdrawal

Transaction userRequestWithdrawal(currency, amount, address, opts)

Request a withdrawal to an external wallet.

This will send a confirmation email to the email address on record.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var currency = "XBt"; // String | Currency you're withdrawing. Options: `XBt`

var amount = 8.14; // Number | Amount of withdrawal currency.

var address = "address_example"; // String | Destination Address.

var opts = { 
  'otpToken': "otpToken_example", // String | 2FA token. Required if 2FA is enabled on your account.
  'fee': 1.2, // Number | Network fee for Bitcoin withdrawals. If not specified, a default value will be calculated based on Bitcoin network conditions. You will have a chance to confirm this via email.
  'text': "text_example" // String | Optional annotation, e.g. 'Transfer to home wallet'.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userRequestWithdrawal(currency, amount, address, opts, callback);

Parameters

Name	Type	Description	Notes
currency	String	Currency you're withdrawing. Options: `XBt`	[default to XBt]
amount	Number	Amount of withdrawal currency.
address	String	Destination Address.
otpToken	String	2FA token. Required if 2FA is enabled on your account.	[optional]
fee	Number	Network fee for Bitcoin withdrawals. If not specified, a default value will be calculated based on Bitcoin network conditions. You will have a chance to confirm this via email.	[optional]
text	String	Optional annotation, e.g. 'Transfer to home wallet'.	[optional]

Return type

Transaction

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

userSavePreferences

User userSavePreferences(prefs, opts)

Save user preferences.

Example

var BitMexApi = require('bit_mex_api');
var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix = 'Token';

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix = 'Token';

var apiInstance = new BitMexApi.UserApi();

var prefs = "prefs_example"; // String | 

var opts = { 
  'overwrite': false // Boolean | If true, will overwrite all existing preferences.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userSavePreferences(prefs, opts, callback);

Parameters

Name	Type	Description	Notes
prefs	String
overwrite	Boolean	If true, will overwrite all existing preferences.	[optional] [default to false]

Return type

User

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

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

BitMexApi.UserApi

userCancelWithdrawal

Example

Parameters

Return type

Authorization

HTTP request headers

userCheckReferralCode

Example

Parameters

Return type

Authorization

HTTP request headers

userCommunicationToken

Example

Parameters

Return type

Authorization

HTTP request headers

userConfirm

Example

Parameters

Return type

Authorization

HTTP request headers

userConfirmWithdrawal

Example

Parameters

Return type

Authorization

HTTP request headers

userGet

Example

Parameters

Return type

Authorization

HTTP request headers

userGetAffiliateStatus

Example

Parameters

Return type

Authorization

HTTP request headers

userGetCommission

Example

Parameters

Return type

Authorization

HTTP request headers

userGetDepositAddress

Example

Parameters

Return type

Authorization

HTTP request headers

userGetExecutionHistory

Example

Parameters

Return type

Authorization

HTTP request headers

userGetMargin

Example

Parameters

Return type

Authorization

HTTP request headers

userGetQuoteFillRatio

Example

Parameters

Return type

Authorization

HTTP request headers

userGetWallet