\UserApi

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

Method	HTTP request	Description
UserCancelPendingWithdrawal	Delete /user/withdrawal	Cancel pending withdrawal
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.
UserCreateSubAccount	Post /user/addSubaccount	Creates a new sub-account.
UserCreateUnstakingRequests	Post /user/unstakingRequests	Create unstaking request
UserDeleteUnstakingRequests	Delete /user/unstakingRequests	Cancel unstaking request
UserGet	Get /user	Get your user model.
UserGetAffiliateStatus	Get /user/affiliateStatus	Get your current affiliate/referral status.
UserGetCSA	Get /user/csa	Get your account's CSA status.
UserGetCommission	Get /user/commission	Get your account's commission status.
UserGetDepositAddress	Get /user/depositAddress	Get a deposit address.
UserGetDepositAddressInformation	Get /user/depositAddressInformation	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.
UserGetQuoteValueRatio	Get /user/quoteValueRatio	Get Quote Value Ratio statistics over the last 3 days
UserGetStaking	Get /user/staking	Get the current user staking amount.
UserGetStakingInstruments	Get /user/staking/instruments	List staking instruments
UserGetStakingTiers	Get /user/staking/tiers	List staking tiers for a given currency
UserGetTradingVolume	Get /user/tradingVolume	Get your 30 days USD average trading volume
UserGetUnstakingRequests	Get /user/unstakingRequests	Get the current user unstaking requests
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).
UserGetWalletTransferAccounts	Get /user/getWalletTransferAccounts	Get the list of accounts you can transfer funds between.
UserLogout	Post /user/logout	Log out of BitMEX.
UserRequestWithdrawal	Post /user/requestWithdrawal	Request a withdrawal to an external wallet.
UserSavePreferences	Post /user/preferences	Save user preferences.
UserUpdateSubAccount	Post /user/updateSubaccount	Updates the sub-account name.
UserWalletTransfer	Post /user/walletTransfer	Execute a transfer to a paired account.

UserCancelPendingWithdrawal

interface{} UserCancelPendingWithdrawal(ctx, transactID) Cancel pending withdrawal

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
transactID	string

Return type

interface{}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserCancelWithdrawal

Transaction UserCancelWithdrawal(ctx, token) Cancel a withdrawal.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserCheckReferralCode

interface{} UserCheckReferralCode(ctx, optional) 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.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserCheckReferralCodeOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserCheckReferralCodeOpts struct

Name	Type	Description	Notes
referralCode	optional.String

Return type

interface{}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserCommunicationToken

[]CommunicationToken UserCommunicationToken(ctx, token, platformAgent) Register your communication token for mobile clients

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserConfirm

AccessToken UserConfirm(ctx, token) Confirm your email address with a token.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserConfirmWithdrawal

Transaction UserConfirmWithdrawal(ctx, token) Confirm a withdrawal.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserCreateSubAccount

interface{} UserCreateSubAccount(ctx, accountName) Creates a new sub-account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountName	string

Return type

interface{}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserCreateUnstakingRequests

interface{} UserCreateUnstakingRequests(ctx, symbol, amount) Create unstaking request

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
symbol	string
amount	float64

Return type

interface{}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserDeleteUnstakingRequests

interface{} UserDeleteUnstakingRequests(ctx, redemptionID) Cancel unstaking request

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
redemptionID	string

Return type

interface{}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGet

User UserGet(ctx, ) Get your user model.

Required 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetAffiliateStatus

Affiliate UserGetAffiliateStatus(ctx, optional) Get your current affiliate/referral status.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetAffiliateStatusOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetAffiliateStatusOpts struct

Name	Type	Description	Notes
currency	optional.String	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>. For all currencies specify "all"	[default to XBt]

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetCSA

CollateralSupportAgreement UserGetCSA(ctx, ) Get your account's CSA status.

Required Parameters

This endpoint does not need any parameter.

Return type

CollateralSupportAgreement

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetCommission

UserCommissionsBySymbol UserGetCommission(ctx, ) Get your account's commission status.

Required 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetDepositAddress

