[generated documentation]
FTXClient > GeneralApi > Subaccounts
FTX subaccount endpoints
ChangeSubaccountNameAsync
https://docs.ftx.com/#change-subaccount-name
Change the name of a sub account
var client = new FTXClient();
var result = await client.GeneralApi.Subaccounts.ChangeSubaccountNameAsync(/* parameters */);
Task<WebCallResult> ChangeSubaccountNameAsync(string oldName, string newName, CancellationToken ct = default);
Parameter | Description |
---|---|
oldName | Old name |
newName | New name |
[Optional] ct | Cancellation token |
CreateSubaccountAsync
https://docs.ftx.com/#create-subaccount
Create a new sub client
var client = new FTXClient();
var result = await client.GeneralApi.Subaccounts.CreateSubaccountAsync(/* parameters */);
Task<WebCallResult<FTXSubaccount>> CreateSubaccountAsync(string nickname, CancellationToken ct = default);
Parameter | Description |
---|---|
nickname | Name of the subaccount |
[Optional] ct | Cancellation token |
DeleteSubaccountAsync
https://docs.ftx.com/#delete-subaccount
Delete a subaccount
var client = new FTXClient();
var result = await client.GeneralApi.Subaccounts.DeleteSubaccountAsync(/* parameters */);
Task<WebCallResult> DeleteSubaccountAsync(string nickname, CancellationToken ct = default);
Parameter | Description |
---|---|
nickname | Nickname of account to delete |
[Optional] ct | Cancellation token |
GetSubaccountBalancesAsync
https://docs.ftx.com/#get-subaccount-balances
Get subaccount balances
var client = new FTXClient();
var result = await client.GeneralApi.Subaccounts.GetSubaccountBalancesAsync(/* parameters */);
Task<WebCallResult<IEnumerable<FTXBalance>>> GetSubaccountBalancesAsync(string nickname, CancellationToken ct = default);
Parameter | Description |
---|---|
nickname | Nickname to get |
[Optional] ct | Cancellation token |
GetSubaccountsAsync
https://docs.ftx.com/#get-all-subaccounts
Get list of sub accounts
var client = new FTXClient();
var result = await client.GeneralApi.Subaccounts.GetSubaccountsAsync();
Task<WebCallResult<IEnumerable<FTXSubaccount>>> GetSubaccountsAsync(CancellationToken ct = default);
Parameter | Description |
---|---|
[Optional] ct | Cancellation token |
TransferAsync
https://docs.ftx.com/#transfer-between-subaccounts
Transfer funds between subaccounts
var client = new FTXClient();
var result = await client.GeneralApi.Subaccounts.TransferAsync(/* parameters */);
Task<WebCallResult<FTXSubaccountTransfer>> TransferAsync(string source, string destination, string asset, decimal quantity, CancellationToken ct = default);
Parameter | Description |
---|---|
source | Name of the source subaccount. Use 'main' for the main account |
destination | Name of the destination subaccount. Use 'main' for the main account |
asset | Asset to move |
quantity | Quantity to move |
[Optional] ct | Cancellation token |