# IO.Swagger.Api.UserApi
All URIs are relative to *https://www.bitmex.com/api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**UserCancelPendingWithdrawal**](UserApi.md#usercancelpendingwithdrawal) | **DELETE** /user/withdrawal | Cancel pending withdrawal
[**UserCancelWithdrawal**](UserApi.md#usercancelwithdrawal) | **POST** /user/cancelWithdrawal | Cancel a withdrawal.
[**UserCheckReferralCode**](UserApi.md#usercheckreferralcode) | **GET** /user/checkReferralCode | Check if a referral code is valid.
[**UserCommunicationToken**](UserApi.md#usercommunicationtoken) | **POST** /user/communicationToken | Register your communication token for mobile clients
[**UserConfirm**](UserApi.md#userconfirm) | **POST** /user/confirmEmail | Confirm your email address with a token.
[**UserConfirmWithdrawal**](UserApi.md#userconfirmwithdrawal) | **POST** /user/confirmWithdrawal | Confirm a withdrawal.
[**UserCreateSubAccount**](UserApi.md#usercreatesubaccount) | **POST** /user/addSubaccount | Creates a new sub-account.
[**UserCreateUnstakingRequests**](UserApi.md#usercreateunstakingrequests) | **POST** /user/unstakingRequests | Create unstaking request
[**UserDeleteUnstakingRequests**](UserApi.md#userdeleteunstakingrequests) | **DELETE** /user/unstakingRequests | Cancel unstaking request
[**UserGet**](UserApi.md#userget) | **GET** /user | Get your user model.
[**UserGetAffiliateStatus**](UserApi.md#usergetaffiliatestatus) | **GET** /user/affiliateStatus | Get your current affiliate/referral status.
[**UserGetCSA**](UserApi.md#usergetcsa) | **GET** /user/csa | Get your account's CSA status.
[**UserGetCommission**](UserApi.md#usergetcommission) | **GET** /user/commission | Get your account's commission status.
[**UserGetDepositAddress**](UserApi.md#usergetdepositaddress) | **GET** /user/depositAddress | Get a deposit address.
[**UserGetDepositAddressInformation**](UserApi.md#usergetdepositaddressinformation) | **GET** /user/depositAddressInformation | Get a deposit address.
[**UserGetExecutionHistory**](UserApi.md#usergetexecutionhistory) | **GET** /user/executionHistory | Get the execution history by day.
[**UserGetMargin**](UserApi.md#usergetmargin) | **GET** /user/margin | Get your account's margin status. Send a currency of \"all\" to receive an array of all supported currencies.
[**UserGetQuoteFillRatio**](UserApi.md#usergetquotefillratio) | **GET** /user/quoteFillRatio | Get 7 days worth of Quote Fill Ratio statistics.
[**UserGetQuoteValueRatio**](UserApi.md#usergetquotevalueratio) | **GET** /user/quoteValueRatio | Get Quote Value Ratio statistics over the last 3 days
[**UserGetStaking**](UserApi.md#usergetstaking) | **GET** /user/staking | Get the current user staking amount.
[**UserGetStakingInstruments**](UserApi.md#usergetstakinginstruments) | **GET** /user/staking/instruments | List staking instruments
[**UserGetStakingTiers**](UserApi.md#usergetstakingtiers) | **GET** /user/staking/tiers | List staking tiers for a given currency
[**UserGetTradingVolume**](UserApi.md#usergettradingvolume) | **GET** /user/tradingVolume | Get your 30 days USD average trading volume
[**UserGetUnstakingRequests**](UserApi.md#usergetunstakingrequests) | **GET** /user/unstakingRequests | Get the current user unstaking requests
[**UserGetWallet**](UserApi.md#usergetwallet) | **GET** /user/wallet | Get your current wallet information.
[**UserGetWalletHistory**](UserApi.md#usergetwallethistory) | **GET** /user/walletHistory | Get a history of all of your wallet transactions (deposits, withdrawals, PNL).
[**UserGetWalletSummary**](UserApi.md#usergetwalletsummary) | **GET** /user/walletSummary | Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).
[**UserGetWalletTransferAccounts**](UserApi.md#usergetwallettransferaccounts) | **GET** /user/getWalletTransferAccounts | Get the list of accounts you can transfer funds between.
[**UserLogout**](UserApi.md#userlogout) | **POST** /user/logout | Log out of BitMEX.
[**UserRequestWithdrawal**](UserApi.md#userrequestwithdrawal) | **POST** /user/requestWithdrawal | Request a withdrawal to an external wallet.
[**UserSavePreferences**](UserApi.md#usersavepreferences) | **POST** /user/preferences | Save user preferences.
[**UserUpdateSubAccount**](UserApi.md#userupdatesubaccount) | **POST** /user/updateSubaccount | Updates the sub-account name.
[**UserWalletTransfer**](UserApi.md#userwallettransfer) | **POST** /user/walletTransfer | Execute a transfer to a paired account.
<a name="usercancelpendingwithdrawal"></a>
# **UserCancelPendingWithdrawal**
> Object UserCancelPendingWithdrawal (string transactID)
Cancel pending withdrawal
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserCancelPendingWithdrawalExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var transactID = transactID_example; // string |
try
{
// Cancel pending withdrawal
Object result = apiInstance.UserCancelPendingWithdrawal(transactID);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserCancelPendingWithdrawal: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**transactID** | **string**| |
### Return type
**Object**
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usercancelwithdrawal"></a>
# **UserCancelWithdrawal**
> Transaction UserCancelWithdrawal (string token)
Cancel a withdrawal.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserCancelWithdrawalExample
{
public void main()
{
var apiInstance = new UserApi();
var token = token_example; // string |
try
{
// Cancel a withdrawal.
Transaction result = apiInstance.UserCancelWithdrawal(token);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserCancelWithdrawal: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **string**| |
### Return type
[**Transaction**](Transaction.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usercheckreferralcode"></a>
# **UserCheckReferralCode**
> Object UserCheckReferralCode (string referralCode = null)
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
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserCheckReferralCodeExample
{
public void main()
{
var apiInstance = new UserApi();
var referralCode = referralCode_example; // string | (optional)
try
{
// Check if a referral code is valid.
Object result = apiInstance.UserCheckReferralCode(referralCode);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserCheckReferralCode: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**referralCode** | **string**| | [optional]
### 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
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usercommunicationtoken"></a>
# **UserCommunicationToken**
> List<CommunicationToken> UserCommunicationToken (string token, string platformAgent)
Register your communication token for mobile clients
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserCommunicationTokenExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var token = token_example; // string |
var platformAgent = platformAgent_example; // string |
try
{
// Register your communication token for mobile clients
List<CommunicationToken> result = apiInstance.UserCommunicationToken(token, platformAgent);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserCommunicationToken: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **string**| |
**platformAgent** | **string**| |
### Return type
[**List<CommunicationToken>**](CommunicationToken.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userconfirm"></a>
# **UserConfirm**
> AccessToken UserConfirm (string token)
Confirm your email address with a token.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserConfirmExample
{
public void main()
{
var apiInstance = new UserApi();
var token = token_example; // string |
try
{
// Confirm your email address with a token.
AccessToken result = apiInstance.UserConfirm(token);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserConfirm: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **string**| |
### Return type
[**AccessToken**](AccessToken.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userconfirmwithdrawal"></a>
# **UserConfirmWithdrawal**
> Transaction UserConfirmWithdrawal (string token)
Confirm a withdrawal.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserConfirmWithdrawalExample
{
public void main()
{
var apiInstance = new UserApi();
var token = token_example; // string |
try
{
// Confirm a withdrawal.
Transaction result = apiInstance.UserConfirmWithdrawal(token);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserConfirmWithdrawal: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**token** | **string**| |
### Return type
[**Transaction**](Transaction.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usercreatesubaccount"></a>
# **UserCreateSubAccount**
> Object UserCreateSubAccount (string accountName)
Creates a new sub-account.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserCreateSubAccountExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var accountName = accountName_example; // string |
try
{
// Creates a new sub-account.
Object result = apiInstance.UserCreateSubAccount(accountName);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserCreateSubAccount: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**accountName** | **string**| |
### Return type
**Object**
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usercreateunstakingrequests"></a>
# **UserCreateUnstakingRequests**
> Object UserCreateUnstakingRequests (string symbol, double? amount)
Create unstaking request
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserCreateUnstakingRequestsExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var symbol = symbol_example; // string |
var amount = 1.2; // double? |
try
{
// Create unstaking request
Object result = apiInstance.UserCreateUnstakingRequests(symbol, amount);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserCreateUnstakingRequests: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**symbol** | **string**| |
**amount** | **double?**| |
### Return type
**Object**
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userdeleteunstakingrequests"></a>
# **UserDeleteUnstakingRequests**
> Object UserDeleteUnstakingRequests (string redemptionID)
Cancel unstaking request
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserDeleteUnstakingRequestsExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var redemptionID = redemptionID_example; // string |
try
{
// Cancel unstaking request
Object result = apiInstance.UserDeleteUnstakingRequests(redemptionID);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserDeleteUnstakingRequests: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**redemptionID** | **string**| |
### Return type
**Object**
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userget"></a>
# **UserGet**
> User UserGet ()
Get your user model.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
try
{
// Get your user model.
User result = apiInstance.UserGet();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGet: " + e.Message );
}
}
}
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**User**](User.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetaffiliatestatus"></a>
# **UserGetAffiliateStatus**
> Affiliate UserGetAffiliateStatus (string currency = null)
Get your current affiliate/referral status.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetAffiliateStatusExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" (optional) (default to XBt)
try
{
// Get your current affiliate/referral status.
Affiliate result = apiInstance.UserGetAffiliateStatus(currency);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetAffiliateStatus: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" | [optional] [default to XBt]
### Return type
[**Affiliate**](Affiliate.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetcsa"></a>
# **UserGetCSA**
> CollateralSupportAgreement UserGetCSA ()
Get your account's CSA status.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetCSAExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
try
{
// Get your account's CSA status.
CollateralSupportAgreement result = apiInstance.UserGetCSA();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetCSA: " + e.Message );
}
}
}
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**CollateralSupportAgreement**](CollateralSupportAgreement.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetcommission"></a>
# **UserGetCommission**
> UserCommissionsBySymbol UserGetCommission ()
Get your account's commission status.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetCommissionExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
try
{
// Get your account's commission status.
UserCommissionsBySymbol result = apiInstance.UserGetCommission();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetCommission: " + e.Message );
}
}
}
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**UserCommissionsBySymbol**](UserCommissionsBySymbol.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetdepositaddress"></a>
# **UserGetDepositAddress**
> string UserGetDepositAddress (string currency, string network)
Get a deposit address.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetDepositAddressExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>
var network = network_example; // 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`.
try
{
// Get a deposit address.
string result = apiInstance.UserGetDepositAddress(currency, network);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetDepositAddress: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetdepositaddressinformation"></a>
# **UserGetDepositAddressInformation**
> DepositAddress UserGetDepositAddressInformation (string currency, string network)
Get a deposit address.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetDepositAddressInformationExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>
var network = network_example; // 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`.
try
{
// Get a deposit address.
DepositAddress result = apiInstance.UserGetDepositAddressInformation(currency, network);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetDepositAddressInformation: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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**](DepositAddress.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetexecutionhistory"></a>
# **UserGetExecutionHistory**
> List<Execution> UserGetExecutionHistory (string symbol, DateTime? timestamp)
Get the execution history by day.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetExecutionHistoryExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var symbol = symbol_example; // string | (default to XBTUSD)
var timestamp = 2013-10-20T19:20:30+01:00; // DateTime? | (default to 2017-02-13T12:00:00.000Z)
try
{
// Get the execution history by day.
List<Execution> result = apiInstance.UserGetExecutionHistory(symbol, timestamp);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetExecutionHistory: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**symbol** | **string**| | [default to XBTUSD]
**timestamp** | **DateTime?**| | [default to 2017-02-13T12:00:00.000Z]
### Return type
[**List<Execution>**](Execution.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetmargin"></a>
# **UserGetMargin**
> Margin UserGetMargin (string currency = null)
Get your account's margin status. Send a currency of \"all\" to receive an array of all supported currencies.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetMarginExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" (optional) (default to XBt)
try
{
// Get your account's margin status. Send a currency of \"all\" to receive an array of all supported currencies.
Margin result = apiInstance.UserGetMargin(currency);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetMargin: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" | [optional] [default to XBt]
### Return type
[**Margin**](Margin.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetquotefillratio"></a>
# **UserGetQuoteFillRatio**
> QuoteFillRatio UserGetQuoteFillRatio (double? targetAccountId = null)
Get 7 days worth of Quote Fill Ratio statistics.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetQuoteFillRatioExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var targetAccountId = 1.2; // double? | 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 (optional)
try
{
// Get 7 days worth of Quote Fill Ratio statistics.
QuoteFillRatio result = apiInstance.UserGetQuoteFillRatio(targetAccountId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetQuoteFillRatio: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**targetAccountId** | **double?**| 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 | [optional]
### Return type
[**QuoteFillRatio**](QuoteFillRatio.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetquotevalueratio"></a>
# **UserGetQuoteValueRatio**
> QuoteValueRatio UserGetQuoteValueRatio (double? targetAccountId = null)
Get Quote Value Ratio statistics over the last 3 days
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetQuoteValueRatioExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var targetAccountId = 1.2; // double? | 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 (optional)
try
{
// Get Quote Value Ratio statistics over the last 3 days
QuoteValueRatio result = apiInstance.UserGetQuoteValueRatio(targetAccountId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetQuoteValueRatio: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**targetAccountId** | **double?**| 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 | [optional]
### Return type
[**QuoteValueRatio**](QuoteValueRatio.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetstaking"></a>
# **UserGetStaking**
> List<StakingRecord> UserGetStaking (string currency = null)
Get the current user staking amount.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetStakingExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | (optional)
try
{
// Get the current user staking amount.
List<StakingRecord> result = apiInstance.UserGetStaking(currency);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetStaking: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| | [optional]
### Return type
[**List<StakingRecord>**](StakingRecord.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetstakinginstruments"></a>
# **UserGetStakingInstruments**
> List<XAny> UserGetStakingInstruments (string symbol = null, string currency = null)
List staking instruments
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetStakingInstrumentsExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var symbol = symbol_example; // string | (optional)
var currency = currency_example; // string | (optional)
try
{
// List staking instruments
List<XAny> result = apiInstance.UserGetStakingInstruments(symbol, currency);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetStakingInstruments: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**symbol** | **string**| | [optional]
**currency** | **string**| | [optional]
### Return type
[**List<XAny>**](XAny.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetstakingtiers"></a>
# **UserGetStakingTiers**
> List<XAny> UserGetStakingTiers (string currency)
List staking tiers for a given currency
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetStakingTiersExample
{
public void main()
{
var apiInstance = new UserApi();
var currency = currency_example; // string |
try
{
// List staking tiers for a given currency
List<XAny> result = apiInstance.UserGetStakingTiers(currency);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetStakingTiers: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| |
### Return type
[**List<XAny>**](XAny.md)
### 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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergettradingvolume"></a>
# **UserGetTradingVolume**
> List<TradingVolume> UserGetTradingVolume ()
Get your 30 days USD average trading volume
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetTradingVolumeExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
try
{
// Get your 30 days USD average trading volume
List<TradingVolume> result = apiInstance.UserGetTradingVolume();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetTradingVolume: " + e.Message );
}
}
}
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<TradingVolume>**](TradingVolume.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetunstakingrequests"></a>
# **UserGetUnstakingRequests**
> List<StakingRecord> UserGetUnstakingRequests (string status)
Get the current user unstaking requests
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetUnstakingRequestsExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var status = status_example; // string |
try
{
// Get the current user unstaking requests
List<StakingRecord> result = apiInstance.UserGetUnstakingRequests(status);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetUnstakingRequests: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | **string**| |
### Return type
[**List<StakingRecord>**](StakingRecord.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetwallet"></a>
# **UserGetWallet**
> Wallet UserGetWallet (string currency = null)
Get your current wallet information.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetWalletExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" (optional) (default to XBt)
try
{
// Get your current wallet information.
Wallet result = apiInstance.UserGetWallet(currency);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetWallet: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" | [optional] [default to XBt]
### Return type
[**Wallet**](Wallet.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetwallethistory"></a>
# **UserGetWalletHistory**
> List<Transaction> UserGetWalletHistory (string currency = null, double? count = null, double? start = null, double? targetAccountId = null, bool? reverse = null)
Get a history of all of your wallet transactions (deposits, withdrawals, PNL).
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetWalletHistoryExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" (optional) (default to XBt)
var count = 1.2; // double? | Number of results to fetch. Fetch results from start to start + count. Max: 10,000 rows. (optional) (default to 10000)
var start = 1.2; // double? | Starting point for results, integer. Default 0. (optional) (default to 0)
var targetAccountId = 1.2; // double? | AccountId to view the history of, must be a paired account with the authorised user requesting the history. (optional)
var reverse = true; // bool? | Start from the latest transaction record. Default true. (optional) (default to true)
try
{
// Get a history of all of your wallet transactions (deposits, withdrawals, PNL).
List<Transaction> result = apiInstance.UserGetWalletHistory(currency, count, start, targetAccountId, reverse);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetWalletHistory: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" | [optional] [default to XBt]
**count** | **double?**| Number of results to fetch. Fetch results from start to start + count. Max: 10,000 rows. | [optional] [default to 10000]
**start** | **double?**| Starting point for results, integer. Default 0. | [optional] [default to 0]
**targetAccountId** | **double?**| AccountId to view the history of, must be a paired account with the authorised user requesting the history. | [optional]
**reverse** | **bool?**| Start from the latest transaction record. Default true. | [optional] [default to true]
### Return type
[**List<Transaction>**](Transaction.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetwalletsummary"></a>
# **UserGetWalletSummary**
> List<WalletSummaryRecord> UserGetWalletSummary (string currency = null, DateTime? startTime = null, DateTime? endTime = null)
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.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetWalletSummaryExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" (optional) (default to XBt)
var startTime = 2013-10-20T19:20:30+01:00; // DateTime? | Start time for the summary (optional)
var endTime = 2013-10-20T19:20:30+01:00; // DateTime? | End time for the summary (optional)
try
{
// Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).
List<WalletSummaryRecord> result = apiInstance.UserGetWalletSummary(currency, startTime, endTime);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetWalletSummary: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\" | [optional] [default to XBt]
**startTime** | **DateTime?**| Start time for the summary | [optional]
**endTime** | **DateTime?**| End time for the summary | [optional]
### Return type
[**List<WalletSummaryRecord>**](WalletSummaryRecord.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usergetwallettransferaccounts"></a>
# **UserGetWalletTransferAccounts**
> List<XAny> UserGetWalletTransferAccounts ()
Get the list of accounts you can transfer funds between.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserGetWalletTransferAccountsExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
try
{
// Get the list of accounts you can transfer funds between.
List<XAny> result = apiInstance.UserGetWalletTransferAccounts();
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserGetWalletTransferAccounts: " + e.Message );
}
}
}
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<XAny>**](XAny.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userlogout"></a>
# **UserLogout**
> void UserLogout ()
Log out of BitMEX.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserLogoutExample
{
public void main()
{
var apiInstance = new UserApi();
try
{
// Log out of BitMEX.
apiInstance.UserLogout();
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserLogout: " + e.Message );
}
}
}
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userrequestwithdrawal"></a>
# **UserRequestWithdrawal**
> Transaction UserRequestWithdrawal (string currency, string network, long? amount, string otpToken = null, string address = null, string memo = null, double? addressId = null, double? targetUserId = null, double? fee = null, string text = null)
Request a withdrawal to an external wallet.
This will send a confirmation email to the email address on record.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserRequestWithdrawalExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Currency you're withdrawing. Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a> (default to XBt)
var network = network_example; // 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`.
var amount = 789; // long? | Amount of withdrawal currency.
var otpToken = otpToken_example; // string | 2FA token. Required for all external withdrawals unless the address has skip2FA in addressbook. (optional)
var address = address_example; // string | Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified. (optional)
var memo = memo_example; // string | Destination Memo. If `address`, is specified, Destination Memo can also be specified (optional)
var addressId = 1.2; // double? | ID of the Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified. (optional)
var targetUserId = 1.2; // double? | ID of the Target User. One of `address`, `addressId`, `targetUserId` has to be specified. (optional)
var fee = 1.2; // double? | 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)
var text = text_example; // string | Optional annotation, e.g. 'Transfer to home wallet'. (optional)
try
{
// Request a withdrawal to an external wallet.
Transaction result = apiInstance.UserRequestWithdrawal(currency, network, amount, otpToken, address, memo, addressId, targetUserId, fee, text);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserRequestWithdrawal: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**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** | **long?**| Amount of withdrawal currency. |
**otpToken** | **string**| 2FA token. Required for all external withdrawals unless the address has skip2FA in addressbook. | [optional]
**address** | **string**| Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified. | [optional]
**memo** | **string**| Destination Memo. If `address`, is specified, Destination Memo can also be specified | [optional]
**addressId** | **double?**| ID of the Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified. | [optional]
**targetUserId** | **double?**| ID of the Target User. One of `address`, `addressId`, `targetUserId` has to be specified. | [optional]
**fee** | **double?**| 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**](Transaction.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="usersavepreferences"></a>
# **UserSavePreferences**
> User UserSavePreferences (string prefs, bool? overwrite = null)
Save user preferences.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserSavePreferencesExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var prefs = prefs_example; // string |
var overwrite = true; // bool? | If true, will overwrite all existing preferences. (optional) (default to false)
try
{
// Save user preferences.
User result = apiInstance.UserSavePreferences(prefs, overwrite);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserSavePreferences: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**prefs** | **string**| |
**overwrite** | **bool?**| If true, will overwrite all existing preferences. | [optional] [default to false]
### Return type
[**User**](User.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userupdatesubaccount"></a>
# **UserUpdateSubAccount**
> Object UserUpdateSubAccount (double? targetAccountId, string accountName)
Updates the sub-account name.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserUpdateSubAccountExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var targetAccountId = 1.2; // double? |
var accountName = accountName_example; // string |
try
{
// Updates the sub-account name.
Object result = apiInstance.UserUpdateSubAccount(targetAccountId, accountName);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserUpdateSubAccount: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**targetAccountId** | **double?**| |
**accountName** | **string**| |
### Return type
**Object**
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a name="userwallettransfer"></a>
# **UserWalletTransfer**
> Transaction UserWalletTransfer (string currency, long? amount, double? targetAccountId, double? fromAccountId = null)
Execute a transfer to a paired account.
This will send a confirmation email to the email address on record.
### Example
```csharp
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class UserWalletTransferExample
{
public void main()
{
// Configure API key authorization: apiExpires
Configuration.Default.AddApiKey("api-expires", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-expires", "Bearer");
// Configure API key authorization: apiKey
Configuration.Default.AddApiKey("api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-key", "Bearer");
// Configure API key authorization: apiSignature
Configuration.Default.AddApiKey("api-signature", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("api-signature", "Bearer");
var apiInstance = new UserApi();
var currency = currency_example; // string | Currency you're transfering. Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>
var amount = 789; // long? | Amount of transfer.
var targetAccountId = 1.2; // double? | AccountId to send the transfer to, must be a paired account with the user sending the transfer.
var fromAccountId = 1.2; // double? | AccountID to send the transfer from. Must be paired account with the authenticated user. (optional)
try
{
// Execute a transfer to a paired account.
Transaction result = apiInstance.UserWalletTransfer(currency, amount, targetAccountId, fromAccountId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling UserApi.UserWalletTransfer: " + e.Message );
}
}
}
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**currency** | **string**| Currency you're transfering. Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a> |
**amount** | **long?**| Amount of transfer. |
**targetAccountId** | **double?**| AccountId to send the transfer to, must be a paired account with the user sending the transfer. |
**fromAccountId** | **double?**| AccountID to send the transfer from. Must be paired account with the authenticated user. | [optional]
### Return type
[**Transaction**](Transaction.md)
### Authorization
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)