[generated documentation]
FTXClient > TradeApi > Account
FTX account endpoints. Account endpoints include balance info, withdraw/deposit info and requesting and account settings
ChangeAccountLeverageAsync
https://docs.ftx.com/#change-account-leverage
Change account leverage
var client = new FTXClient();
var result = await client.TradeApi.Account.ChangeAccountLeverageAsync(/* parameters */);
Task<WebCallResult> ChangeAccountLeverageAsync(decimal leverage, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| leverage | Desired acccount-wide leverage setting |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
CreateSavedAddressAsync
https://docs.ftx.com/#create-saved-addresses
Create a saved address
var client = new FTXClient();
var result = await client.TradeApi.Account.CreateSavedAddressAsync(/* parameters */);
Task<WebCallResult<FTXSavedAddress>> CreateSavedAddressAsync(string asset, string address, string addressName, bool isPrimeTrust, string? tag = default, string? code = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| asset | Asset the address is for |
| address | The address |
| addressName | Name of the address |
| isPrimeTrust | Is prime trust |
| [Optional] tag | Address tag |
| [Optional] code | 2FA code if needed |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
DeleteSavedAddressAsync
https://docs.ftx.com/#delete-saved-addresses
Delete a saved address
var client = new FTXClient();
var result = await client.TradeApi.Account.DeleteSavedAddressAsync(/* parameters */);
Task<WebCallResult<string>> DeleteSavedAddressAsync(long savedAddressId, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| savedAddressId | Id of the saved address to delete |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetAccountInfoAsync
https://docs.ftx.com/#get-account-information
Get account info
var client = new FTXClient();
var result = await client.TradeApi.Account.GetAccountInfoAsync();
Task<WebCallResult<FTXAccountInfo>> GetAccountInfoAsync(string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetAirdropsAsync
https://docs.ftx.com/#get-airdrops
Get airdrops
var client = new FTXClient();
var result = await client.TradeApi.Account.GetAirdropsAsync();
Task<WebCallResult<IEnumerable<FTXAirdrop>>> GetAirdropsAsync(DateTime? startTime = default, DateTime? endTime = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] startTime | Filter by start time |
| [Optional] endTime | Filter by end time |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetAllAccountBalancesAsync
https://docs.ftx.com/#get-balances-of-all-accounts
Get a list of balances, including master and subaccounts
var client = new FTXClient();
var result = await client.TradeApi.Account.GetAllAccountBalancesAsync();
Task<WebCallResult<Dictionary<string, IEnumerable<FTXBalance>>>> GetAllAccountBalancesAsync(CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] ct | Cancellation token |
GetBalancesAsync
https://docs.ftx.com/#get-balances
Get a list of balances
var client = new FTXClient();
var result = await client.TradeApi.Account.GetBalancesAsync();
Task<WebCallResult<IEnumerable<FTXBalance>>> GetBalancesAsync(string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetDepositAddressAsync
https://docs.ftx.com/#get-deposit-address
Get deposit address for an asset
var client = new FTXClient();
var result = await client.TradeApi.Account.GetDepositAddressAsync(/* parameters */);
Task<WebCallResult<FTXDepositAddress>> GetDepositAddressAsync(string asset, string? network = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| asset | Asset to get address for |
| [Optional] network | The network to use |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetDepositHistoryAsync
https://docs.ftx.com/#get-deposit-history
Get deposit history
var client = new FTXClient();
var result = await client.TradeApi.Account.GetDepositHistoryAsync();
Task<WebCallResult<IEnumerable<FTXDeposit>>> GetDepositHistoryAsync(DateTime? startTime = default, DateTime? endTime = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] startTime | Filter by start time |
| [Optional] endTime | Filter by end time |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetFundingPaymentsAsync
https://docs.ftx.com/#funding-payments
Get list of funding payments
var client = new FTXClient();
var result = await client.TradeApi.Account.GetFundingPaymentsAsync();
Task<WebCallResult<IEnumerable<FTXFundingPayment>>> GetFundingPaymentsAsync(string? future = default, DateTime? startTime = default, DateTime? endTime = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] future | Filter by future |
| [Optional] startTime | Filter by start time |
| [Optional] endTime | Filter by end time |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetLeveragedTokenBalancesAsync
https://docs.ftx.com/#get-leveraged-token-balances
Get token balances
var client = new FTXClient();
var result = await client.TradeApi.Account.GetLeveragedTokenBalancesAsync();
Task<WebCallResult<IEnumerable<FTXLeveragedTokenBalance>>> GetLeveragedTokenBalancesAsync(string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetOptionsAccountInfoAsync
https://docs.ftx.com/#get-account-options-info
Get account options info
var client = new FTXClient();
var result = await client.TradeApi.Account.GetOptionsAccountInfoAsync();
Task<WebCallResult<FTXOptionsAccountInfo>> GetOptionsAccountInfoAsync(string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetOptionsPositionsAsync
https://docs.ftx.com/#get-options-positions
Get options positions
var client = new FTXClient();
var result = await client.TradeApi.Account.GetOptionsPositionsAsync();
Task<WebCallResult<IEnumerable<FTXOptionsPosition>>> GetOptionsPositionsAsync(string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetPositionsAsync
https://docs.ftx.com/#get-positions
Get positions
var client = new FTXClient();
var result = await client.TradeApi.Account.GetPositionsAsync();
Task<WebCallResult<IEnumerable<FTXPosition>>> GetPositionsAsync(bool? showAveragePrice = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] showAveragePrice | |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetSavedAddressesAsync
https://docs.ftx.com/#get-saved-addresses
Get saved addresses
var client = new FTXClient();
var result = await client.TradeApi.Account.GetSavedAddressesAsync();
Task<WebCallResult<IEnumerable<FTXSavedAddress>>> GetSavedAddressesAsync(string? asset = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] asset | Filter by asset |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetWithdrawalFeesAsync
https://docs.ftx.com/#get-withdrawal-fees
Get withdrawal fees
var client = new FTXClient();
var result = await client.TradeApi.Account.GetWithdrawalFeesAsync(/* parameters */);
Task<WebCallResult<FTXWithdrawalFee>> GetWithdrawalFeesAsync(string asset, decimal quantity, string address, string? tag = default, string? network = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| asset | Asset |
| quantity | Quantity |
| address | Address |
| [Optional] tag | Tag |
| [Optional] network | Network to use |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
GetWithdrawalHistoryAsync
https://docs.ftx.com/#get-withdrawal-history
Get withdrawal history
var client = new FTXClient();
var result = await client.TradeApi.Account.GetWithdrawalHistoryAsync();
Task<WebCallResult<IEnumerable<FTXWithdrawal>>> GetWithdrawalHistoryAsync(DateTime? startTime = default, DateTime? endTime = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| [Optional] startTime | Filter by start time |
| [Optional] endTime | Filter by end time |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |
WithdrawAsync
https://docs.ftx.com/#request-withdrawal
Submit a withdraw request
var client = new FTXClient();
var result = await client.TradeApi.Account.WithdrawAsync(/* parameters */);
Task<WebCallResult<FTXWithdrawal>> WithdrawAsync(string asset, decimal quantity, string address, string? tag = default, string? network = default, string? password = default, string? code = default, string? subaccountName = default, CancellationToken ct = default);
| Parameter | Description |
|---|---|
| asset | Asset to withdraw |
| quantity | Quantity to withdraw |
| address | Address to withdraw to |
| [Optional] tag | Address tag |
| [Optional] network | Network to use |
| [Optional] password | Withdrawal password if required |
| [Optional] code | Two factor authentication code if required |
| [Optional] subaccountName | Subaccount name to execute this request for |
| [Optional] ct | Cancellation token |