string UserGetDepositAddress(ctx, currency, network) Get a deposit address.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
currency	string	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>
network	string	The `network` parameter is used to indicate which blockchain you would like to deposit from. The acceptable value in the `network` parameter for each currency can be found from `networks.asset` from `GET /wallet/assets`.

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetDepositAddressInformation

DepositAddress UserGetDepositAddressInformation(ctx, currency, network) Get a deposit address.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
currency	string	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>
network	string	The `network` parameter is used to indicate which blockchain you would like to deposit from. The acceptable value in the `network` parameter for each currency can be found from `networks.asset` from `GET /wallet/assets`.

Return type

DepositAddress

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetExecutionHistory

[]Execution UserGetExecutionHistory(ctx, symbol, timestamp) Get the execution history by day.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
symbol	string		[default to XBTUSD]
timestamp	time.Time		[default to 2017-02-13T12:00:00.000Z]

Return type

[]Execution

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetMargin

Margin UserGetMargin(ctx, optional) Get your account's margin status. Send a currency of "all" to receive an array of all supported currencies.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetMarginOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetMarginOpts struct

Name	Type	Description	Notes
currency	optional.String	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>. For all currencies specify "all"	[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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetQuoteFillRatio

QuoteFillRatio UserGetQuoteFillRatio(ctx, optional) Get 7 days worth of Quote Fill Ratio statistics.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetQuoteFillRatioOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetQuoteFillRatioOpts struct

Name	Type	Description	Notes
targetAccountId	optional.Float64	AccountId to get quote fill ratio for, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetQuoteValueRatio

QuoteValueRatio UserGetQuoteValueRatio(ctx, optional) Get Quote Value Ratio statistics over the last 3 days

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetQuoteValueRatioOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetQuoteValueRatioOpts struct

Name	Type	Description	Notes
targetAccountId	optional.Float64	AccountId to get quote value ratio for, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user

Return type

QuoteValueRatio

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetStaking

[]StakingRecord UserGetStaking(ctx, optional) Get the current user staking amount.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetStakingOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetStakingOpts struct

Name	Type	Description	Notes
currency	optional.String

Return type

[]StakingRecord

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetStakingInstruments

[]XAny UserGetStakingInstruments(ctx, optional) List staking instruments

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetStakingInstrumentsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetStakingInstrumentsOpts struct

Name	Type	Description	Notes
symbol	optional.String
currency	optional.String

Return type

[]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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetStakingTiers

[]XAny UserGetStakingTiers(ctx, currency) List staking tiers for a given currency

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
currency	string

Return type

[]XAny

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetTradingVolume

[]TradingVolume UserGetTradingVolume(ctx, ) Get your 30 days USD average trading volume

Required Parameters

This endpoint does not need any parameter.

Return type

[]TradingVolume

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetUnstakingRequests

[]StakingRecord UserGetUnstakingRequests(ctx, status) Get the current user unstaking requests

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
status	string

Return type

[]StakingRecord

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetWallet

Wallet UserGetWallet(ctx, optional) Get your current wallet information.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetWalletOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetWalletOpts struct

Name	Type	Description	Notes
currency	optional.String	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>. For all currencies specify "all"	[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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetWalletHistory

[]Transaction UserGetWalletHistory(ctx, optional) Get a history of all of your wallet transactions (deposits, withdrawals, PNL).

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetWalletHistoryOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetWalletHistoryOpts struct

Name	Type	Description	Notes
currency	optional.String	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>. For all currencies specify "all"	[default to XBt]
count	optional.Float64	Number of results to fetch. Fetch results from start to start + count. Max: 10,000 rows.	[default to 10000]
start	optional.Float64	Starting point for results, integer. Default 0.	[default to 0]
targetAccountId	optional.Float64	AccountId to view the history of, must be a paired account with the authorised user requesting the history.
reverse	optional.Bool	Start from the latest transaction record. Default true.	[default to true]

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetWalletSummary

[]WalletSummaryRecord UserGetWalletSummary(ctx, optional) Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).

Provides an aggregated view of transactions, by transaction type, over a specific time period.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*UserApiUserGetWalletSummaryOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserGetWalletSummaryOpts struct

Name	Type	Description	Notes
currency	optional.String	Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>. For all currencies specify "all"	[default to XBt]
startTime	optional.Time	Start time for the summary
endTime	optional.Time	End time for the summary

Return type

[]WalletSummaryRecord

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGetWalletTransferAccounts

[]XAny UserGetWalletTransferAccounts(ctx, ) Get the list of accounts you can transfer funds between.

Required Parameters

This endpoint does not need any parameter.

Return type

[]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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserLogout

UserLogout(ctx, ) Log out of BitMEX.

Required Parameters

This endpoint does not need any parameter.

Return type

(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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserRequestWithdrawal

Transaction UserRequestWithdrawal(ctx, currency, network, amount, optional) Request a withdrawal to an external wallet.

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

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
currency	string	Currency you're withdrawing. Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>	[default to XBt]
network	string	The `network` parameter is used to indicate which blockchain you would like to withdraw from. The acceptable value in the `network` parameter for each currency can be found from `networks.asset` from `GET /wallet/assets`.
amount	int64	Amount of withdrawal currency.
optional	*UserApiUserRequestWithdrawalOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserRequestWithdrawalOpts struct

Name	Type	Description	Notes

otpToken | optional.String| 2FA token. Required for all external withdrawals unless the address has skip2FA in addressbook. | address | optional.String| Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified. | memo | optional.String| Destination Memo. If `address`, is specified, Destination Memo can also be specified | addressId | optional.Float64| ID of the Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified. | targetUserId | optional.Float64| ID of the Target User. One of `address`, `addressId`, `targetUserId` has to be specified. | fee | optional.Float64| 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 | optional.String| Optional annotation, e.g. 'Transfer to home wallet'. |

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserSavePreferences

User UserSavePreferences(ctx, prefs, optional) Save user preferences.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
prefs	string
optional	*UserApiUserSavePreferencesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserSavePreferencesOpts struct

Name	Type	Description	Notes

overwrite | optional.Bool| If true, will overwrite all existing preferences. | [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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserUpdateSubAccount

interface{} UserUpdateSubAccount(ctx, targetAccountId, accountName) Updates the sub-account name.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
targetAccountId	float64
accountName	string

Return type

interface{}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserWalletTransfer

Transaction UserWalletTransfer(ctx, currency, amount, targetAccountId, optional) Execute a transfer to a paired account.

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

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
currency	string	Currency you're transfering. Any currency. For all currencies, see <a href="#!/Wallet/Wallet_getAssetsConfig">asset config endpoint</a>
amount	int64	Amount of transfer.
targetAccountId	float64	AccountId to send the transfer to, must be a paired account with the user sending the transfer.
optional	*UserApiUserWalletTransferOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UserApiUserWalletTransferOpts struct

Name	Type	Description	Notes

fromAccountId | optional.Float64| AccountID to send the transfer from. Must be paired account with the authenticated user. |

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

\UserApi

UserCancelPendingWithdrawal

Required Parameters

Return type

Authorization

HTTP request headers

UserCancelWithdrawal

Required Parameters

Return type

Authorization

HTTP request headers

UserCheckReferralCode

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

UserCommunicationToken

Required Parameters

Return type

Authorization

HTTP request headers

UserConfirm

Required Parameters

Return type

Authorization

HTTP request headers

UserConfirmWithdrawal

Required Parameters

Return type

Authorization

HTTP request headers

UserCreateSubAccount

Required Parameters

Return type

Authorization

HTTP request headers

UserCreateUnstakingRequests

Required Parameters

Return type

Authorization

HTTP request headers

UserDeleteUnstakingRequests

Required Parameters

Return type

Authorization

HTTP request headers

UserGet

Required Parameters

Return type

Authorization

HTTP request headers

UserGetAffiliateStatus

Required Parameters

Optional Parameters

Return type

Authorization

HTTP request headers

UserGetCSA

Required Parameters

Return type

Authorization

HTTP request headers

UserGetCommission

Required Parameters

Return type

Authorization

HTTP request headers

UserGetDepositAddress

Required Parameters

Return type

Authorization

HTTP request headers

UserGetDepositAddressInformation