@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / ListTradingAccountOptions
Interface: ListTradingAccountOptions
@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.ListTradingAccountOptions
The options to use when listing customer trading accounts via the Affiliate API.
Since
v1.20240429.0
Hierarchy
ListMethodOptions<AffiliateApiTradingAccountsModelDefinition>↳
ListTradingAccountOptions
Properties
email
• Optional email: string
Defined in
src/clients/affiliateApi/tradingAccounts.ts:305
fields
• Optional fields: keyof AffiliateApiTradingAccountsModelDefinition[]
The fields to return in the response. If not provided, all fields will be returned.
Inherited from
Defined in
src/clients/affiliateApi/utils.ts:563
filter
• Optional filter: Filters<AffiliateApiTradingAccountsModelDefinition>
The filters to apply to the results.
Inherited from
Defined in
src/clients/affiliateApi/utils.ts:567
limit
• Optional limit: number
The maximum number of results to return. Cannot exceed 200.
Inherited from
Defined in
src/clients/affiliateApi/utils.ts:559
page
• Optional page: number
The page number of the results to return.
Inherited from
Defined in
src/clients/affiliateApi/utils.ts:555
sort
• Optional sort: Object
The field and order to sort the results by.
Type declaration
| Name | Type |
|---|---|
asc | undefined |
desc | undefined |
asc: undefined
-
desc: undefined
-