snaptrade-typescript-sdk 11.0.4 → 12.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -517
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +331 -1841
- package/dist/index.d.cts +243 -868
- package/dist/index.d.mts +243 -868
- package/dist/index.d.ts +243 -868
- package/dist/index.mjs +260 -1757
- package/package.json +1 -1
- package/dist/chunk-e9Ob2GDo.mjs +0 -26
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { n as __require, r as __toESM, t as __commonJSMin } from "./chunk-e9Ob2GDo.mjs";
|
|
2
1
|
import * as _$axios from "axios";
|
|
3
2
|
import { AxiosError, AxiosInstance, AxiosPromise, AxiosRequestConfig } from "axios";
|
|
4
3
|
|
|
@@ -3818,65 +3817,160 @@ interface ComplexOrderResponse {
|
|
|
3818
3817
|
}
|
|
3819
3818
|
type ComplexOrderResponseTypeEnum = 'OCO' | 'OTO' | 'OTOCO';
|
|
3820
3819
|
//#endregion
|
|
3821
|
-
//#region models/
|
|
3820
|
+
//#region models/connection-account-sync-status.d.ts
|
|
3822
3821
|
/**
|
|
3823
|
-
*
|
|
3822
|
+
* Contains status updates for the account sync process between SnapTrade and the brokerage, used only by `Connections_listConnectionAccounts`. Each property is optional -- a brokerage may not report sync status for every data type. `orders`/`positions`/`balances` are the timestamp of the last successful sync of that data type (null if never synced).
|
|
3824
3823
|
* @export
|
|
3825
|
-
* @interface
|
|
3824
|
+
* @interface ConnectionAccountSyncStatus
|
|
3826
3825
|
*/
|
|
3827
|
-
interface
|
|
3826
|
+
interface ConnectionAccountSyncStatus {
|
|
3828
3827
|
[key: string]: any;
|
|
3829
3828
|
/**
|
|
3830
3829
|
*
|
|
3830
|
+
* @type {TransactionsStatus}
|
|
3831
|
+
* @memberof ConnectionAccountSyncStatus
|
|
3832
|
+
*/
|
|
3833
|
+
'transactions'?: TransactionsStatus;
|
|
3834
|
+
/**
|
|
3835
|
+
* The last time orders were successfully synced by SnapTrade.
|
|
3831
3836
|
* @type {string}
|
|
3832
|
-
* @memberof
|
|
3837
|
+
* @memberof ConnectionAccountSyncStatus
|
|
3833
3838
|
*/
|
|
3834
|
-
'
|
|
3839
|
+
'orders'?: string | null;
|
|
3835
3840
|
/**
|
|
3836
|
-
*
|
|
3841
|
+
* The last time positions were successfully synced by SnapTrade.
|
|
3837
3842
|
* @type {string}
|
|
3838
|
-
* @memberof
|
|
3843
|
+
* @memberof ConnectionAccountSyncStatus
|
|
3839
3844
|
*/
|
|
3840
|
-
'
|
|
3845
|
+
'positions'?: string | null;
|
|
3846
|
+
/**
|
|
3847
|
+
* The last time balances were successfully synced by SnapTrade.
|
|
3848
|
+
* @type {string}
|
|
3849
|
+
* @memberof ConnectionAccountSyncStatus
|
|
3850
|
+
*/
|
|
3851
|
+
'balances'?: string | null;
|
|
3852
|
+
}
|
|
3853
|
+
//#endregion
|
|
3854
|
+
//#region models/investment-account-market-value.d.ts
|
|
3855
|
+
/**
|
|
3856
|
+
* Total market value of the account. Null when unknown (e.g. a real-time fetch failed and no cached value exists).
|
|
3857
|
+
* @export
|
|
3858
|
+
* @interface InvestmentAccountMarketValue
|
|
3859
|
+
*/
|
|
3860
|
+
interface InvestmentAccountMarketValue {
|
|
3861
|
+
[key: string]: any;
|
|
3862
|
+
/**
|
|
3863
|
+
*
|
|
3864
|
+
* @type {number}
|
|
3865
|
+
* @memberof InvestmentAccountMarketValue
|
|
3866
|
+
*/
|
|
3867
|
+
'amount'?: number | null;
|
|
3841
3868
|
/**
|
|
3842
3869
|
*
|
|
3843
3870
|
* @type {string}
|
|
3844
|
-
* @memberof
|
|
3871
|
+
* @memberof InvestmentAccountMarketValue
|
|
3845
3872
|
*/
|
|
3846
|
-
'
|
|
3873
|
+
'currency'?: string | null;
|
|
3874
|
+
}
|
|
3875
|
+
//#endregion
|
|
3876
|
+
//#region models/investment-account.d.ts
|
|
3877
|
+
/**
|
|
3878
|
+
* An investment/brokerage account under a connection. `opening_date`, `funding_date`, and `market_value` are real-time or cached depending on the caller\'s plan -- see `Connections_listConnectionAccounts`.
|
|
3879
|
+
* @export
|
|
3880
|
+
* @interface InvestmentAccount
|
|
3881
|
+
*/
|
|
3882
|
+
interface InvestmentAccount {
|
|
3883
|
+
[key: string]: any;
|
|
3847
3884
|
/**
|
|
3848
|
-
*
|
|
3885
|
+
* Discriminator for the account kind.
|
|
3849
3886
|
* @type {string}
|
|
3850
|
-
* @memberof
|
|
3887
|
+
* @memberof InvestmentAccount
|
|
3851
3888
|
*/
|
|
3852
|
-
'
|
|
3889
|
+
'kind': InvestmentAccountKindEnum;
|
|
3853
3890
|
/**
|
|
3854
|
-
*
|
|
3891
|
+
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
3855
3892
|
* @type {string}
|
|
3856
|
-
* @memberof
|
|
3893
|
+
* @memberof InvestmentAccount
|
|
3857
3894
|
*/
|
|
3858
|
-
'
|
|
3895
|
+
'id': string;
|
|
3859
3896
|
/**
|
|
3860
|
-
*
|
|
3861
|
-
* @type {
|
|
3862
|
-
* @memberof
|
|
3897
|
+
* Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
|
|
3898
|
+
* @type {string}
|
|
3899
|
+
* @memberof InvestmentAccount
|
|
3863
3900
|
*/
|
|
3864
|
-
'
|
|
3901
|
+
'connection_id': string;
|
|
3902
|
+
/**
|
|
3903
|
+
* A display name for the account. Either assigned by the user or by the brokerage itself.
|
|
3904
|
+
* @type {string}
|
|
3905
|
+
* @memberof InvestmentAccount
|
|
3906
|
+
*/
|
|
3907
|
+
'display_name'?: string | null;
|
|
3908
|
+
/**
|
|
3909
|
+
* The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
|
|
3910
|
+
* @type {string}
|
|
3911
|
+
* @memberof InvestmentAccount
|
|
3912
|
+
*/
|
|
3913
|
+
'number': string;
|
|
3914
|
+
/**
|
|
3915
|
+
* A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
|
|
3916
|
+
* @type {string}
|
|
3917
|
+
* @memberof InvestmentAccount
|
|
3918
|
+
*/
|
|
3919
|
+
'institution_account_id'?: string | null;
|
|
3920
|
+
/**
|
|
3921
|
+
* Unique identifier for the institution (brokerage) that holds the account.
|
|
3922
|
+
* @type {string}
|
|
3923
|
+
* @memberof InvestmentAccount
|
|
3924
|
+
*/
|
|
3925
|
+
'institution_id'?: string;
|
|
3926
|
+
/**
|
|
3927
|
+
* Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was opened at the brokerage.
|
|
3928
|
+
* @type {string}
|
|
3929
|
+
* @memberof InvestmentAccount
|
|
3930
|
+
*/
|
|
3931
|
+
'opening_date'?: string | null;
|
|
3865
3932
|
/**
|
|
3866
3933
|
*
|
|
3934
|
+
* @type {ConnectionAccountSyncStatus}
|
|
3935
|
+
* @memberof InvestmentAccount
|
|
3936
|
+
*/
|
|
3937
|
+
'sync_status': ConnectionAccountSyncStatus;
|
|
3938
|
+
/**
|
|
3939
|
+
* The account type as provided by the brokerage.
|
|
3867
3940
|
* @type {string}
|
|
3868
|
-
* @memberof
|
|
3941
|
+
* @memberof InvestmentAccount
|
|
3869
3942
|
*/
|
|
3870
|
-
'
|
|
3943
|
+
'raw_type'?: string | null;
|
|
3944
|
+
/**
|
|
3945
|
+
* Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was funded.
|
|
3946
|
+
* @type {string}
|
|
3947
|
+
* @memberof InvestmentAccount
|
|
3948
|
+
*/
|
|
3949
|
+
'funding_date'?: string | null;
|
|
3950
|
+
/**
|
|
3951
|
+
* Indicates whether the account is a paper (simulated) trading account.
|
|
3952
|
+
* @type {boolean}
|
|
3953
|
+
* @memberof InvestmentAccount
|
|
3954
|
+
*/
|
|
3955
|
+
'is_paper': boolean;
|
|
3956
|
+
/**
|
|
3957
|
+
*
|
|
3958
|
+
* @type {InvestmentAccountMarketValue}
|
|
3959
|
+
* @memberof InvestmentAccount
|
|
3960
|
+
*/
|
|
3961
|
+
'market_value'?: InvestmentAccountMarketValue | null;
|
|
3871
3962
|
}
|
|
3872
|
-
type
|
|
3963
|
+
type InvestmentAccountKindEnum = 'investment';
|
|
3873
3964
|
//#endregion
|
|
3874
|
-
//#region models/
|
|
3965
|
+
//#region models/connection-account.d.ts
|
|
3875
3966
|
/**
|
|
3876
|
-
* @type
|
|
3967
|
+
* @type ConnectionAccount
|
|
3968
|
+
* A single account under a connection, from the `kind`-discriminated union used by `Connections_listConnectionAccounts`. Use `kind` to determine which schema is present. Only `investment` is implemented today; `deposit` and `line_of_credit` will be added as additional variants in a future release.
|
|
3877
3969
|
* @export
|
|
3878
3970
|
*/
|
|
3879
|
-
type
|
|
3971
|
+
type ConnectionAccount = {
|
|
3972
|
+
kind: 'investment';
|
|
3973
|
+
} & InvestmentAccount;
|
|
3880
3974
|
//#endregion
|
|
3881
3975
|
//#region models/crypto-trading-instrument.d.ts
|
|
3882
3976
|
/**
|
|
@@ -4585,6 +4679,7 @@ interface TakeProfit {
|
|
|
4585
4679
|
* @interface ManualTradeFormBracket
|
|
4586
4680
|
*/
|
|
4587
4681
|
interface ManualTradeFormBracket {
|
|
4682
|
+
[key: string]: any;
|
|
4588
4683
|
/**
|
|
4589
4684
|
* The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
|
|
4590
4685
|
* @type {ActionStrictWithOptions}
|
|
@@ -6190,6 +6285,59 @@ interface RecentOrdersResponse {
|
|
|
6190
6285
|
'orders'?: Array<AccountOrderRecord>;
|
|
6191
6286
|
}
|
|
6192
6287
|
//#endregion
|
|
6288
|
+
//#region models/session-event.d.ts
|
|
6289
|
+
/**
|
|
6290
|
+
*
|
|
6291
|
+
* @export
|
|
6292
|
+
* @interface SessionEvent
|
|
6293
|
+
*/
|
|
6294
|
+
interface SessionEvent {
|
|
6295
|
+
[key: string]: any;
|
|
6296
|
+
/**
|
|
6297
|
+
*
|
|
6298
|
+
* @type {string}
|
|
6299
|
+
* @memberof SessionEvent
|
|
6300
|
+
*/
|
|
6301
|
+
'id'?: string;
|
|
6302
|
+
/**
|
|
6303
|
+
*
|
|
6304
|
+
* @type {string}
|
|
6305
|
+
* @memberof SessionEvent
|
|
6306
|
+
*/
|
|
6307
|
+
'session_event_type'?: SessionEventSessionEventTypeEnum;
|
|
6308
|
+
/**
|
|
6309
|
+
*
|
|
6310
|
+
* @type {string}
|
|
6311
|
+
* @memberof SessionEvent
|
|
6312
|
+
*/
|
|
6313
|
+
'session_id'?: string;
|
|
6314
|
+
/**
|
|
6315
|
+
* SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
|
|
6316
|
+
* @type {string}
|
|
6317
|
+
* @memberof SessionEvent
|
|
6318
|
+
*/
|
|
6319
|
+
'user_id'?: string;
|
|
6320
|
+
/**
|
|
6321
|
+
* Time
|
|
6322
|
+
* @type {string}
|
|
6323
|
+
* @memberof SessionEvent
|
|
6324
|
+
*/
|
|
6325
|
+
'created_date'?: string;
|
|
6326
|
+
/**
|
|
6327
|
+
*
|
|
6328
|
+
* @type {number}
|
|
6329
|
+
* @memberof SessionEvent
|
|
6330
|
+
*/
|
|
6331
|
+
'brokerage_status_code'?: number | null;
|
|
6332
|
+
/**
|
|
6333
|
+
*
|
|
6334
|
+
* @type {string}
|
|
6335
|
+
* @memberof SessionEvent
|
|
6336
|
+
*/
|
|
6337
|
+
'brokerage_authorization_id'?: string;
|
|
6338
|
+
}
|
|
6339
|
+
type SessionEventSessionEventTypeEnum = 'OAUTH_REDIRECT' | 'DISCLAIMER_ACCEPTED' | 'BROKERAGE_CONNECTION_INITIATED' | 'BROKERAGE_RECONNECT_INITIATED' | 'BROKERAGE_AUTHENTICATION' | 'OAUTH_BROKERAGE_AUTHENTICATION' | 'MFA_REQUESTED' | 'MFA_SUBMITTED' | 'MFA_CHOICE_REQUESTED' | 'MFA_CHOICE_SUBMITTED' | 'CONNECTION_SUCCESSFUL' | 'CONNECTION_FAILED' | 'PARTNER_REDIRECT' | 'CONNECTION_ABORTED' | 'SESSION_STARTED';
|
|
6340
|
+
//#endregion
|
|
6193
6341
|
//#region models/simple-order-form.d.ts
|
|
6194
6342
|
/**
|
|
6195
6343
|
*
|
|
@@ -6527,7 +6675,7 @@ interface StrategyQuotes {
|
|
|
6527
6675
|
* @export
|
|
6528
6676
|
* @interface Symbol
|
|
6529
6677
|
*/
|
|
6530
|
-
interface Symbol
|
|
6678
|
+
interface Symbol {
|
|
6531
6679
|
[key: string]: any;
|
|
6532
6680
|
/**
|
|
6533
6681
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
@@ -7023,17 +7171,6 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7023
7171
|
* @throws {RequiredError}
|
|
7024
7172
|
*/
|
|
7025
7173
|
getAllAccountPositions: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7026
|
-
/**
|
|
7027
|
-
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7028
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7029
|
-
* @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
7030
|
-
* @param {string} [userId]
|
|
7031
|
-
* @param {string} [userSecret]
|
|
7032
|
-
* @param {*} [options] Override http request option.
|
|
7033
|
-
* @deprecated
|
|
7034
|
-
* @throws {RequiredError}
|
|
7035
|
-
*/
|
|
7036
|
-
getAllUserHoldings: (brokerageAuthorizations?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7037
7174
|
/**
|
|
7038
7175
|
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7039
7176
|
* @summary List account balances
|
|
@@ -7077,17 +7214,6 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7077
7214
|
* @throws {RequiredError}
|
|
7078
7215
|
*/
|
|
7079
7216
|
getUserAccountOrders: (accountId: string, state?: "all" | "open" | "executed", days?: number, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7080
|
-
/**
|
|
7081
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7082
|
-
* @summary List account positions
|
|
7083
|
-
* @param {string} accountId
|
|
7084
|
-
* @param {string} [userId]
|
|
7085
|
-
* @param {string} [userSecret]
|
|
7086
|
-
* @param {*} [options] Override http request option.
|
|
7087
|
-
* @deprecated
|
|
7088
|
-
* @throws {RequiredError}
|
|
7089
|
-
*/
|
|
7090
|
-
getUserAccountPositions: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7091
7217
|
/**
|
|
7092
7218
|
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
7093
7219
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -7170,15 +7296,6 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7170
7296
|
* @throws {RequiredError}
|
|
7171
7297
|
*/
|
|
7172
7298
|
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllAccountPositionsResponse>>;
|
|
7173
|
-
/**
|
|
7174
|
-
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7175
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7176
|
-
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7177
|
-
* @param {*} [options] Override http request option.
|
|
7178
|
-
* @deprecated
|
|
7179
|
-
* @throws {RequiredError}
|
|
7180
|
-
*/
|
|
7181
|
-
getAllUserHoldings(requestParameters?: AccountInformationApiGetAllUserHoldingsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
|
|
7182
7299
|
/**
|
|
7183
7300
|
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7184
7301
|
* @summary List account balances
|
|
@@ -7211,15 +7328,6 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7211
7328
|
* @throws {RequiredError}
|
|
7212
7329
|
*/
|
|
7213
7330
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
7214
|
-
/**
|
|
7215
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7216
|
-
* @summary List account positions
|
|
7217
|
-
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7218
|
-
* @param {*} [options] Override http request option.
|
|
7219
|
-
* @deprecated
|
|
7220
|
-
* @throws {RequiredError}
|
|
7221
|
-
*/
|
|
7222
|
-
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
|
|
7223
7331
|
/**
|
|
7224
7332
|
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
7225
7333
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -7291,15 +7399,6 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7291
7399
|
* @throws {RequiredError}
|
|
7292
7400
|
*/
|
|
7293
7401
|
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AllAccountPositionsResponse>;
|
|
7294
|
-
/**
|
|
7295
|
-
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7296
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7297
|
-
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7298
|
-
* @param {*} [options] Override http request option.
|
|
7299
|
-
* @deprecated
|
|
7300
|
-
* @throws {RequiredError}
|
|
7301
|
-
*/
|
|
7302
|
-
getAllUserHoldings(requestParameters?: AccountInformationApiGetAllUserHoldingsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
|
|
7303
7402
|
/**
|
|
7304
7403
|
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7305
7404
|
* @summary List account balances
|
|
@@ -7332,15 +7431,6 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7332
7431
|
* @throws {RequiredError}
|
|
7333
7432
|
*/
|
|
7334
7433
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
7335
|
-
/**
|
|
7336
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7337
|
-
* @summary List account positions
|
|
7338
|
-
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7339
|
-
* @param {*} [options] Override http request option.
|
|
7340
|
-
* @deprecated
|
|
7341
|
-
* @throws {RequiredError}
|
|
7342
|
-
*/
|
|
7343
|
-
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
|
|
7344
7434
|
/**
|
|
7345
7435
|
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
7346
7436
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -7488,31 +7578,6 @@ type AccountInformationApiGetAllAccountPositionsRequestByAuthMode = {
|
|
|
7488
7578
|
"personalApiKey": AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest;
|
|
7489
7579
|
};
|
|
7490
7580
|
type AccountInformationApiGetAllAccountPositionsRequest<TAuth extends AuthMode> = AccountInformationApiGetAllAccountPositionsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetAllAccountPositionsRequestByAuthMode];
|
|
7491
|
-
/**
|
|
7492
|
-
* Request parameters for getAllUserHoldings operation in AccountInformationApi.
|
|
7493
|
-
* @export
|
|
7494
|
-
*/
|
|
7495
|
-
type AccountInformationApiGetAllUserHoldingsBaseRequest = {
|
|
7496
|
-
/**
|
|
7497
|
-
* Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
7498
|
-
* @type {string}
|
|
7499
|
-
* @memberof AccountInformationApiGetAllUserHoldings
|
|
7500
|
-
*/
|
|
7501
|
-
readonly brokerageAuthorizations?: string;
|
|
7502
|
-
};
|
|
7503
|
-
type AccountInformationApiGetAllUserHoldingscommercialApiKeyRequest = AccountInformationApiGetAllUserHoldingsBaseRequest & {
|
|
7504
|
-
readonly userId: string;
|
|
7505
|
-
readonly userSecret: string;
|
|
7506
|
-
};
|
|
7507
|
-
type AccountInformationApiGetAllUserHoldingspersonalApiKeyRequest = AccountInformationApiGetAllUserHoldingsBaseRequest & {
|
|
7508
|
-
readonly userId?: never;
|
|
7509
|
-
readonly userSecret?: never;
|
|
7510
|
-
};
|
|
7511
|
-
type AccountInformationApiGetAllUserHoldingsRequestByAuthMode = {
|
|
7512
|
-
"commercialApiKey": AccountInformationApiGetAllUserHoldingscommercialApiKeyRequest;
|
|
7513
|
-
"personalApiKey": AccountInformationApiGetAllUserHoldingspersonalApiKeyRequest;
|
|
7514
|
-
};
|
|
7515
|
-
type AccountInformationApiGetAllUserHoldingsRequest<TAuth extends AuthMode> = AccountInformationApiGetAllUserHoldingsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetAllUserHoldingsRequestByAuthMode];
|
|
7516
7581
|
/**
|
|
7517
7582
|
* Request parameters for getUserAccountBalance operation in AccountInformationApi.
|
|
7518
7583
|
* @export
|
|
@@ -7625,31 +7690,6 @@ type AccountInformationApiGetUserAccountOrdersRequestByAuthMode = {
|
|
|
7625
7690
|
"personalApiKey": AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest;
|
|
7626
7691
|
};
|
|
7627
7692
|
type AccountInformationApiGetUserAccountOrdersRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountOrdersRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountOrdersRequestByAuthMode];
|
|
7628
|
-
/**
|
|
7629
|
-
* Request parameters for getUserAccountPositions operation in AccountInformationApi.
|
|
7630
|
-
* @export
|
|
7631
|
-
*/
|
|
7632
|
-
type AccountInformationApiGetUserAccountPositionsBaseRequest = {
|
|
7633
|
-
/**
|
|
7634
|
-
*
|
|
7635
|
-
* @type {string}
|
|
7636
|
-
* @memberof AccountInformationApiGetUserAccountPositions
|
|
7637
|
-
*/
|
|
7638
|
-
readonly accountId: string;
|
|
7639
|
-
};
|
|
7640
|
-
type AccountInformationApiGetUserAccountPositionscommercialApiKeyRequest = AccountInformationApiGetUserAccountPositionsBaseRequest & {
|
|
7641
|
-
readonly userId: string;
|
|
7642
|
-
readonly userSecret: string;
|
|
7643
|
-
};
|
|
7644
|
-
type AccountInformationApiGetUserAccountPositionspersonalApiKeyRequest = AccountInformationApiGetUserAccountPositionsBaseRequest & {
|
|
7645
|
-
readonly userId?: never;
|
|
7646
|
-
readonly userSecret?: never;
|
|
7647
|
-
};
|
|
7648
|
-
type AccountInformationApiGetUserAccountPositionsRequestByAuthMode = {
|
|
7649
|
-
"commercialApiKey": AccountInformationApiGetUserAccountPositionscommercialApiKeyRequest;
|
|
7650
|
-
"personalApiKey": AccountInformationApiGetUserAccountPositionspersonalApiKeyRequest;
|
|
7651
|
-
};
|
|
7652
|
-
type AccountInformationApiGetUserAccountPositionsRequest<TAuth extends AuthMode> = AccountInformationApiGetUserAccountPositionsRequestByAuthMode[TAuth["mode"] & keyof AccountInformationApiGetUserAccountPositionsRequestByAuthMode];
|
|
7653
7693
|
/**
|
|
7654
7694
|
* Request parameters for getUserAccountRecentOrders operation in AccountInformationApi.
|
|
7655
7695
|
* @export
|
|
@@ -7814,16 +7854,6 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7814
7854
|
* @memberof AccountInformationApiGenerated
|
|
7815
7855
|
*/
|
|
7816
7856
|
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AllAccountPositionsResponse, any, {}>>;
|
|
7817
|
-
/**
|
|
7818
|
-
* **Deprecated.** Use the account-specific holdings endpoint instead. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7819
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
7820
|
-
* @param {AccountInformationApiGetAllUserHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
7821
|
-
* @param {*} [options] Override http request option.
|
|
7822
|
-
* @deprecated
|
|
7823
|
-
* @throws {RequiredError}
|
|
7824
|
-
* @memberof AccountInformationApiGenerated
|
|
7825
|
-
*/
|
|
7826
|
-
getAllUserHoldings(requestParameters?: AccountInformationApiGetAllUserHoldingsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountHoldings[], any, {}>>;
|
|
7827
7857
|
/**
|
|
7828
7858
|
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7829
7859
|
* @summary List account balances
|
|
@@ -7860,16 +7890,6 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
7860
7890
|
* @memberof AccountInformationApiGenerated
|
|
7861
7891
|
*/
|
|
7862
7892
|
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountOrderRecord[], any, {}>>;
|
|
7863
|
-
/**
|
|
7864
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
7865
|
-
* @summary List account positions
|
|
7866
|
-
* @param {AccountInformationApiGetUserAccountPositionsRequest<TAuth>} requestParameters Request parameters.
|
|
7867
|
-
* @param {*} [options] Override http request option.
|
|
7868
|
-
* @deprecated
|
|
7869
|
-
* @throws {RequiredError}
|
|
7870
|
-
* @memberof AccountInformationApiGenerated
|
|
7871
|
-
*/
|
|
7872
|
-
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<Position[], any, {}>>;
|
|
7873
7893
|
/**
|
|
7874
7894
|
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
7875
7895
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8224,6 +8244,8 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
8224
8244
|
//#endregion
|
|
8225
8245
|
//#region api/authentication-api.d.ts
|
|
8226
8246
|
declare class AuthenticationApi<TAuth extends AuthMode> extends AuthenticationApiGenerated<TAuth> {}
|
|
8247
|
+
//#endregion
|
|
8248
|
+
//#region api/connections-api-generated.d.ts
|
|
8227
8249
|
/**
|
|
8228
8250
|
* ConnectionsApi - axios parameter creator
|
|
8229
8251
|
* @export
|
|
@@ -8288,16 +8310,6 @@ declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration<Au
|
|
|
8288
8310
|
* @throws {RequiredError}
|
|
8289
8311
|
*/
|
|
8290
8312
|
refreshBrokerageAuthorization: (authorizationId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8291
|
-
/**
|
|
8292
|
-
* Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
8293
|
-
* @summary Delete connection
|
|
8294
|
-
* @param {string} authorizationId
|
|
8295
|
-
* @param {string} [userId]
|
|
8296
|
-
* @param {string} [userSecret]
|
|
8297
|
-
* @param {*} [options] Override http request option.
|
|
8298
|
-
* @throws {RequiredError}
|
|
8299
|
-
*/
|
|
8300
|
-
removeBrokerageAuthorization: (authorizationId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8301
8313
|
/**
|
|
8302
8314
|
* Returns a list of rate of return percents for a given connection.
|
|
8303
8315
|
* @summary List connection rate of returns
|
|
@@ -8309,16 +8321,6 @@ declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration<Au
|
|
|
8309
8321
|
* @throws {RequiredError}
|
|
8310
8322
|
*/
|
|
8311
8323
|
returnRates: (authorizationId: string, timeframes?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8312
|
-
/**
|
|
8313
|
-
* Returns a list of session events associated with a user.
|
|
8314
|
-
* @summary Get all session events for a user
|
|
8315
|
-
* @param {string} partnerClientId
|
|
8316
|
-
* @param {string} [userId] Optional comma separated list of user IDs used to filter the request on specific users
|
|
8317
|
-
* @param {string} [sessionId] Optional comma separated list of session IDs used to filter the request on specific users
|
|
8318
|
-
* @param {*} [options] Override http request option.
|
|
8319
|
-
* @throws {RequiredError}
|
|
8320
|
-
*/
|
|
8321
|
-
sessionEvents: (partnerClientId: string, userId?: string, sessionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8322
8324
|
/**
|
|
8323
8325
|
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
8324
8326
|
* @summary Sync transactions for a connection
|
|
@@ -8383,14 +8385,6 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8383
8385
|
* @throws {RequiredError}
|
|
8384
8386
|
*/
|
|
8385
8387
|
refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationRefreshConfirmation>>;
|
|
8386
|
-
/**
|
|
8387
|
-
* Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
8388
|
-
* @summary Delete connection
|
|
8389
|
-
* @param {ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth>} requestParameters Request parameters.
|
|
8390
|
-
* @param {*} [options] Override http request option.
|
|
8391
|
-
* @throws {RequiredError}
|
|
8392
|
-
*/
|
|
8393
|
-
removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8394
8388
|
/**
|
|
8395
8389
|
* Returns a list of rate of return percents for a given connection.
|
|
8396
8390
|
* @summary List connection rate of returns
|
|
@@ -8399,14 +8393,6 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
8399
8393
|
* @throws {RequiredError}
|
|
8400
8394
|
*/
|
|
8401
8395
|
returnRates(requestParameters: ConnectionsApiReturnRatesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
8402
|
-
/**
|
|
8403
|
-
* Returns a list of session events associated with a user.
|
|
8404
|
-
* @summary Get all session events for a user
|
|
8405
|
-
* @param {ConnectionsApiSessionEventsRequest<TAuth>} requestParameters Request parameters.
|
|
8406
|
-
* @param {*} [options] Override http request option.
|
|
8407
|
-
* @throws {RequiredError}
|
|
8408
|
-
*/
|
|
8409
|
-
sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>>;
|
|
8410
8396
|
/**
|
|
8411
8397
|
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
8412
8398
|
* @summary Sync transactions for a connection
|
|
@@ -8469,14 +8455,6 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8469
8455
|
* @throws {RequiredError}
|
|
8470
8456
|
*/
|
|
8471
8457
|
refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationRefreshConfirmation>;
|
|
8472
|
-
/**
|
|
8473
|
-
* Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
8474
|
-
* @summary Delete connection
|
|
8475
|
-
* @param {ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth>} requestParameters Request parameters.
|
|
8476
|
-
* @param {*} [options] Override http request option.
|
|
8477
|
-
* @throws {RequiredError}
|
|
8478
|
-
*/
|
|
8479
|
-
removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
8480
8458
|
/**
|
|
8481
8459
|
* Returns a list of rate of return percents for a given connection.
|
|
8482
8460
|
* @summary List connection rate of returns
|
|
@@ -8485,14 +8463,6 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
8485
8463
|
* @throws {RequiredError}
|
|
8486
8464
|
*/
|
|
8487
8465
|
returnRates(requestParameters: ConnectionsApiReturnRatesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
|
|
8488
|
-
/**
|
|
8489
|
-
* Returns a list of session events associated with a user.
|
|
8490
|
-
* @summary Get all session events for a user
|
|
8491
|
-
* @param {ConnectionsApiSessionEventsRequest<TAuth>} requestParameters Request parameters.
|
|
8492
|
-
* @param {*} [options] Override http request option.
|
|
8493
|
-
* @throws {RequiredError}
|
|
8494
|
-
*/
|
|
8495
|
-
sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>;
|
|
8496
8466
|
/**
|
|
8497
8467
|
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
8498
8468
|
* @summary Sync transactions for a connection
|
|
@@ -8646,39 +8616,14 @@ type ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode = {
|
|
|
8646
8616
|
};
|
|
8647
8617
|
type ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth extends AuthMode> = ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode];
|
|
8648
8618
|
/**
|
|
8649
|
-
* Request parameters for
|
|
8619
|
+
* Request parameters for returnRates operation in ConnectionsApi.
|
|
8650
8620
|
* @export
|
|
8651
8621
|
*/
|
|
8652
|
-
type
|
|
8622
|
+
type ConnectionsApiReturnRatesBaseRequest = {
|
|
8653
8623
|
/**
|
|
8654
8624
|
*
|
|
8655
8625
|
* @type {string}
|
|
8656
|
-
* @memberof
|
|
8657
|
-
*/
|
|
8658
|
-
readonly authorizationId: string;
|
|
8659
|
-
};
|
|
8660
|
-
type ConnectionsApiRemoveBrokerageAuthorizationcommercialApiKeyRequest = ConnectionsApiRemoveBrokerageAuthorizationBaseRequest & {
|
|
8661
|
-
readonly userId: string;
|
|
8662
|
-
readonly userSecret: string;
|
|
8663
|
-
};
|
|
8664
|
-
type ConnectionsApiRemoveBrokerageAuthorizationpersonalApiKeyRequest = ConnectionsApiRemoveBrokerageAuthorizationBaseRequest & {
|
|
8665
|
-
readonly userId?: never;
|
|
8666
|
-
readonly userSecret?: never;
|
|
8667
|
-
};
|
|
8668
|
-
type ConnectionsApiRemoveBrokerageAuthorizationRequestByAuthMode = {
|
|
8669
|
-
"commercialApiKey": ConnectionsApiRemoveBrokerageAuthorizationcommercialApiKeyRequest;
|
|
8670
|
-
"personalApiKey": ConnectionsApiRemoveBrokerageAuthorizationpersonalApiKeyRequest;
|
|
8671
|
-
};
|
|
8672
|
-
type ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth extends AuthMode> = ConnectionsApiRemoveBrokerageAuthorizationRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiRemoveBrokerageAuthorizationRequestByAuthMode];
|
|
8673
|
-
/**
|
|
8674
|
-
* Request parameters for returnRates operation in ConnectionsApi.
|
|
8675
|
-
* @export
|
|
8676
|
-
*/
|
|
8677
|
-
type ConnectionsApiReturnRatesBaseRequest = {
|
|
8678
|
-
/**
|
|
8679
|
-
*
|
|
8680
|
-
* @type {string}
|
|
8681
|
-
* @memberof ConnectionsApiReturnRates
|
|
8626
|
+
* @memberof ConnectionsApiReturnRates
|
|
8682
8627
|
*/
|
|
8683
8628
|
readonly authorizationId: string;
|
|
8684
8629
|
/**
|
|
@@ -8701,37 +8646,6 @@ type ConnectionsApiReturnRatesRequestByAuthMode = {
|
|
|
8701
8646
|
"personalApiKey": ConnectionsApiReturnRatespersonalApiKeyRequest;
|
|
8702
8647
|
};
|
|
8703
8648
|
type ConnectionsApiReturnRatesRequest<TAuth extends AuthMode> = ConnectionsApiReturnRatesRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiReturnRatesRequestByAuthMode];
|
|
8704
|
-
/**
|
|
8705
|
-
* Request parameters for sessionEvents operation in ConnectionsApi.
|
|
8706
|
-
* @export
|
|
8707
|
-
*/
|
|
8708
|
-
type ConnectionsApiSessionEventsBaseRequest = {
|
|
8709
|
-
/**
|
|
8710
|
-
*
|
|
8711
|
-
* @type {string}
|
|
8712
|
-
* @memberof ConnectionsApiSessionEvents
|
|
8713
|
-
*/
|
|
8714
|
-
readonly partnerClientId: string;
|
|
8715
|
-
/**
|
|
8716
|
-
* Optional comma separated list of user IDs used to filter the request on specific users
|
|
8717
|
-
* @type {string}
|
|
8718
|
-
* @memberof ConnectionsApiSessionEvents
|
|
8719
|
-
*/
|
|
8720
|
-
readonly userId?: string;
|
|
8721
|
-
/**
|
|
8722
|
-
* Optional comma separated list of session IDs used to filter the request on specific users
|
|
8723
|
-
* @type {string}
|
|
8724
|
-
* @memberof ConnectionsApiSessionEvents
|
|
8725
|
-
*/
|
|
8726
|
-
readonly sessionId?: string;
|
|
8727
|
-
};
|
|
8728
|
-
type ConnectionsApiSessionEventscommercialApiKeyRequest = ConnectionsApiSessionEventsBaseRequest & {};
|
|
8729
|
-
type ConnectionsApiSessionEventspersonalApiKeyRequest = ConnectionsApiSessionEventsBaseRequest & {};
|
|
8730
|
-
type ConnectionsApiSessionEventsRequestByAuthMode = {
|
|
8731
|
-
"commercialApiKey": ConnectionsApiSessionEventscommercialApiKeyRequest;
|
|
8732
|
-
"personalApiKey": ConnectionsApiSessionEventspersonalApiKeyRequest;
|
|
8733
|
-
};
|
|
8734
|
-
type ConnectionsApiSessionEventsRequest<TAuth extends AuthMode> = ConnectionsApiSessionEventsRequestByAuthMode[TAuth["mode"] & keyof ConnectionsApiSessionEventsRequestByAuthMode];
|
|
8735
8649
|
/**
|
|
8736
8650
|
* Request parameters for syncBrokerageAuthorizationTransactions operation in ConnectionsApi.
|
|
8737
8651
|
* @export
|
|
@@ -8818,15 +8732,6 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
8818
8732
|
* @memberof ConnectionsApiGenerated
|
|
8819
8733
|
*/
|
|
8820
8734
|
refreshBrokerageAuthorization(requestParameters: ConnectionsApiRefreshBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<BrokerageAuthorizationRefreshConfirmation, any, {}>>;
|
|
8821
|
-
/**
|
|
8822
|
-
* Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is synchronous, a 204 response indicates that the data has been successfully deleted.
|
|
8823
|
-
* @summary Delete connection
|
|
8824
|
-
* @param {ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth>} requestParameters Request parameters.
|
|
8825
|
-
* @param {*} [options] Override http request option.
|
|
8826
|
-
* @throws {RequiredError}
|
|
8827
|
-
* @memberof ConnectionsApiGenerated
|
|
8828
|
-
*/
|
|
8829
|
-
removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8830
8735
|
/**
|
|
8831
8736
|
* Returns a list of rate of return percents for a given connection.
|
|
8832
8737
|
* @summary List connection rate of returns
|
|
@@ -8836,15 +8741,6 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
8836
8741
|
* @memberof ConnectionsApiGenerated
|
|
8837
8742
|
*/
|
|
8838
8743
|
returnRates(requestParameters: ConnectionsApiReturnRatesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
8839
|
-
/**
|
|
8840
|
-
* Returns a list of session events associated with a user.
|
|
8841
|
-
* @summary Get all session events for a user
|
|
8842
|
-
* @param {ConnectionsApiSessionEventsRequest<TAuth>} requestParameters Request parameters.
|
|
8843
|
-
* @param {*} [options] Override http request option.
|
|
8844
|
-
* @throws {RequiredError}
|
|
8845
|
-
* @memberof ConnectionsApiGenerated
|
|
8846
|
-
*/
|
|
8847
|
-
sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<import_dist.SessionEvent[], any, {}>>;
|
|
8848
8744
|
/**
|
|
8849
8745
|
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
8850
8746
|
* @summary Sync transactions for a connection
|
|
@@ -8917,6 +8813,16 @@ declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?: Config
|
|
|
8917
8813
|
* @throws {RequiredError}
|
|
8918
8814
|
*/
|
|
8919
8815
|
getUserAccountRecentOrdersV2: (accountId: string, onlyExecuted?: boolean, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8816
|
+
/**
|
|
8817
|
+
* Experimental and subject to change without notice. Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape. Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
8818
|
+
* @summary List accounts for a connection (discriminated union)
|
|
8819
|
+
* @param {string} authorizationId
|
|
8820
|
+
* @param {string} [userId]
|
|
8821
|
+
* @param {string} [userSecret]
|
|
8822
|
+
* @param {*} [options] Override http request option.
|
|
8823
|
+
* @throws {RequiredError}
|
|
8824
|
+
*/
|
|
8825
|
+
listConnectionAccounts: (authorizationId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8920
8826
|
/**
|
|
8921
8827
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
8922
8828
|
* @summary List active Trade Detection subscriptions
|
|
@@ -8970,6 +8876,14 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
8970
8876
|
* @throws {RequiredError}
|
|
8971
8877
|
*/
|
|
8972
8878
|
getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
|
|
8879
|
+
/**
|
|
8880
|
+
* Experimental and subject to change without notice. Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape. Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
8881
|
+
* @summary List accounts for a connection (discriminated union)
|
|
8882
|
+
* @param {ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>} requestParameters Request parameters.
|
|
8883
|
+
* @param {*} [options] Override http request option.
|
|
8884
|
+
* @throws {RequiredError}
|
|
8885
|
+
*/
|
|
8886
|
+
listConnectionAccounts(requestParameters: ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionAccount>>>;
|
|
8973
8887
|
/**
|
|
8974
8888
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
8975
8889
|
* @summary List active Trade Detection subscriptions
|
|
@@ -9023,6 +8937,14 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9023
8937
|
* @throws {RequiredError}
|
|
9024
8938
|
*/
|
|
9025
8939
|
getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AccountOrdersV2Response>;
|
|
8940
|
+
/**
|
|
8941
|
+
* Experimental and subject to change without notice. Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape. Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
8942
|
+
* @summary List accounts for a connection (discriminated union)
|
|
8943
|
+
* @param {ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>} requestParameters Request parameters.
|
|
8944
|
+
* @param {*} [options] Override http request option.
|
|
8945
|
+
* @throws {RequiredError}
|
|
8946
|
+
*/
|
|
8947
|
+
listConnectionAccounts(requestParameters: ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionAccount>>;
|
|
9026
8948
|
/**
|
|
9027
8949
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9028
8950
|
* @summary List active Trade Detection subscriptions
|
|
@@ -9160,6 +9082,31 @@ type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode = {
|
|
|
9160
9082
|
"personalApiKey": ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest;
|
|
9161
9083
|
};
|
|
9162
9084
|
type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth extends AuthMode> = ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode];
|
|
9085
|
+
/**
|
|
9086
|
+
* Request parameters for listConnectionAccounts operation in ExperimentalEndpointsApi.
|
|
9087
|
+
* @export
|
|
9088
|
+
*/
|
|
9089
|
+
type ExperimentalEndpointsApiListConnectionAccountsBaseRequest = {
|
|
9090
|
+
/**
|
|
9091
|
+
*
|
|
9092
|
+
* @type {string}
|
|
9093
|
+
* @memberof ExperimentalEndpointsApiListConnectionAccounts
|
|
9094
|
+
*/
|
|
9095
|
+
readonly authorizationId: string;
|
|
9096
|
+
};
|
|
9097
|
+
type ExperimentalEndpointsApiListConnectionAccountscommercialApiKeyRequest = ExperimentalEndpointsApiListConnectionAccountsBaseRequest & {
|
|
9098
|
+
readonly userId: string;
|
|
9099
|
+
readonly userSecret: string;
|
|
9100
|
+
};
|
|
9101
|
+
type ExperimentalEndpointsApiListConnectionAccountspersonalApiKeyRequest = ExperimentalEndpointsApiListConnectionAccountsBaseRequest & {
|
|
9102
|
+
readonly userId?: never;
|
|
9103
|
+
readonly userSecret?: never;
|
|
9104
|
+
};
|
|
9105
|
+
type ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode = {
|
|
9106
|
+
"commercialApiKey": ExperimentalEndpointsApiListConnectionAccountscommercialApiKeyRequest;
|
|
9107
|
+
"personalApiKey": ExperimentalEndpointsApiListConnectionAccountspersonalApiKeyRequest;
|
|
9108
|
+
};
|
|
9109
|
+
type ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth extends AuthMode> = ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode[TAuth["mode"] & keyof ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode];
|
|
9163
9110
|
/**
|
|
9164
9111
|
* ExperimentalEndpointsApiGenerated - object-oriented interface
|
|
9165
9112
|
* @export
|
|
@@ -9212,6 +9159,15 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9212
9159
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
9213
9160
|
*/
|
|
9214
9161
|
getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountOrdersV2Response, any, {}>>;
|
|
9162
|
+
/**
|
|
9163
|
+
* Experimental and subject to change without notice. Returns the accounts that belong to the specified connection for the authenticated user, using the `kind`-discriminated account shape. Each item in the response carries a `kind` field (currently only `investment` is implemented) that determines which additional fields are present -- see the `ConnectionAccount` schema. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and market value live from the brokerage on each call. On Pay as you Go / Daily, this endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To force a refresh, use the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see whether your plan includes real-time data.
|
|
9164
|
+
* @summary List accounts for a connection (discriminated union)
|
|
9165
|
+
* @param {ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>} requestParameters Request parameters.
|
|
9166
|
+
* @param {*} [options] Override http request option.
|
|
9167
|
+
* @throws {RequiredError}
|
|
9168
|
+
* @memberof ExperimentalEndpointsApiGenerated
|
|
9169
|
+
*/
|
|
9170
|
+
listConnectionAccounts(requestParameters: ExperimentalEndpointsApiListConnectionAccountsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<ConnectionAccount[], any, {}>>;
|
|
9215
9171
|
/**
|
|
9216
9172
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9217
9173
|
* @summary List active Trade Detection subscriptions
|
|
@@ -9225,115 +9181,12 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
9225
9181
|
//#region api/experimental-endpoints-api.d.ts
|
|
9226
9182
|
declare class ExperimentalEndpointsApi<TAuth extends AuthMode> extends ExperimentalEndpointsApiGenerated<TAuth> {}
|
|
9227
9183
|
//#endregion
|
|
9228
|
-
//#region api/options-api-generated.d.ts
|
|
9229
|
-
/**
|
|
9230
|
-
* OptionsApi - axios parameter creator
|
|
9231
|
-
* @export
|
|
9232
|
-
*/
|
|
9233
|
-
declare const OptionsApiAxiosParamCreator: (configuration?: Configuration<AuthMode>) => {
|
|
9234
|
-
/**
|
|
9235
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
9236
|
-
* @summary List account option positions
|
|
9237
|
-
* @param {string} accountId
|
|
9238
|
-
* @param {string} [userId]
|
|
9239
|
-
* @param {string} [userSecret]
|
|
9240
|
-
* @param {*} [options] Override http request option.
|
|
9241
|
-
* @deprecated
|
|
9242
|
-
* @throws {RequiredError}
|
|
9243
|
-
*/
|
|
9244
|
-
listOptionHoldings: (accountId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9245
|
-
};
|
|
9246
|
-
/**
|
|
9247
|
-
* OptionsApi - functional programming interface
|
|
9248
|
-
* @export
|
|
9249
|
-
*/
|
|
9250
|
-
declare const OptionsApiFp: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>) => {
|
|
9251
|
-
/**
|
|
9252
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
9253
|
-
* @summary List account option positions
|
|
9254
|
-
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
9255
|
-
* @param {*} [options] Override http request option.
|
|
9256
|
-
* @deprecated
|
|
9257
|
-
* @throws {RequiredError}
|
|
9258
|
-
*/
|
|
9259
|
-
listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionsPosition>>>;
|
|
9260
|
-
};
|
|
9261
|
-
/**
|
|
9262
|
-
* OptionsApi - factory interface
|
|
9263
|
-
* @export
|
|
9264
|
-
*/
|
|
9265
|
-
declare const OptionsApiFactory: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>, basePath?: string, axios?: AxiosInstance) => {
|
|
9266
|
-
/**
|
|
9267
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
9268
|
-
* @summary List account option positions
|
|
9269
|
-
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
9270
|
-
* @param {*} [options] Override http request option.
|
|
9271
|
-
* @deprecated
|
|
9272
|
-
* @throws {RequiredError}
|
|
9273
|
-
*/
|
|
9274
|
-
listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<OptionsPosition>>;
|
|
9275
|
-
};
|
|
9276
|
-
/**
|
|
9277
|
-
* Request parameters for listOptionHoldings operation in OptionsApi.
|
|
9278
|
-
* @export
|
|
9279
|
-
*/
|
|
9280
|
-
type OptionsApiListOptionHoldingsBaseRequest = {
|
|
9281
|
-
/**
|
|
9282
|
-
*
|
|
9283
|
-
* @type {string}
|
|
9284
|
-
* @memberof OptionsApiListOptionHoldings
|
|
9285
|
-
*/
|
|
9286
|
-
readonly accountId: string;
|
|
9287
|
-
};
|
|
9288
|
-
type OptionsApiListOptionHoldingscommercialApiKeyRequest = OptionsApiListOptionHoldingsBaseRequest & {
|
|
9289
|
-
readonly userId: string;
|
|
9290
|
-
readonly userSecret: string;
|
|
9291
|
-
};
|
|
9292
|
-
type OptionsApiListOptionHoldingspersonalApiKeyRequest = OptionsApiListOptionHoldingsBaseRequest & {
|
|
9293
|
-
readonly userId?: never;
|
|
9294
|
-
readonly userSecret?: never;
|
|
9295
|
-
};
|
|
9296
|
-
type OptionsApiListOptionHoldingsRequestByAuthMode = {
|
|
9297
|
-
"commercialApiKey": OptionsApiListOptionHoldingscommercialApiKeyRequest;
|
|
9298
|
-
"personalApiKey": OptionsApiListOptionHoldingspersonalApiKeyRequest;
|
|
9299
|
-
};
|
|
9300
|
-
type OptionsApiListOptionHoldingsRequest<TAuth extends AuthMode> = OptionsApiListOptionHoldingsRequestByAuthMode[TAuth["mode"] & keyof OptionsApiListOptionHoldingsRequestByAuthMode];
|
|
9301
|
-
/**
|
|
9302
|
-
* OptionsApiGenerated - object-oriented interface
|
|
9303
|
-
* @export
|
|
9304
|
-
* @class OptionsApiGenerated
|
|
9305
|
-
* @extends {BaseAPI}
|
|
9306
|
-
*/
|
|
9307
|
-
declare class OptionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth> {
|
|
9308
|
-
/**
|
|
9309
|
-
* **Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
9310
|
-
* @summary List account option positions
|
|
9311
|
-
* @param {OptionsApiListOptionHoldingsRequest<TAuth>} requestParameters Request parameters.
|
|
9312
|
-
* @param {*} [options] Override http request option.
|
|
9313
|
-
* @deprecated
|
|
9314
|
-
* @throws {RequiredError}
|
|
9315
|
-
* @memberof OptionsApiGenerated
|
|
9316
|
-
*/
|
|
9317
|
-
listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<OptionsPosition[], any, {}>>;
|
|
9318
|
-
}
|
|
9319
|
-
//#endregion
|
|
9320
|
-
//#region api/options-api.d.ts
|
|
9321
|
-
declare class OptionsApi<TAuth extends AuthMode> extends OptionsApiGenerated<TAuth> {}
|
|
9322
|
-
//#endregion
|
|
9323
9184
|
//#region api/reference-data-api-generated.d.ts
|
|
9324
9185
|
/**
|
|
9325
9186
|
* ReferenceDataApi - axios parameter creator
|
|
9326
9187
|
* @export
|
|
9327
9188
|
*/
|
|
9328
9189
|
declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration<AuthMode>) => {
|
|
9329
|
-
/**
|
|
9330
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
9331
|
-
* @summary Get exchange rate of a currency pair
|
|
9332
|
-
* @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
|
|
9333
|
-
* @param {*} [options] Override http request option.
|
|
9334
|
-
* @throws {RequiredError}
|
|
9335
|
-
*/
|
|
9336
|
-
getCurrencyExchangeRatePair: (currencyPair: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9337
9190
|
/**
|
|
9338
9191
|
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
9339
9192
|
* @summary Get Client Info
|
|
@@ -9341,13 +9194,6 @@ declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration<
|
|
|
9341
9194
|
* @throws {RequiredError}
|
|
9342
9195
|
*/
|
|
9343
9196
|
getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9344
|
-
/**
|
|
9345
|
-
* Return all available security types supported by SnapTrade.
|
|
9346
|
-
* @summary List security types
|
|
9347
|
-
* @param {*} [options] Override http request option.
|
|
9348
|
-
* @throws {RequiredError}
|
|
9349
|
-
*/
|
|
9350
|
-
getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9351
9197
|
/**
|
|
9352
9198
|
* Returns a list of all supported Exchanges.
|
|
9353
9199
|
* @summary Get exchanges
|
|
@@ -9394,20 +9240,6 @@ declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration<
|
|
|
9394
9240
|
* @throws {RequiredError}
|
|
9395
9241
|
*/
|
|
9396
9242
|
listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9397
|
-
/**
|
|
9398
|
-
* Returns a list of all defined Currency objects.
|
|
9399
|
-
* @summary Get currencies
|
|
9400
|
-
* @param {*} [options] Override http request option.
|
|
9401
|
-
* @throws {RequiredError}
|
|
9402
|
-
*/
|
|
9403
|
-
listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9404
|
-
/**
|
|
9405
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
9406
|
-
* @summary Get currency exchange rates
|
|
9407
|
-
* @param {*} [options] Override http request option.
|
|
9408
|
-
* @throws {RequiredError}
|
|
9409
|
-
*/
|
|
9410
|
-
listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9411
9243
|
/**
|
|
9412
9244
|
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
9413
9245
|
* @summary Search account symbols
|
|
@@ -9425,14 +9257,6 @@ declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration<
|
|
|
9425
9257
|
* @export
|
|
9426
9258
|
*/
|
|
9427
9259
|
declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>) => {
|
|
9428
|
-
/**
|
|
9429
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
9430
|
-
* @summary Get exchange rate of a currency pair
|
|
9431
|
-
* @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth>} requestParameters Request parameters.
|
|
9432
|
-
* @param {*} [options] Override http request option.
|
|
9433
|
-
* @throws {RequiredError}
|
|
9434
|
-
*/
|
|
9435
|
-
getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeRatePairs>>;
|
|
9436
9260
|
/**
|
|
9437
9261
|
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
9438
9262
|
* @summary Get Client Info
|
|
@@ -9440,13 +9264,6 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9440
9264
|
* @throws {RequiredError}
|
|
9441
9265
|
*/
|
|
9442
9266
|
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
|
|
9443
|
-
/**
|
|
9444
|
-
* Return all available security types supported by SnapTrade.
|
|
9445
|
-
* @summary List security types
|
|
9446
|
-
* @param {*} [options] Override http request option.
|
|
9447
|
-
* @throws {RequiredError}
|
|
9448
|
-
*/
|
|
9449
|
-
getSecurityTypes(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
|
|
9450
9267
|
/**
|
|
9451
9268
|
* Returns a list of all supported Exchanges.
|
|
9452
9269
|
* @summary Get exchanges
|
|
@@ -9493,20 +9310,6 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9493
9310
|
* @throws {RequiredError}
|
|
9494
9311
|
*/
|
|
9495
9312
|
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
|
|
9496
|
-
/**
|
|
9497
|
-
* Returns a list of all defined Currency objects.
|
|
9498
|
-
* @summary Get currencies
|
|
9499
|
-
* @param {*} [options] Override http request option.
|
|
9500
|
-
* @throws {RequiredError}
|
|
9501
|
-
*/
|
|
9502
|
-
listAllCurrencies(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
|
|
9503
|
-
/**
|
|
9504
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
9505
|
-
* @summary Get currency exchange rates
|
|
9506
|
-
* @param {*} [options] Override http request option.
|
|
9507
|
-
* @throws {RequiredError}
|
|
9508
|
-
*/
|
|
9509
|
-
listAllCurrenciesRates(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
|
|
9510
9313
|
/**
|
|
9511
9314
|
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
9512
9315
|
* @summary Search account symbols
|
|
@@ -9521,14 +9324,6 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9521
9324
|
* @export
|
|
9522
9325
|
*/
|
|
9523
9326
|
declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>, basePath?: string, axios?: AxiosInstance) => {
|
|
9524
|
-
/**
|
|
9525
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
9526
|
-
* @summary Get exchange rate of a currency pair
|
|
9527
|
-
* @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth>} requestParameters Request parameters.
|
|
9528
|
-
* @param {*} [options] Override http request option.
|
|
9529
|
-
* @throws {RequiredError}
|
|
9530
|
-
*/
|
|
9531
|
-
getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<ExchangeRatePairs>;
|
|
9532
9327
|
/**
|
|
9533
9328
|
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
9534
9329
|
* @summary Get Client Info
|
|
@@ -9536,13 +9331,6 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9536
9331
|
* @throws {RequiredError}
|
|
9537
9332
|
*/
|
|
9538
9333
|
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): AxiosPromise<PartnerData>;
|
|
9539
|
-
/**
|
|
9540
|
-
* Return all available security types supported by SnapTrade.
|
|
9541
|
-
* @summary List security types
|
|
9542
|
-
* @param {*} [options] Override http request option.
|
|
9543
|
-
* @throws {RequiredError}
|
|
9544
|
-
*/
|
|
9545
|
-
getSecurityTypes(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): AxiosPromise<Array<SecurityType>>;
|
|
9546
9334
|
/**
|
|
9547
9335
|
* Returns a list of all supported Exchanges.
|
|
9548
9336
|
* @summary Get exchanges
|
|
@@ -9589,20 +9377,6 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9589
9377
|
* @throws {RequiredError}
|
|
9590
9378
|
*/
|
|
9591
9379
|
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): AxiosPromise<Array<Brokerage>>;
|
|
9592
|
-
/**
|
|
9593
|
-
* Returns a list of all defined Currency objects.
|
|
9594
|
-
* @summary Get currencies
|
|
9595
|
-
* @param {*} [options] Override http request option.
|
|
9596
|
-
* @throws {RequiredError}
|
|
9597
|
-
*/
|
|
9598
|
-
listAllCurrencies(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): AxiosPromise<Array<Currency>>;
|
|
9599
|
-
/**
|
|
9600
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
9601
|
-
* @summary Get currency exchange rates
|
|
9602
|
-
* @param {*} [options] Override http request option.
|
|
9603
|
-
* @throws {RequiredError}
|
|
9604
|
-
*/
|
|
9605
|
-
listAllCurrenciesRates(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): AxiosPromise<Array<ExchangeRatePairs>>;
|
|
9606
9380
|
/**
|
|
9607
9381
|
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
9608
9382
|
* @summary Search account symbols
|
|
@@ -9612,25 +9386,6 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9612
9386
|
*/
|
|
9613
9387
|
symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
|
|
9614
9388
|
};
|
|
9615
|
-
/**
|
|
9616
|
-
* Request parameters for getCurrencyExchangeRatePair operation in ReferenceDataApi.
|
|
9617
|
-
* @export
|
|
9618
|
-
*/
|
|
9619
|
-
type ReferenceDataApiGetCurrencyExchangeRatePairBaseRequest = {
|
|
9620
|
-
/**
|
|
9621
|
-
* A currency pair based on currency code for example, {CAD-USD}
|
|
9622
|
-
* @type {string}
|
|
9623
|
-
* @memberof ReferenceDataApiGetCurrencyExchangeRatePair
|
|
9624
|
-
*/
|
|
9625
|
-
readonly currencyPair: string;
|
|
9626
|
-
};
|
|
9627
|
-
type ReferenceDataApiGetCurrencyExchangeRatePaircommercialApiKeyRequest = ReferenceDataApiGetCurrencyExchangeRatePairBaseRequest & {};
|
|
9628
|
-
type ReferenceDataApiGetCurrencyExchangeRatePairpersonalApiKeyRequest = ReferenceDataApiGetCurrencyExchangeRatePairBaseRequest & {};
|
|
9629
|
-
type ReferenceDataApiGetCurrencyExchangeRatePairRequestByAuthMode = {
|
|
9630
|
-
"commercialApiKey": ReferenceDataApiGetCurrencyExchangeRatePaircommercialApiKeyRequest;
|
|
9631
|
-
"personalApiKey": ReferenceDataApiGetCurrencyExchangeRatePairpersonalApiKeyRequest;
|
|
9632
|
-
};
|
|
9633
|
-
type ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth extends AuthMode> = ReferenceDataApiGetCurrencyExchangeRatePairRequestByAuthMode[TAuth["mode"] & keyof ReferenceDataApiGetCurrencyExchangeRatePairRequestByAuthMode];
|
|
9634
9389
|
/**
|
|
9635
9390
|
* Request parameters for getSymbols operation in ReferenceDataApi.
|
|
9636
9391
|
* @export
|
|
@@ -9732,15 +9487,6 @@ type ReferenceDataApiSymbolSearchUserAccountRequest<TAuth extends AuthMode> = Re
|
|
|
9732
9487
|
* @extends {BaseAPI}
|
|
9733
9488
|
*/
|
|
9734
9489
|
declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth> {
|
|
9735
|
-
/**
|
|
9736
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
9737
|
-
* @summary Get exchange rate of a currency pair
|
|
9738
|
-
* @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth>} requestParameters Request parameters.
|
|
9739
|
-
* @param {*} [options] Override http request option.
|
|
9740
|
-
* @throws {RequiredError}
|
|
9741
|
-
* @memberof ReferenceDataApiGenerated
|
|
9742
|
-
*/
|
|
9743
|
-
getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<ExchangeRatePairs, any, {}>>;
|
|
9744
9490
|
/**
|
|
9745
9491
|
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
9746
9492
|
* @summary Get Client Info
|
|
@@ -9749,14 +9495,6 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9749
9495
|
* @memberof ReferenceDataApiGenerated
|
|
9750
9496
|
*/
|
|
9751
9497
|
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<_$axios.AxiosResponse<PartnerData, any, {}>>;
|
|
9752
|
-
/**
|
|
9753
|
-
* Return all available security types supported by SnapTrade.
|
|
9754
|
-
* @summary List security types
|
|
9755
|
-
* @param {*} [options] Override http request option.
|
|
9756
|
-
* @throws {RequiredError}
|
|
9757
|
-
* @memberof ReferenceDataApiGenerated
|
|
9758
|
-
*/
|
|
9759
|
-
getSecurityTypes(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<_$axios.AxiosResponse<SecurityType[], any, {}>>;
|
|
9760
9498
|
/**
|
|
9761
9499
|
* Returns a list of all supported Exchanges.
|
|
9762
9500
|
* @summary Get exchanges
|
|
@@ -9809,22 +9547,6 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
9809
9547
|
* @memberof ReferenceDataApiGenerated
|
|
9810
9548
|
*/
|
|
9811
9549
|
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<_$axios.AxiosResponse<Brokerage[], any, {}>>;
|
|
9812
|
-
/**
|
|
9813
|
-
* Returns a list of all defined Currency objects.
|
|
9814
|
-
* @summary Get currencies
|
|
9815
|
-
* @param {*} [options] Override http request option.
|
|
9816
|
-
* @throws {RequiredError}
|
|
9817
|
-
* @memberof ReferenceDataApiGenerated
|
|
9818
|
-
*/
|
|
9819
|
-
listAllCurrencies(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<_$axios.AxiosResponse<Currency[], any, {}>>;
|
|
9820
|
-
/**
|
|
9821
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
9822
|
-
* @summary Get currency exchange rates
|
|
9823
|
-
* @param {*} [options] Override http request option.
|
|
9824
|
-
* @throws {RequiredError}
|
|
9825
|
-
* @memberof ReferenceDataApiGenerated
|
|
9826
|
-
*/
|
|
9827
|
-
listAllCurrenciesRates(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<_$axios.AxiosResponse<ExchangeRatePairs[], any, {}>>;
|
|
9828
9550
|
/**
|
|
9829
9551
|
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
9830
9552
|
* @summary Search account symbols
|
|
@@ -9856,18 +9578,6 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9856
9578
|
* @throws {RequiredError}
|
|
9857
9579
|
*/
|
|
9858
9580
|
cancelOrder: (accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9859
|
-
/**
|
|
9860
|
-
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
9861
|
-
* @summary Cancel equity order
|
|
9862
|
-
* @param {string} accountId
|
|
9863
|
-
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
9864
|
-
* @param {string} [userId]
|
|
9865
|
-
* @param {string} [userSecret]
|
|
9866
|
-
* @param {*} [options] Override http request option.
|
|
9867
|
-
* @deprecated
|
|
9868
|
-
* @throws {RequiredError}
|
|
9869
|
-
*/
|
|
9870
|
-
cancelUserAccountOrder: (accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9871
9581
|
/**
|
|
9872
9582
|
* Gets a quote for the specified account.
|
|
9873
9583
|
* @summary Get crypto pair quote
|
|
@@ -9923,18 +9633,6 @@ declare const TradingApiAxiosParamCreator: (configuration?: Configuration<AuthMo
|
|
|
9923
9633
|
* @throws {RequiredError}
|
|
9924
9634
|
*/
|
|
9925
9635
|
getUserAccountQuotes: (symbols: string, accountId: string, useTicker?: boolean, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9926
|
-
/**
|
|
9927
|
-
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
9928
|
-
* @summary Place bracket order
|
|
9929
|
-
* @param {string} accountId The ID of the account to execute the trade on.
|
|
9930
|
-
* @param {ManualTradeFormBracket} manualTradeFormBracket
|
|
9931
|
-
* @param {string} [userId]
|
|
9932
|
-
* @param {string} [userSecret]
|
|
9933
|
-
* @param {*} [options] Override http request option.
|
|
9934
|
-
* @deprecated
|
|
9935
|
-
* @throws {RequiredError}
|
|
9936
|
-
*/
|
|
9937
|
-
placeBracketOrder: (accountId: string, manualTradeFormBracket: ManualTradeFormBracket, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9938
9636
|
/**
|
|
9939
9637
|
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
9940
9638
|
* @summary Place complex order
|
|
@@ -10037,15 +9735,6 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10037
9735
|
* @throws {RequiredError}
|
|
10038
9736
|
*/
|
|
10039
9737
|
cancelOrder(requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
|
|
10040
|
-
/**
|
|
10041
|
-
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
10042
|
-
* @summary Cancel equity order
|
|
10043
|
-
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10044
|
-
* @param {*} [options] Override http request option.
|
|
10045
|
-
* @deprecated
|
|
10046
|
-
* @throws {RequiredError}
|
|
10047
|
-
*/
|
|
10048
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
10049
9738
|
/**
|
|
10050
9739
|
* Gets a quote for the specified account.
|
|
10051
9740
|
* @summary Get crypto pair quote
|
|
@@ -10086,15 +9775,6 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10086
9775
|
* @throws {RequiredError}
|
|
10087
9776
|
*/
|
|
10088
9777
|
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
|
|
10089
|
-
/**
|
|
10090
|
-
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
10091
|
-
* @summary Place bracket order
|
|
10092
|
-
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10093
|
-
* @param {*} [options] Override http request option.
|
|
10094
|
-
* @deprecated
|
|
10095
|
-
* @throws {RequiredError}
|
|
10096
|
-
*/
|
|
10097
|
-
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
10098
9778
|
/**
|
|
10099
9779
|
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
10100
9780
|
* @summary Place complex order
|
|
@@ -10173,15 +9853,6 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10173
9853
|
* @throws {RequiredError}
|
|
10174
9854
|
*/
|
|
10175
9855
|
cancelOrder(requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<CancelOrderResponse>;
|
|
10176
|
-
/**
|
|
10177
|
-
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
10178
|
-
* @summary Cancel equity order
|
|
10179
|
-
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10180
|
-
* @param {*} [options] Override http request option.
|
|
10181
|
-
* @deprecated
|
|
10182
|
-
* @throws {RequiredError}
|
|
10183
|
-
*/
|
|
10184
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
10185
9856
|
/**
|
|
10186
9857
|
* Gets a quote for the specified account.
|
|
10187
9858
|
* @summary Get crypto pair quote
|
|
@@ -10222,15 +9893,6 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10222
9893
|
* @throws {RequiredError}
|
|
10223
9894
|
*/
|
|
10224
9895
|
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
|
|
10225
|
-
/**
|
|
10226
|
-
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
10227
|
-
* @summary Place bracket order
|
|
10228
|
-
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10229
|
-
* @param {*} [options] Override http request option.
|
|
10230
|
-
* @deprecated
|
|
10231
|
-
* @throws {RequiredError}
|
|
10232
|
-
*/
|
|
10233
|
-
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
10234
9896
|
/**
|
|
10235
9897
|
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
10236
9898
|
* @summary Place complex order
|
|
@@ -10321,31 +9983,6 @@ type TradingApiCancelOrderRequestByAuthMode = {
|
|
|
10321
9983
|
"personalApiKey": TradingApiCancelOrderpersonalApiKeyRequest;
|
|
10322
9984
|
};
|
|
10323
9985
|
type TradingApiCancelOrderRequest<TAuth extends AuthMode> = TradingApiCancelOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiCancelOrderRequestByAuthMode];
|
|
10324
|
-
/**
|
|
10325
|
-
* Request parameters for cancelUserAccountOrder operation in TradingApi.
|
|
10326
|
-
* @export
|
|
10327
|
-
*/
|
|
10328
|
-
type TradingApiCancelUserAccountOrderBaseRequest = {
|
|
10329
|
-
/**
|
|
10330
|
-
*
|
|
10331
|
-
* @type {string}
|
|
10332
|
-
* @memberof TradingApiCancelUserAccountOrder
|
|
10333
|
-
*/
|
|
10334
|
-
readonly accountId: string;
|
|
10335
|
-
} & AccountInformationGetUserAccountOrderDetailRequest;
|
|
10336
|
-
type TradingApiCancelUserAccountOrdercommercialApiKeyRequest = TradingApiCancelUserAccountOrderBaseRequest & {
|
|
10337
|
-
readonly userId: string;
|
|
10338
|
-
readonly userSecret: string;
|
|
10339
|
-
};
|
|
10340
|
-
type TradingApiCancelUserAccountOrderpersonalApiKeyRequest = TradingApiCancelUserAccountOrderBaseRequest & {
|
|
10341
|
-
readonly userId?: never;
|
|
10342
|
-
readonly userSecret?: never;
|
|
10343
|
-
};
|
|
10344
|
-
type TradingApiCancelUserAccountOrderRequestByAuthMode = {
|
|
10345
|
-
"commercialApiKey": TradingApiCancelUserAccountOrdercommercialApiKeyRequest;
|
|
10346
|
-
"personalApiKey": TradingApiCancelUserAccountOrderpersonalApiKeyRequest;
|
|
10347
|
-
};
|
|
10348
|
-
type TradingApiCancelUserAccountOrderRequest<TAuth extends AuthMode> = TradingApiCancelUserAccountOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiCancelUserAccountOrderRequestByAuthMode];
|
|
10349
9986
|
/**
|
|
10350
9987
|
* Request parameters for getCryptocurrencyPairQuote operation in TradingApi.
|
|
10351
9988
|
* @export
|
|
@@ -10488,31 +10125,6 @@ type TradingApiGetUserAccountQuotesRequestByAuthMode = {
|
|
|
10488
10125
|
"personalApiKey": TradingApiGetUserAccountQuotespersonalApiKeyRequest;
|
|
10489
10126
|
};
|
|
10490
10127
|
type TradingApiGetUserAccountQuotesRequest<TAuth extends AuthMode> = TradingApiGetUserAccountQuotesRequestByAuthMode[TAuth["mode"] & keyof TradingApiGetUserAccountQuotesRequestByAuthMode];
|
|
10491
|
-
/**
|
|
10492
|
-
* Request parameters for placeBracketOrder operation in TradingApi.
|
|
10493
|
-
* @export
|
|
10494
|
-
*/
|
|
10495
|
-
type TradingApiPlaceBracketOrderBaseRequest = {
|
|
10496
|
-
/**
|
|
10497
|
-
* The ID of the account to execute the trade on.
|
|
10498
|
-
* @type {string}
|
|
10499
|
-
* @memberof TradingApiPlaceBracketOrder
|
|
10500
|
-
*/
|
|
10501
|
-
readonly accountId: string;
|
|
10502
|
-
} & ManualTradeFormBracket;
|
|
10503
|
-
type TradingApiPlaceBracketOrdercommercialApiKeyRequest = TradingApiPlaceBracketOrderBaseRequest & {
|
|
10504
|
-
readonly userId: string;
|
|
10505
|
-
readonly userSecret: string;
|
|
10506
|
-
};
|
|
10507
|
-
type TradingApiPlaceBracketOrderpersonalApiKeyRequest = TradingApiPlaceBracketOrderBaseRequest & {
|
|
10508
|
-
readonly userId?: never;
|
|
10509
|
-
readonly userSecret?: never;
|
|
10510
|
-
};
|
|
10511
|
-
type TradingApiPlaceBracketOrderRequestByAuthMode = {
|
|
10512
|
-
"commercialApiKey": TradingApiPlaceBracketOrdercommercialApiKeyRequest;
|
|
10513
|
-
"personalApiKey": TradingApiPlaceBracketOrderpersonalApiKeyRequest;
|
|
10514
|
-
};
|
|
10515
|
-
type TradingApiPlaceBracketOrderRequest<TAuth extends AuthMode> = TradingApiPlaceBracketOrderRequestByAuthMode[TAuth["mode"] & keyof TradingApiPlaceBracketOrderRequestByAuthMode];
|
|
10516
10128
|
/**
|
|
10517
10129
|
* Request parameters for placeComplexOrder operation in TradingApi.
|
|
10518
10130
|
* @export
|
|
@@ -10734,16 +10346,6 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10734
10346
|
* @memberof TradingApiGenerated
|
|
10735
10347
|
*/
|
|
10736
10348
|
cancelOrder(requestParameters: TradingApiCancelOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<CancelOrderResponse, any, {}>>;
|
|
10737
|
-
/**
|
|
10738
|
-
* **Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead. Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
10739
|
-
* @summary Cancel equity order
|
|
10740
|
-
* @param {TradingApiCancelUserAccountOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10741
|
-
* @param {*} [options] Override http request option.
|
|
10742
|
-
* @deprecated
|
|
10743
|
-
* @throws {RequiredError}
|
|
10744
|
-
* @memberof TradingApiGenerated
|
|
10745
|
-
*/
|
|
10746
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
10747
10349
|
/**
|
|
10748
10350
|
* Gets a quote for the specified account.
|
|
10749
10351
|
* @summary Get crypto pair quote
|
|
@@ -10789,16 +10391,6 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10789
10391
|
* @memberof TradingApiGenerated
|
|
10790
10392
|
*/
|
|
10791
10393
|
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<SymbolsQuotesInner[], any, {}>>;
|
|
10792
|
-
/**
|
|
10793
|
-
* **Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead. Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
10794
|
-
* @summary Place bracket order
|
|
10795
|
-
* @param {TradingApiPlaceBracketOrderRequest<TAuth>} requestParameters Request parameters.
|
|
10796
|
-
* @param {*} [options] Override http request option.
|
|
10797
|
-
* @deprecated
|
|
10798
|
-
* @throws {RequiredError}
|
|
10799
|
-
* @memberof TradingApiGenerated
|
|
10800
|
-
*/
|
|
10801
|
-
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
10802
10394
|
/**
|
|
10803
10395
|
* Places a complex conditional order (OCO, OTO, or OTOCO). Only supported on certain brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for details on which brokerages support complex orders and which types they support. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
10804
10396
|
* @summary Place complex order
|
|
@@ -10876,221 +10468,6 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
10876
10468
|
//#region api/trading-api.d.ts
|
|
10877
10469
|
declare class TradingApi<TAuth extends AuthMode> extends TradingApiGenerated<TAuth> {}
|
|
10878
10470
|
//#endregion
|
|
10879
|
-
//#region api/transactions-and-reporting-api-generated.d.ts
|
|
10880
|
-
/**
|
|
10881
|
-
* TransactionsAndReportingApi - axios parameter creator
|
|
10882
|
-
* @export
|
|
10883
|
-
*/
|
|
10884
|
-
declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration<AuthMode>) => {
|
|
10885
|
-
/**
|
|
10886
|
-
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
10887
|
-
* @summary Get transaction history for a user
|
|
10888
|
-
* @param {string | Date} [startDate] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
10889
|
-
* @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
10890
|
-
* @param {string} [accounts] Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
|
|
10891
|
-
* @param {string} [brokerageAuthorizations] Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
|
|
10892
|
-
* @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
10893
|
-
* @param {string} [userId]
|
|
10894
|
-
* @param {string} [userSecret]
|
|
10895
|
-
* @param {*} [options] Override http request option.
|
|
10896
|
-
* @deprecated
|
|
10897
|
-
* @throws {RequiredError}
|
|
10898
|
-
*/
|
|
10899
|
-
getActivities: (startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10900
|
-
/**
|
|
10901
|
-
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10902
|
-
* @summary Get performance information for a specific timeframe
|
|
10903
|
-
* @param {string | Date} startDate
|
|
10904
|
-
* @param {string | Date} endDate
|
|
10905
|
-
* @param {string} [accounts] Optional comma separated list of account IDs used to filter the request on specific accounts
|
|
10906
|
-
* @param {boolean} [detailed] Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
10907
|
-
* @param {string} [frequency] Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
10908
|
-
* @param {string} [userId]
|
|
10909
|
-
* @param {string} [userSecret]
|
|
10910
|
-
* @param {*} [options] Override http request option.
|
|
10911
|
-
* @deprecated
|
|
10912
|
-
* @throws {RequiredError}
|
|
10913
|
-
*/
|
|
10914
|
-
getReportingCustomRange: (startDate: string | Date, endDate: string | Date, accounts?: string, detailed?: boolean, frequency?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10915
|
-
};
|
|
10916
|
-
/**
|
|
10917
|
-
* TransactionsAndReportingApi - functional programming interface
|
|
10918
|
-
* @export
|
|
10919
|
-
*/
|
|
10920
|
-
declare const TransactionsAndReportingApiFp: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>) => {
|
|
10921
|
-
/**
|
|
10922
|
-
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
10923
|
-
* @summary Get transaction history for a user
|
|
10924
|
-
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
10925
|
-
* @param {*} [options] Override http request option.
|
|
10926
|
-
* @deprecated
|
|
10927
|
-
* @throws {RequiredError}
|
|
10928
|
-
*/
|
|
10929
|
-
getActivities(requestParameters?: TransactionsAndReportingApiGetActivitiesRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
|
|
10930
|
-
/**
|
|
10931
|
-
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10932
|
-
* @summary Get performance information for a specific timeframe
|
|
10933
|
-
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
10934
|
-
* @param {*} [options] Override http request option.
|
|
10935
|
-
* @deprecated
|
|
10936
|
-
* @throws {RequiredError}
|
|
10937
|
-
*/
|
|
10938
|
-
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceCustom>>;
|
|
10939
|
-
};
|
|
10940
|
-
/**
|
|
10941
|
-
* TransactionsAndReportingApi - factory interface
|
|
10942
|
-
* @export
|
|
10943
|
-
*/
|
|
10944
|
-
declare const TransactionsAndReportingApiFactory: <TAuth extends AuthMode>(configuration?: Configuration<TAuth>, basePath?: string, axios?: AxiosInstance) => {
|
|
10945
|
-
/**
|
|
10946
|
-
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
10947
|
-
* @summary Get transaction history for a user
|
|
10948
|
-
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
10949
|
-
* @param {*} [options] Override http request option.
|
|
10950
|
-
* @deprecated
|
|
10951
|
-
* @throws {RequiredError}
|
|
10952
|
-
*/
|
|
10953
|
-
getActivities(requestParameters?: TransactionsAndReportingApiGetActivitiesRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
|
|
10954
|
-
/**
|
|
10955
|
-
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
10956
|
-
* @summary Get performance information for a specific timeframe
|
|
10957
|
-
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
10958
|
-
* @param {*} [options] Override http request option.
|
|
10959
|
-
* @deprecated
|
|
10960
|
-
* @throws {RequiredError}
|
|
10961
|
-
*/
|
|
10962
|
-
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>, options?: AxiosRequestConfig): AxiosPromise<PerformanceCustom>;
|
|
10963
|
-
};
|
|
10964
|
-
/**
|
|
10965
|
-
* Request parameters for getActivities operation in TransactionsAndReportingApi.
|
|
10966
|
-
* @export
|
|
10967
|
-
*/
|
|
10968
|
-
type TransactionsAndReportingApiGetActivitiesBaseRequest = {
|
|
10969
|
-
/**
|
|
10970
|
-
* The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
10971
|
-
* @type {string | Date}
|
|
10972
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
10973
|
-
*/
|
|
10974
|
-
readonly startDate?: string | Date;
|
|
10975
|
-
/**
|
|
10976
|
-
* The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
10977
|
-
* @type {string | Date}
|
|
10978
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
10979
|
-
*/
|
|
10980
|
-
readonly endDate?: string | Date;
|
|
10981
|
-
/**
|
|
10982
|
-
* Optional comma separated list of SnapTrade Account IDs used to filter the request to specific accounts. If not provided, the default is all known brokerage accounts for the user. The `brokerageAuthorizations` parameter takes precedence over this parameter.
|
|
10983
|
-
* @type {string}
|
|
10984
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
10985
|
-
*/
|
|
10986
|
-
readonly accounts?: string;
|
|
10987
|
-
/**
|
|
10988
|
-
* Optional comma separated list of SnapTrade Connection (Brokerage Authorization) IDs used to filter the request to only accounts that belong to those connections. If not provided, the default is all connections for the user. This parameter takes precedence over the `accounts` parameter.
|
|
10989
|
-
* @type {string}
|
|
10990
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
10991
|
-
*/
|
|
10992
|
-
readonly brokerageAuthorizations?: string;
|
|
10993
|
-
/**
|
|
10994
|
-
* Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of assets from one account to another
|
|
10995
|
-
* @type {string}
|
|
10996
|
-
* @memberof TransactionsAndReportingApiGetActivities
|
|
10997
|
-
*/
|
|
10998
|
-
readonly type?: string;
|
|
10999
|
-
};
|
|
11000
|
-
type TransactionsAndReportingApiGetActivitiescommercialApiKeyRequest = TransactionsAndReportingApiGetActivitiesBaseRequest & {
|
|
11001
|
-
readonly userId: string;
|
|
11002
|
-
readonly userSecret: string;
|
|
11003
|
-
};
|
|
11004
|
-
type TransactionsAndReportingApiGetActivitiespersonalApiKeyRequest = TransactionsAndReportingApiGetActivitiesBaseRequest & {
|
|
11005
|
-
readonly userId?: never;
|
|
11006
|
-
readonly userSecret?: never;
|
|
11007
|
-
};
|
|
11008
|
-
type TransactionsAndReportingApiGetActivitiesRequestByAuthMode = {
|
|
11009
|
-
"commercialApiKey": TransactionsAndReportingApiGetActivitiescommercialApiKeyRequest;
|
|
11010
|
-
"personalApiKey": TransactionsAndReportingApiGetActivitiespersonalApiKeyRequest;
|
|
11011
|
-
};
|
|
11012
|
-
type TransactionsAndReportingApiGetActivitiesRequest<TAuth extends AuthMode> = TransactionsAndReportingApiGetActivitiesRequestByAuthMode[TAuth["mode"] & keyof TransactionsAndReportingApiGetActivitiesRequestByAuthMode];
|
|
11013
|
-
/**
|
|
11014
|
-
* Request parameters for getReportingCustomRange operation in TransactionsAndReportingApi.
|
|
11015
|
-
* @export
|
|
11016
|
-
*/
|
|
11017
|
-
type TransactionsAndReportingApiGetReportingCustomRangeBaseRequest = {
|
|
11018
|
-
/**
|
|
11019
|
-
*
|
|
11020
|
-
* @type {string | Date}
|
|
11021
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
11022
|
-
*/
|
|
11023
|
-
readonly startDate: string | Date;
|
|
11024
|
-
/**
|
|
11025
|
-
*
|
|
11026
|
-
* @type {string | Date}
|
|
11027
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
11028
|
-
*/
|
|
11029
|
-
readonly endDate: string | Date;
|
|
11030
|
-
/**
|
|
11031
|
-
* Optional comma separated list of account IDs used to filter the request on specific accounts
|
|
11032
|
-
* @type {string}
|
|
11033
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
11034
|
-
*/
|
|
11035
|
-
readonly accounts?: string;
|
|
11036
|
-
/**
|
|
11037
|
-
* Optional, increases frequency of data points for the total value and contribution charts if set to true
|
|
11038
|
-
* @type {boolean}
|
|
11039
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
11040
|
-
*/
|
|
11041
|
-
readonly detailed?: boolean;
|
|
11042
|
-
/**
|
|
11043
|
-
* Optional frequency for the rate of return chart (defaults to monthly). Possible values are daily, weekly, monthly, quarterly, yearly.
|
|
11044
|
-
* @type {string}
|
|
11045
|
-
* @memberof TransactionsAndReportingApiGetReportingCustomRange
|
|
11046
|
-
*/
|
|
11047
|
-
readonly frequency?: string;
|
|
11048
|
-
};
|
|
11049
|
-
type TransactionsAndReportingApiGetReportingCustomRangecommercialApiKeyRequest = TransactionsAndReportingApiGetReportingCustomRangeBaseRequest & {
|
|
11050
|
-
readonly userId: string;
|
|
11051
|
-
readonly userSecret: string;
|
|
11052
|
-
};
|
|
11053
|
-
type TransactionsAndReportingApiGetReportingCustomRangepersonalApiKeyRequest = TransactionsAndReportingApiGetReportingCustomRangeBaseRequest & {
|
|
11054
|
-
readonly userId?: never;
|
|
11055
|
-
readonly userSecret?: never;
|
|
11056
|
-
};
|
|
11057
|
-
type TransactionsAndReportingApiGetReportingCustomRangeRequestByAuthMode = {
|
|
11058
|
-
"commercialApiKey": TransactionsAndReportingApiGetReportingCustomRangecommercialApiKeyRequest;
|
|
11059
|
-
"personalApiKey": TransactionsAndReportingApiGetReportingCustomRangepersonalApiKeyRequest;
|
|
11060
|
-
};
|
|
11061
|
-
type TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth extends AuthMode> = TransactionsAndReportingApiGetReportingCustomRangeRequestByAuthMode[TAuth["mode"] & keyof TransactionsAndReportingApiGetReportingCustomRangeRequestByAuthMode];
|
|
11062
|
-
/**
|
|
11063
|
-
* TransactionsAndReportingApiGenerated - object-oriented interface
|
|
11064
|
-
* @export
|
|
11065
|
-
* @class TransactionsAndReportingApiGenerated
|
|
11066
|
-
* @extends {BaseAPI}
|
|
11067
|
-
*/
|
|
11068
|
-
declare class TransactionsAndReportingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth> {
|
|
11069
|
-
/**
|
|
11070
|
-
* **Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible. This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026. Returns all historical transactions for the specified user and filtering criteria. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request. There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.
|
|
11071
|
-
* @summary Get transaction history for a user
|
|
11072
|
-
* @param {TransactionsAndReportingApiGetActivitiesRequest<TAuth>} requestParameters Request parameters.
|
|
11073
|
-
* @param {*} [options] Override http request option.
|
|
11074
|
-
* @deprecated
|
|
11075
|
-
* @throws {RequiredError}
|
|
11076
|
-
* @memberof TransactionsAndReportingApiGenerated
|
|
11077
|
-
*/
|
|
11078
|
-
getActivities(requestParameters?: TransactionsAndReportingApiGetActivitiesRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<UniversalActivity[], any, {}>>;
|
|
11079
|
-
/**
|
|
11080
|
-
* **Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
|
|
11081
|
-
* @summary Get performance information for a specific timeframe
|
|
11082
|
-
* @param {TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>} requestParameters Request parameters.
|
|
11083
|
-
* @param {*} [options] Override http request option.
|
|
11084
|
-
* @deprecated
|
|
11085
|
-
* @throws {RequiredError}
|
|
11086
|
-
* @memberof TransactionsAndReportingApiGenerated
|
|
11087
|
-
*/
|
|
11088
|
-
getReportingCustomRange(requestParameters: TransactionsAndReportingApiGetReportingCustomRangeRequest<TAuth>, options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<PerformanceCustom, any, {}>>;
|
|
11089
|
-
}
|
|
11090
|
-
//#endregion
|
|
11091
|
-
//#region api/transactions-and-reporting-api.d.ts
|
|
11092
|
-
declare class TransactionsAndReportingApi<TAuth extends AuthMode> extends TransactionsAndReportingApiGenerated<TAuth> {}
|
|
11093
|
-
//#endregion
|
|
11094
10471
|
//#region client-custom.d.ts
|
|
11095
10472
|
declare class SnaptradeCustom<TAuth extends AuthMode> {
|
|
11096
10473
|
constructor(configurationParameters: ConfigurationParameters<TAuth>);
|
|
@@ -11103,10 +10480,8 @@ declare class Snaptrade<TAuth extends AuthMode> extends SnaptradeCustom<TAuth> {
|
|
|
11103
10480
|
readonly authentication: AuthenticationApi<TAuth>;
|
|
11104
10481
|
readonly connections: ConnectionsApi<TAuth>;
|
|
11105
10482
|
readonly experimentalEndpoints: ExperimentalEndpointsApi<TAuth>;
|
|
11106
|
-
readonly options: OptionsApi<TAuth>;
|
|
11107
10483
|
readonly referenceData: ReferenceDataApi<TAuth>;
|
|
11108
10484
|
readonly trading: TradingApi<TAuth>;
|
|
11109
|
-
readonly transactionsAndReporting: TransactionsAndReportingApi<TAuth>;
|
|
11110
10485
|
constructor(configurationParameters: ConfigurationParameters<TAuth>);
|
|
11111
10486
|
}
|
|
11112
10487
|
//#endregion
|
|
@@ -11157,4 +10532,4 @@ declare class SnaptradeError extends Error {
|
|
|
11157
10532
|
declare function readableStreamToString(stream: ReadableStream): Promise<string>;
|
|
11158
10533
|
declare function parseIfJson(input: unknown): object | unknown;
|
|
11159
10534
|
//#endregion
|
|
11160
|
-
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, AccountInformationApiGetAllAccountPositionsBaseRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllAccountPositionsRequestByAuthMode, AccountInformationApiGetAllAccountPositionscommercialApiKeyRequest, AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest, AccountInformationApiGetAllUserHoldingsBaseRequest, AccountInformationApiGetAllUserHoldingsRequest, AccountInformationApiGetAllUserHoldingsRequestByAuthMode, AccountInformationApiGetAllUserHoldingscommercialApiKeyRequest, AccountInformationApiGetAllUserHoldingspersonalApiKeyRequest, AccountInformationApiGetUserAccountBalanceBaseRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountBalanceRequestByAuthMode, AccountInformationApiGetUserAccountBalancecommercialApiKeyRequest, AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest, AccountInformationApiGetUserAccountDetailsBaseRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountDetailsRequestByAuthMode, AccountInformationApiGetUserAccountDetailscommercialApiKeyRequest, AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailBaseRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode, AccountInformationApiGetUserAccountOrderDetailcommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest, AccountInformationApiGetUserAccountOrdersBaseRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountOrdersRequestByAuthMode, AccountInformationApiGetUserAccountOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountPositionsBaseRequest, AccountInformationApiGetUserAccountPositionsRequest, AccountInformationApiGetUserAccountPositionsRequestByAuthMode, AccountInformationApiGetUserAccountPositionscommercialApiKeyRequest, AccountInformationApiGetUserAccountPositionspersonalApiKeyRequest, AccountInformationApiGetUserAccountRecentOrdersBaseRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode, AccountInformationApiGetUserAccountRecentOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountReturnRatesBaseRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode, AccountInformationApiGetUserAccountReturnRatescommercialApiKeyRequest, AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest, AccountInformationApiGetUserHoldingsBaseRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiGetUserHoldingsRequestByAuthMode, AccountInformationApiGetUserHoldingscommercialApiKeyRequest, AccountInformationApiGetUserHoldingspersonalApiKeyRequest, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityCurrencyUniversalSymbol, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserBaseRequest, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiDeleteSnapTradeUserRequestByAuthMode, AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserBaseRequest, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiLoginSnapTradeUserRequestByAuthMode, AuthenticationApiLoginSnapTradeUsercommercialApiKeyRequest, AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest, AuthenticationApiRegisterSnapTradeUserBaseRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequestByAuthMode, AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest, AuthenticationApiResetSnapTradeUserSecretBaseRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode, AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, CfdInstrument, ChildBrokerageOrderIDs, CommercialApiKeyAuth, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConfigurationParametersShared, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionBaseRequest, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDeleteConnectionRequestByAuthMode, ConnectionsApiDeleteConnectioncommercialApiKeyRequest, ConnectionsApiDeleteConnectionpersonalApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationBaseRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDetailBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationBaseRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDisableBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsBaseRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationAccountscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest, ConnectionsApiListBrokerageAuthorizationsBaseRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationBaseRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode, ConnectionsApiRefreshBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiRemoveBrokerageAuthorizationBaseRequest, ConnectionsApiRemoveBrokerageAuthorizationRequest, ConnectionsApiRemoveBrokerageAuthorizationRequestByAuthMode, ConnectionsApiRemoveBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiRemoveBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiReturnRatesBaseRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiReturnRatesRequestByAuthMode, ConnectionsApiReturnRatescommercialApiKeyRequest, ConnectionsApiReturnRatespersonalApiKeyRequest, ConnectionsApiSessionEventsBaseRequest, ConnectionsApiSessionEventsRequest, ConnectionsApiSessionEventsRequestByAuthMode, ConnectionsApiSessionEventscommercialApiKeyRequest, ConnectionsApiSessionEventspersonalApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsBaseRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode, ConnectionsApiSyncBrokerageAuthorizationTransactionscommercialApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest, ConnectionsSessionEvents200ResponseInner, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteConnectionConfirmation, DeleteUserResponse, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionBaseRequest, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode, ExperimentalEndpointsApiAddSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionBaseRequest, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode, ExperimentalEndpointsApiCancelSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrderDetailV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest, FigiInstrument, FutureInstrument, HoldingsStatus, Instrument, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsApi, OptionsApiAxiosParamCreator, OptionsApiFactory, OptionsApiFp, OptionsApiGenerated, OptionsApiListOptionHoldingsBaseRequest, OptionsApiListOptionHoldingsRequest, OptionsApiListOptionHoldingsRequestByAuthMode, OptionsApiListOptionHoldingscommercialApiKeyRequest, OptionsApiListOptionHoldingspersonalApiKeyRequest, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetCurrencyExchangeRatePairBaseRequest, ReferenceDataApiGetCurrencyExchangeRatePairRequest, ReferenceDataApiGetCurrencyExchangeRatePairRequestByAuthMode, ReferenceDataApiGetCurrencyExchangeRatePaircommercialApiKeyRequest, ReferenceDataApiGetCurrencyExchangeRatePairpersonalApiKeyRequest, ReferenceDataApiGetSymbolsBaseRequest, ReferenceDataApiGetSymbolsByTickerBaseRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsByTickerRequestByAuthMode, ReferenceDataApiGetSymbolsByTickercommercialApiKeyRequest, ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiGetSymbolsRequestByAuthMode, ReferenceDataApiGetSymbolscommercialApiKeyRequest, ReferenceDataApiGetSymbolspersonalApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeBaseRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode, ReferenceDataApiListAllBrokerageAuthorizationTypecommercialApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentsBaseRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode, ReferenceDataApiListAllBrokerageInstrumentscommercialApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountBaseRequest, ReferenceDataApiSymbolSearchUserAccountRequest, ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode, ReferenceDataApiSymbolSearchUserAccountcommercialApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest, SecurityType, SessionEvent, SimpleOrderForm, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol$1 as Symbol, SymbolCurrency, SymbolExchange, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderBaseRequest, TradingApiCancelOrderRequest, TradingApiCancelOrderRequestByAuthMode, TradingApiCancelOrdercommercialApiKeyRequest, TradingApiCancelOrderpersonalApiKeyRequest, TradingApiCancelUserAccountOrderBaseRequest, TradingApiCancelUserAccountOrderRequest, TradingApiCancelUserAccountOrderRequestByAuthMode, TradingApiCancelUserAccountOrdercommercialApiKeyRequest, TradingApiCancelUserAccountOrderpersonalApiKeyRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteBaseRequest, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode, TradingApiGetCryptocurrencyPairQuotecommercialApiKeyRequest, TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest, TradingApiGetOptionImpactBaseRequest, TradingApiGetOptionImpactRequest, TradingApiGetOptionImpactRequestByAuthMode, TradingApiGetOptionImpactcommercialApiKeyRequest, TradingApiGetOptionImpactpersonalApiKeyRequest, TradingApiGetOrderImpactBaseRequest, TradingApiGetOrderImpactRequest, TradingApiGetOrderImpactRequestByAuthMode, TradingApiGetOrderImpactcommercialApiKeyRequest, TradingApiGetOrderImpactpersonalApiKeyRequest, TradingApiGetUserAccountOptionQuotesBaseRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountOptionQuotesRequestByAuthMode, TradingApiGetUserAccountOptionQuotescommercialApiKeyRequest, TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest, TradingApiGetUserAccountQuotesBaseRequest, TradingApiGetUserAccountQuotesRequest, TradingApiGetUserAccountQuotesRequestByAuthMode, TradingApiGetUserAccountQuotescommercialApiKeyRequest, TradingApiGetUserAccountQuotespersonalApiKeyRequest, TradingApiPlaceBracketOrderBaseRequest, TradingApiPlaceBracketOrderRequest, TradingApiPlaceBracketOrderRequestByAuthMode, TradingApiPlaceBracketOrdercommercialApiKeyRequest, TradingApiPlaceBracketOrderpersonalApiKeyRequest, TradingApiPlaceComplexOrderBaseRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceComplexOrderRequestByAuthMode, TradingApiPlaceComplexOrdercommercialApiKeyRequest, TradingApiPlaceComplexOrderpersonalApiKeyRequest, TradingApiPlaceCryptoOrderBaseRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceCryptoOrderRequestByAuthMode, TradingApiPlaceCryptoOrdercommercialApiKeyRequest, TradingApiPlaceCryptoOrderpersonalApiKeyRequest, TradingApiPlaceForceOrderBaseRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceForceOrderRequestByAuthMode, TradingApiPlaceForceOrdercommercialApiKeyRequest, TradingApiPlaceForceOrderpersonalApiKeyRequest, TradingApiPlaceMlegOrderBaseRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceMlegOrderRequestByAuthMode, TradingApiPlaceMlegOrdercommercialApiKeyRequest, TradingApiPlaceMlegOrderpersonalApiKeyRequest, TradingApiPlaceOrderBaseRequest, TradingApiPlaceOrderRequest, TradingApiPlaceOrderRequestByAuthMode, TradingApiPlaceOrdercommercialApiKeyRequest, TradingApiPlaceOrderpersonalApiKeyRequest, TradingApiPreviewCryptoOrderBaseRequest, TradingApiPreviewCryptoOrderRequest, TradingApiPreviewCryptoOrderRequestByAuthMode, TradingApiPreviewCryptoOrdercommercialApiKeyRequest, TradingApiPreviewCryptoOrderpersonalApiKeyRequest, TradingApiReplaceOrderBaseRequest, TradingApiReplaceOrderRequest, TradingApiReplaceOrderRequestByAuthMode, TradingApiReplaceOrdercommercialApiKeyRequest, TradingApiReplaceOrderpersonalApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentsBaseRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode, TradingApiSearchCryptocurrencyPairInstrumentscommercialApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsAndReportingApi, TransactionsAndReportingApiAxiosParamCreator, TransactionsAndReportingApiFactory, TransactionsAndReportingApiFp, TransactionsAndReportingApiGenerated, TransactionsAndReportingApiGetActivitiesBaseRequest, TransactionsAndReportingApiGetActivitiesRequest, TransactionsAndReportingApiGetActivitiesRequestByAuthMode, TransactionsAndReportingApiGetActivitiescommercialApiKeyRequest, TransactionsAndReportingApiGetActivitiespersonalApiKeyRequest, TransactionsAndReportingApiGetReportingCustomRangeBaseRequest, TransactionsAndReportingApiGetReportingCustomRangeRequest, TransactionsAndReportingApiGetReportingCustomRangeRequestByAuthMode, TransactionsAndReportingApiGetReportingCustomRangecommercialApiKeyRequest, TransactionsAndReportingApiGetReportingCustomRangepersonalApiKeyRequest, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|
|
10535
|
+
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, AccountInformationApiGetAllAccountPositionsBaseRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllAccountPositionsRequestByAuthMode, AccountInformationApiGetAllAccountPositionscommercialApiKeyRequest, AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest, AccountInformationApiGetUserAccountBalanceBaseRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountBalanceRequestByAuthMode, AccountInformationApiGetUserAccountBalancecommercialApiKeyRequest, AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest, AccountInformationApiGetUserAccountDetailsBaseRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountDetailsRequestByAuthMode, AccountInformationApiGetUserAccountDetailscommercialApiKeyRequest, AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailBaseRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode, AccountInformationApiGetUserAccountOrderDetailcommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest, AccountInformationApiGetUserAccountOrdersBaseRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountOrdersRequestByAuthMode, AccountInformationApiGetUserAccountOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountRecentOrdersBaseRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode, AccountInformationApiGetUserAccountRecentOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountReturnRatesBaseRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode, AccountInformationApiGetUserAccountReturnRatescommercialApiKeyRequest, AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest, AccountInformationApiGetUserHoldingsBaseRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiGetUserHoldingsRequestByAuthMode, AccountInformationApiGetUserHoldingscommercialApiKeyRequest, AccountInformationApiGetUserHoldingspersonalApiKeyRequest, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityCurrencyUniversalSymbol, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserBaseRequest, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiDeleteSnapTradeUserRequestByAuthMode, AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserBaseRequest, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiLoginSnapTradeUserRequestByAuthMode, AuthenticationApiLoginSnapTradeUsercommercialApiKeyRequest, AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest, AuthenticationApiRegisterSnapTradeUserBaseRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequestByAuthMode, AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest, AuthenticationApiResetSnapTradeUserSecretBaseRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode, AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, CfdInstrument, ChildBrokerageOrderIDs, CommercialApiKeyAuth, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConfigurationParametersShared, ConnectionAccount, ConnectionAccountSyncStatus, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionBaseRequest, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDeleteConnectionRequestByAuthMode, ConnectionsApiDeleteConnectioncommercialApiKeyRequest, ConnectionsApiDeleteConnectionpersonalApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationBaseRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDetailBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationBaseRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDisableBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsBaseRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationAccountscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest, ConnectionsApiListBrokerageAuthorizationsBaseRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationBaseRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode, ConnectionsApiRefreshBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiReturnRatesBaseRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiReturnRatesRequestByAuthMode, ConnectionsApiReturnRatescommercialApiKeyRequest, ConnectionsApiReturnRatespersonalApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsBaseRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode, ConnectionsApiSyncBrokerageAuthorizationTransactionscommercialApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, DeleteConnectionConfirmation, DeleteUserResponse, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionBaseRequest, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode, ExperimentalEndpointsApiAddSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionBaseRequest, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode, ExperimentalEndpointsApiCancelSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrderDetailV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiListConnectionAccountsBaseRequest, ExperimentalEndpointsApiListConnectionAccountsRequest, ExperimentalEndpointsApiListConnectionAccountsRequestByAuthMode, ExperimentalEndpointsApiListConnectionAccountscommercialApiKeyRequest, ExperimentalEndpointsApiListConnectionAccountspersonalApiKeyRequest, FigiInstrument, FutureInstrument, HoldingsStatus, Instrument, InvestmentAccount, InvestmentAccountMarketValue, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetSymbolsBaseRequest, ReferenceDataApiGetSymbolsByTickerBaseRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsByTickerRequestByAuthMode, ReferenceDataApiGetSymbolsByTickercommercialApiKeyRequest, ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiGetSymbolsRequestByAuthMode, ReferenceDataApiGetSymbolscommercialApiKeyRequest, ReferenceDataApiGetSymbolspersonalApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeBaseRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode, ReferenceDataApiListAllBrokerageAuthorizationTypecommercialApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentsBaseRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode, ReferenceDataApiListAllBrokerageInstrumentscommercialApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountBaseRequest, ReferenceDataApiSymbolSearchUserAccountRequest, ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode, ReferenceDataApiSymbolSearchUserAccountcommercialApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest, SecurityType, SessionEvent, SimpleOrderForm, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderBaseRequest, TradingApiCancelOrderRequest, TradingApiCancelOrderRequestByAuthMode, TradingApiCancelOrdercommercialApiKeyRequest, TradingApiCancelOrderpersonalApiKeyRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteBaseRequest, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode, TradingApiGetCryptocurrencyPairQuotecommercialApiKeyRequest, TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest, TradingApiGetOptionImpactBaseRequest, TradingApiGetOptionImpactRequest, TradingApiGetOptionImpactRequestByAuthMode, TradingApiGetOptionImpactcommercialApiKeyRequest, TradingApiGetOptionImpactpersonalApiKeyRequest, TradingApiGetOrderImpactBaseRequest, TradingApiGetOrderImpactRequest, TradingApiGetOrderImpactRequestByAuthMode, TradingApiGetOrderImpactcommercialApiKeyRequest, TradingApiGetOrderImpactpersonalApiKeyRequest, TradingApiGetUserAccountOptionQuotesBaseRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountOptionQuotesRequestByAuthMode, TradingApiGetUserAccountOptionQuotescommercialApiKeyRequest, TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest, TradingApiGetUserAccountQuotesBaseRequest, TradingApiGetUserAccountQuotesRequest, TradingApiGetUserAccountQuotesRequestByAuthMode, TradingApiGetUserAccountQuotescommercialApiKeyRequest, TradingApiGetUserAccountQuotespersonalApiKeyRequest, TradingApiPlaceComplexOrderBaseRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceComplexOrderRequestByAuthMode, TradingApiPlaceComplexOrdercommercialApiKeyRequest, TradingApiPlaceComplexOrderpersonalApiKeyRequest, TradingApiPlaceCryptoOrderBaseRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceCryptoOrderRequestByAuthMode, TradingApiPlaceCryptoOrdercommercialApiKeyRequest, TradingApiPlaceCryptoOrderpersonalApiKeyRequest, TradingApiPlaceForceOrderBaseRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceForceOrderRequestByAuthMode, TradingApiPlaceForceOrdercommercialApiKeyRequest, TradingApiPlaceForceOrderpersonalApiKeyRequest, TradingApiPlaceMlegOrderBaseRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceMlegOrderRequestByAuthMode, TradingApiPlaceMlegOrdercommercialApiKeyRequest, TradingApiPlaceMlegOrderpersonalApiKeyRequest, TradingApiPlaceOrderBaseRequest, TradingApiPlaceOrderRequest, TradingApiPlaceOrderRequestByAuthMode, TradingApiPlaceOrdercommercialApiKeyRequest, TradingApiPlaceOrderpersonalApiKeyRequest, TradingApiPreviewCryptoOrderBaseRequest, TradingApiPreviewCryptoOrderRequest, TradingApiPreviewCryptoOrderRequestByAuthMode, TradingApiPreviewCryptoOrdercommercialApiKeyRequest, TradingApiPreviewCryptoOrderpersonalApiKeyRequest, TradingApiReplaceOrderBaseRequest, TradingApiReplaceOrderRequest, TradingApiReplaceOrderRequestByAuthMode, TradingApiReplaceOrdercommercialApiKeyRequest, TradingApiReplaceOrderpersonalApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentsBaseRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode, TradingApiSearchCryptocurrencyPairInstrumentscommercialApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|