@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiTradingAccountsModule
Class: AffiliateApiTradingAccountsModule
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiTradingAccountsModule
A module for interacting with the customer trading accounts endpoint of the Affiliate API.
Since
v1.20240429.0
Methods
all
▸ all(options?): Promise<ResponseFields<AffiliateApiTradingAccountsModelDefinition>[]>
List all customer trading accounts matching the specified options via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | Omit<ListTradingAccountOptions, "limit" | "page"> | The options to use when listing all matching customer trading accounts. |
Returns
Promise<ResponseFields<AffiliateApiTradingAccountsModelDefinition>[]>
A list of all matching customer trading accounts.
Throws
AffiliateApiOperationError If the operation was not successful.
Reference
Defined in
src/clients/affiliateApi/tradingAccounts.ts:353
list
▸ list(options?): Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiTradingAccountsModelDefinition>[], ResponseFields<AffiliateApiTradingAccountsModelDefinition>[]>>
List customer trading accounts via the Affiliate API.
Parameters
| Name | Type | Description |
|---|---|---|
options | ListTradingAccountOptions | The options to use when listing customer trading accounts. |
Returns
Promise<AffiliateApiOperationResponse<ResponseFields<AffiliateApiTradingAccountsModelDefinition>[], ResponseFields<AffiliateApiTradingAccountsModelDefinition>[]>>
List of customer trading accounts
Throws
AffiliateApiOperationError If the operation was not successful.
Reference