snaptrade-typescript-sdk 12.2.23 → 13.0.1
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 +1 -1
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +344 -345
- package/dist/index.d.mts +344 -345
- package/dist/index.d.ts +344 -345
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { AxiosError, AxiosInstance, AxiosPromise, AxiosRequestConfig } from "axios";
|
|
1
|
+
import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
|
|
3
2
|
|
|
4
3
|
//#region auth.d.ts
|
|
5
4
|
declare class CommercialApiKeyAuth {
|
|
@@ -244,7 +243,7 @@ interface AccountSyncStatus {
|
|
|
244
243
|
* @interface Account
|
|
245
244
|
*/
|
|
246
245
|
interface Account {
|
|
247
|
-
[key: string]:
|
|
246
|
+
[key: string]: unknown;
|
|
248
247
|
/**
|
|
249
248
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
|
|
250
249
|
* @type {string}
|
|
@@ -331,12 +330,12 @@ interface Account {
|
|
|
331
330
|
'account_category'?: AccountAccountCategoryEnum;
|
|
332
331
|
/**
|
|
333
332
|
* Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
|
|
334
|
-
* @type {{ [key: string]:
|
|
333
|
+
* @type {{ [key: string]: unknown; }}
|
|
335
334
|
* @memberof Account
|
|
336
335
|
* @deprecated
|
|
337
336
|
*/
|
|
338
337
|
'meta'?: {
|
|
339
|
-
[key: string]:
|
|
338
|
+
[key: string]: unknown;
|
|
340
339
|
};
|
|
341
340
|
/**
|
|
342
341
|
* Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.
|
|
@@ -396,7 +395,7 @@ interface BalanceCurrency {
|
|
|
396
395
|
* @interface Balance
|
|
397
396
|
*/
|
|
398
397
|
interface Balance {
|
|
399
|
-
[key: string]:
|
|
398
|
+
[key: string]: unknown;
|
|
400
399
|
/**
|
|
401
400
|
*
|
|
402
401
|
* @type {BalanceCurrency}
|
|
@@ -451,7 +450,7 @@ interface PositionCurrency {
|
|
|
451
450
|
* @interface Currency
|
|
452
451
|
*/
|
|
453
452
|
interface Currency {
|
|
454
|
-
[key: string]:
|
|
453
|
+
[key: string]: unknown;
|
|
455
454
|
/**
|
|
456
455
|
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
457
456
|
* @type {string}
|
|
@@ -479,7 +478,7 @@ interface Currency {
|
|
|
479
478
|
* @interface FigiInstrumentNullable
|
|
480
479
|
*/
|
|
481
480
|
interface FigiInstrumentNullable {
|
|
482
|
-
[key: string]:
|
|
481
|
+
[key: string]: unknown;
|
|
483
482
|
/**
|
|
484
483
|
* This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
|
|
485
484
|
* @type {string}
|
|
@@ -501,7 +500,7 @@ interface FigiInstrumentNullable {
|
|
|
501
500
|
* @interface SecurityType
|
|
502
501
|
*/
|
|
503
502
|
interface SecurityType {
|
|
504
|
-
[key: string]:
|
|
503
|
+
[key: string]: unknown;
|
|
505
504
|
/**
|
|
506
505
|
* Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
|
|
507
506
|
* @type {string}
|
|
@@ -620,7 +619,7 @@ interface SymbolExchange {
|
|
|
620
619
|
* @interface UniversalSymbol
|
|
621
620
|
*/
|
|
622
621
|
interface UniversalSymbol {
|
|
623
|
-
[key: string]:
|
|
622
|
+
[key: string]: unknown;
|
|
624
623
|
/**
|
|
625
624
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
626
625
|
* @type {string}
|
|
@@ -691,7 +690,7 @@ interface UniversalSymbol {
|
|
|
691
690
|
* @interface PositionSymbol
|
|
692
691
|
*/
|
|
693
692
|
interface PositionSymbol {
|
|
694
|
-
[key: string]:
|
|
693
|
+
[key: string]: unknown;
|
|
695
694
|
/**
|
|
696
695
|
*
|
|
697
696
|
* @type {UniversalSymbol}
|
|
@@ -742,7 +741,7 @@ interface PositionSymbol {
|
|
|
742
741
|
* @interface TaxLot
|
|
743
742
|
*/
|
|
744
743
|
interface TaxLot {
|
|
745
|
-
[key: string]:
|
|
744
|
+
[key: string]: unknown;
|
|
746
745
|
/**
|
|
747
746
|
* The date and time of the purchase.
|
|
748
747
|
* @type {string}
|
|
@@ -794,7 +793,7 @@ interface TaxLot {
|
|
|
794
793
|
* @interface Position
|
|
795
794
|
*/
|
|
796
795
|
interface Position {
|
|
797
|
-
[key: string]:
|
|
796
|
+
[key: string]: unknown;
|
|
798
797
|
/**
|
|
799
798
|
*
|
|
800
799
|
* @type {PositionSymbol}
|
|
@@ -859,7 +858,7 @@ interface Position {
|
|
|
859
858
|
* @interface BrokerageType
|
|
860
859
|
*/
|
|
861
860
|
interface BrokerageType {
|
|
862
|
-
[key: string]:
|
|
861
|
+
[key: string]: unknown;
|
|
863
862
|
/**
|
|
864
863
|
*
|
|
865
864
|
* @type {string}
|
|
@@ -881,7 +880,7 @@ interface BrokerageType {
|
|
|
881
880
|
* @interface Brokerage
|
|
882
881
|
*/
|
|
883
882
|
interface Brokerage {
|
|
884
|
-
[key: string]:
|
|
883
|
+
[key: string]: unknown;
|
|
885
884
|
/**
|
|
886
885
|
* Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
|
|
887
886
|
* @type {string}
|
|
@@ -1004,7 +1003,7 @@ interface Brokerage {
|
|
|
1004
1003
|
* @interface BrokerageAuthorizationDataFreshnessMode
|
|
1005
1004
|
*/
|
|
1006
1005
|
interface BrokerageAuthorizationDataFreshnessMode {
|
|
1007
|
-
[key: string]:
|
|
1006
|
+
[key: string]: unknown;
|
|
1008
1007
|
/**
|
|
1009
1008
|
* Indicates the freshness of the data provided by the institution. `realtime` means the institution provides current data; `delayed` means the institution itself does not allow intra-day data updates.
|
|
1010
1009
|
* @type {string}
|
|
@@ -1028,7 +1027,7 @@ type BrokerageAuthorizationDataFreshnessModeSnaptradeEnum = 'realtime' | 'delaye
|
|
|
1028
1027
|
* @interface BrokerageAuthorization
|
|
1029
1028
|
*/
|
|
1030
1029
|
interface BrokerageAuthorization {
|
|
1031
|
-
[key: string]:
|
|
1030
|
+
[key: string]: unknown;
|
|
1032
1031
|
/**
|
|
1033
1032
|
* Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
|
|
1034
1033
|
* @type {string}
|
|
@@ -1073,12 +1072,12 @@ interface BrokerageAuthorization {
|
|
|
1073
1072
|
'disabled_date'?: string | null;
|
|
1074
1073
|
/**
|
|
1075
1074
|
* Additional data about the connection. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
|
|
1076
|
-
* @type {{ [key: string]:
|
|
1075
|
+
* @type {{ [key: string]: unknown; }}
|
|
1077
1076
|
* @memberof BrokerageAuthorization
|
|
1078
1077
|
* @deprecated
|
|
1079
1078
|
*/
|
|
1080
1079
|
'meta'?: {
|
|
1081
|
-
[key: string]:
|
|
1080
|
+
[key: string]: unknown;
|
|
1082
1081
|
};
|
|
1083
1082
|
/**
|
|
1084
1083
|
* Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
|
|
@@ -1108,7 +1107,7 @@ interface BrokerageAuthorization {
|
|
|
1108
1107
|
* @interface SnapTradeHoldingsAccount
|
|
1109
1108
|
*/
|
|
1110
1109
|
interface SnapTradeHoldingsAccount {
|
|
1111
|
-
[key: string]:
|
|
1110
|
+
[key: string]: unknown;
|
|
1112
1111
|
/**
|
|
1113
1112
|
*
|
|
1114
1113
|
* @type {string}
|
|
@@ -1153,11 +1152,11 @@ interface SnapTradeHoldingsAccount {
|
|
|
1153
1152
|
'sync_status'?: AccountSyncStatus;
|
|
1154
1153
|
/**
|
|
1155
1154
|
*
|
|
1156
|
-
* @type {{ [key: string]:
|
|
1155
|
+
* @type {{ [key: string]: unknown; }}
|
|
1157
1156
|
* @memberof SnapTradeHoldingsAccount
|
|
1158
1157
|
*/
|
|
1159
1158
|
'meta'?: {
|
|
1160
|
-
[key: string]:
|
|
1159
|
+
[key: string]: unknown;
|
|
1161
1160
|
};
|
|
1162
1161
|
}
|
|
1163
1162
|
//#endregion
|
|
@@ -1168,7 +1167,7 @@ interface SnapTradeHoldingsAccount {
|
|
|
1168
1167
|
* @interface SnapTradeHoldingsTotalValue
|
|
1169
1168
|
*/
|
|
1170
1169
|
interface SnapTradeHoldingsTotalValue {
|
|
1171
|
-
[key: string]:
|
|
1170
|
+
[key: string]: unknown;
|
|
1172
1171
|
/**
|
|
1173
1172
|
* Total value denominated in the currency of the `currency` field.
|
|
1174
1173
|
* @type {number}
|
|
@@ -1190,7 +1189,7 @@ interface SnapTradeHoldingsTotalValue {
|
|
|
1190
1189
|
* @interface AccountHoldings
|
|
1191
1190
|
*/
|
|
1192
1191
|
interface AccountHoldings {
|
|
1193
|
-
[key: string]:
|
|
1192
|
+
[key: string]: unknown;
|
|
1194
1193
|
/**
|
|
1195
1194
|
*
|
|
1196
1195
|
* @type {SnapTradeHoldingsAccount}
|
|
@@ -1233,7 +1232,7 @@ type AccountOrderRecordStatus = 'NONE' | 'PENDING' | 'ACCEPTED' | 'FAILED' | 'RE
|
|
|
1233
1232
|
* @interface ChildBrokerageOrderIDsNullable
|
|
1234
1233
|
*/
|
|
1235
1234
|
interface ChildBrokerageOrderIDsNullable {
|
|
1236
|
-
[key: string]:
|
|
1235
|
+
[key: string]: unknown;
|
|
1237
1236
|
/**
|
|
1238
1237
|
* The brokerage order ID for the take profit leg of the bracket order
|
|
1239
1238
|
* @type {string}
|
|
@@ -1255,7 +1254,7 @@ interface ChildBrokerageOrderIDsNullable {
|
|
|
1255
1254
|
* @interface CurrencyNullable
|
|
1256
1255
|
*/
|
|
1257
1256
|
interface CurrencyNullable {
|
|
1258
|
-
[key: string]:
|
|
1257
|
+
[key: string]: unknown;
|
|
1259
1258
|
/**
|
|
1260
1259
|
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
1261
1260
|
* @type {string}
|
|
@@ -1380,7 +1379,7 @@ interface UnderlyingSymbolType {
|
|
|
1380
1379
|
* @interface UnderlyingSymbol
|
|
1381
1380
|
*/
|
|
1382
1381
|
interface UnderlyingSymbol {
|
|
1383
|
-
[key: string]:
|
|
1382
|
+
[key: string]: unknown;
|
|
1384
1383
|
/**
|
|
1385
1384
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1386
1385
|
* @type {string}
|
|
@@ -1451,7 +1450,7 @@ interface UnderlyingSymbol {
|
|
|
1451
1450
|
* @interface OptionsSymbolNullable
|
|
1452
1451
|
*/
|
|
1453
1452
|
interface OptionsSymbolNullable {
|
|
1454
|
-
[key: string]:
|
|
1453
|
+
[key: string]: unknown;
|
|
1455
1454
|
/**
|
|
1456
1455
|
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1457
1456
|
* @type {string}
|
|
@@ -1504,7 +1503,7 @@ type OptionsSymbolNullableOptionTypeEnum = 'CALL' | 'PUT';
|
|
|
1504
1503
|
* @interface TrailingStopNullable
|
|
1505
1504
|
*/
|
|
1506
1505
|
interface TrailingStopNullable {
|
|
1507
|
-
[key: string]:
|
|
1506
|
+
[key: string]: unknown;
|
|
1508
1507
|
/**
|
|
1509
1508
|
* The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`.
|
|
1510
1509
|
* @type {string}
|
|
@@ -1527,7 +1526,7 @@ type TrailingStopNullableTypeEnum = 'DOLLAR' | 'PERCENT';
|
|
|
1527
1526
|
* @interface UniversalSymbolNullable
|
|
1528
1527
|
*/
|
|
1529
1528
|
interface UniversalSymbolNullable {
|
|
1530
|
-
[key: string]:
|
|
1529
|
+
[key: string]: unknown;
|
|
1531
1530
|
/**
|
|
1532
1531
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1533
1532
|
* @type {string}
|
|
@@ -1598,7 +1597,7 @@ interface UniversalSymbolNullable {
|
|
|
1598
1597
|
* @interface AccountOrderRecord
|
|
1599
1598
|
*/
|
|
1600
1599
|
interface AccountOrderRecord {
|
|
1601
|
-
[key: string]:
|
|
1600
|
+
[key: string]: unknown;
|
|
1602
1601
|
/**
|
|
1603
1602
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
1604
1603
|
* @type {string}
|
|
@@ -1760,7 +1759,7 @@ type AccountOrderRecordOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
1760
1759
|
* @interface OptionsSymbol
|
|
1761
1760
|
*/
|
|
1762
1761
|
interface OptionsSymbol {
|
|
1763
|
-
[key: string]:
|
|
1762
|
+
[key: string]: unknown;
|
|
1764
1763
|
/**
|
|
1765
1764
|
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1766
1765
|
* @type {string}
|
|
@@ -1813,7 +1812,7 @@ type OptionsSymbolOptionTypeEnum = 'CALL' | 'PUT';
|
|
|
1813
1812
|
* @interface OptionBrokerageSymbol
|
|
1814
1813
|
*/
|
|
1815
1814
|
interface OptionBrokerageSymbol {
|
|
1816
|
-
[key: string]:
|
|
1815
|
+
[key: string]: unknown;
|
|
1817
1816
|
/**
|
|
1818
1817
|
*
|
|
1819
1818
|
* @type {OptionsSymbol}
|
|
@@ -1843,7 +1842,7 @@ interface OptionBrokerageSymbol {
|
|
|
1843
1842
|
* @interface OptionsPosition
|
|
1844
1843
|
*/
|
|
1845
1844
|
interface OptionsPosition {
|
|
1846
|
-
[key: string]:
|
|
1845
|
+
[key: string]: unknown;
|
|
1847
1846
|
/**
|
|
1848
1847
|
*
|
|
1849
1848
|
* @type {OptionBrokerageSymbol}
|
|
@@ -1883,7 +1882,7 @@ interface OptionsPosition {
|
|
|
1883
1882
|
* @interface AccountHoldingsAccount
|
|
1884
1883
|
*/
|
|
1885
1884
|
interface AccountHoldingsAccount {
|
|
1886
|
-
[key: string]:
|
|
1885
|
+
[key: string]: unknown;
|
|
1887
1886
|
/**
|
|
1888
1887
|
*
|
|
1889
1888
|
* @type {Account}
|
|
@@ -1945,7 +1944,7 @@ interface AccountInformationGetUserAccountOrderDetailRequest {
|
|
|
1945
1944
|
* @interface AccountInformationGetUserHoldings409Response
|
|
1946
1945
|
*/
|
|
1947
1946
|
interface AccountInformationGetUserHoldings409Response {
|
|
1948
|
-
[key: string]:
|
|
1947
|
+
[key: string]: unknown;
|
|
1949
1948
|
/**
|
|
1950
1949
|
*
|
|
1951
1950
|
* @type {string}
|
|
@@ -1973,7 +1972,7 @@ interface AccountInformationGetUserHoldings409Response {
|
|
|
1973
1972
|
* @interface AccountOrderRecordLegInstrument
|
|
1974
1973
|
*/
|
|
1975
1974
|
interface AccountOrderRecordLegInstrument {
|
|
1976
|
-
[key: string]:
|
|
1975
|
+
[key: string]: unknown;
|
|
1977
1976
|
/**
|
|
1978
1977
|
* The symbol or ticker for the security.
|
|
1979
1978
|
* @type {string}
|
|
@@ -2021,7 +2020,7 @@ type AccountOrderRecordStatusV2Nullable = 'PENDING' | 'REJECTED' | 'CANCELED' |
|
|
|
2021
2020
|
* @interface AccountOrderRecordLeg
|
|
2022
2021
|
*/
|
|
2023
2022
|
interface AccountOrderRecordLeg {
|
|
2024
|
-
[key: string]:
|
|
2023
|
+
[key: string]: unknown;
|
|
2025
2024
|
/**
|
|
2026
2025
|
* Brokerage order identifier for this leg, if available.
|
|
2027
2026
|
* @type {string}
|
|
@@ -2079,7 +2078,7 @@ interface AccountOrderRecordLeg {
|
|
|
2079
2078
|
* @interface AccountOrderRecordNullable
|
|
2080
2079
|
*/
|
|
2081
2080
|
interface AccountOrderRecordNullable {
|
|
2082
|
-
[key: string]:
|
|
2081
|
+
[key: string]: unknown;
|
|
2083
2082
|
/**
|
|
2084
2083
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
2085
2084
|
* @type {string}
|
|
@@ -2257,7 +2256,7 @@ type AccountOrderRecordV2OrderRoleNullable = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
2257
2256
|
* @interface AccountOrderRecordV2
|
|
2258
2257
|
*/
|
|
2259
2258
|
interface AccountOrderRecordV2 {
|
|
2260
|
-
[key: string]:
|
|
2259
|
+
[key: string]: unknown;
|
|
2261
2260
|
/**
|
|
2262
2261
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
2263
2262
|
* @type {string}
|
|
@@ -2366,7 +2365,7 @@ type AccountOrderRecordV2OrderRole = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
2366
2365
|
* @interface AccountOrdersV2Response
|
|
2367
2366
|
*/
|
|
2368
2367
|
interface AccountOrdersV2Response {
|
|
2369
|
-
[key: string]:
|
|
2368
|
+
[key: string]: unknown;
|
|
2370
2369
|
/**
|
|
2371
2370
|
* List of orders returned by the endpoint.
|
|
2372
2371
|
* @type {Array<AccountOrderRecordV2>}
|
|
@@ -2382,7 +2381,7 @@ interface AccountOrdersV2Response {
|
|
|
2382
2381
|
* @interface AdrInstrument
|
|
2383
2382
|
*/
|
|
2384
2383
|
interface AdrInstrument {
|
|
2385
|
-
[key: string]:
|
|
2384
|
+
[key: string]: unknown;
|
|
2386
2385
|
/**
|
|
2387
2386
|
* Type of security instrument.
|
|
2388
2387
|
* @type {string}
|
|
@@ -2441,7 +2440,7 @@ type AdrInstrumentKindEnum = 'adr';
|
|
|
2441
2440
|
* @interface CefInstrument
|
|
2442
2441
|
*/
|
|
2443
2442
|
interface CefInstrument {
|
|
2444
|
-
[key: string]:
|
|
2443
|
+
[key: string]: unknown;
|
|
2445
2444
|
/**
|
|
2446
2445
|
* Type of security instrument.
|
|
2447
2446
|
* @type {string}
|
|
@@ -2500,7 +2499,7 @@ type CefInstrumentKindEnum = 'cef';
|
|
|
2500
2499
|
* @interface CryptoInstrument
|
|
2501
2500
|
*/
|
|
2502
2501
|
interface CryptoInstrument {
|
|
2503
|
-
[key: string]:
|
|
2502
|
+
[key: string]: unknown;
|
|
2504
2503
|
/**
|
|
2505
2504
|
* Type of security instrument.
|
|
2506
2505
|
* @type {string}
|
|
@@ -2560,7 +2559,7 @@ type CryptoInstrumentKindEnum = 'crypto';
|
|
|
2560
2559
|
* @interface EtfInstrument
|
|
2561
2560
|
*/
|
|
2562
2561
|
interface EtfInstrument {
|
|
2563
|
-
[key: string]:
|
|
2562
|
+
[key: string]: unknown;
|
|
2564
2563
|
/**
|
|
2565
2564
|
* Type of security instrument.
|
|
2566
2565
|
* @type {string}
|
|
@@ -2619,7 +2618,7 @@ type EtfInstrumentKindEnum = 'etf';
|
|
|
2619
2618
|
* @interface MutualFundInstrument
|
|
2620
2619
|
*/
|
|
2621
2620
|
interface MutualFundInstrument {
|
|
2622
|
-
[key: string]:
|
|
2621
|
+
[key: string]: unknown;
|
|
2623
2622
|
/**
|
|
2624
2623
|
* Type of security instrument.
|
|
2625
2624
|
* @type {string}
|
|
@@ -2678,7 +2677,7 @@ type MutualFundInstrumentKindEnum = 'mutualfund';
|
|
|
2678
2677
|
* @interface OtherInstrument
|
|
2679
2678
|
*/
|
|
2680
2679
|
interface OtherInstrument {
|
|
2681
|
-
[key: string]:
|
|
2680
|
+
[key: string]: unknown;
|
|
2682
2681
|
/**
|
|
2683
2682
|
* Type of security instrument.
|
|
2684
2683
|
* @type {string}
|
|
@@ -2737,7 +2736,7 @@ type OtherInstrumentKindEnum = 'bond' | 'other';
|
|
|
2737
2736
|
* @interface StockInstrument
|
|
2738
2737
|
*/
|
|
2739
2738
|
interface StockInstrument {
|
|
2740
|
-
[key: string]:
|
|
2739
|
+
[key: string]: unknown;
|
|
2741
2740
|
/**
|
|
2742
2741
|
* Type of security instrument.
|
|
2743
2742
|
* @type {string}
|
|
@@ -2820,7 +2819,7 @@ type UnderlyingCfdInstrument = {
|
|
|
2820
2819
|
* @interface CfdInstrument
|
|
2821
2820
|
*/
|
|
2822
2821
|
interface CfdInstrument {
|
|
2823
|
-
[key: string]:
|
|
2822
|
+
[key: string]: unknown;
|
|
2824
2823
|
/**
|
|
2825
2824
|
* Type of security instrument.
|
|
2826
2825
|
* @type {string}
|
|
@@ -2879,7 +2878,7 @@ type CfdInstrumentKindEnum = 'cfd';
|
|
|
2879
2878
|
* @interface FutureInstrument
|
|
2880
2879
|
*/
|
|
2881
2880
|
interface FutureInstrument {
|
|
2882
|
-
[key: string]:
|
|
2881
|
+
[key: string]: unknown;
|
|
2883
2882
|
/**
|
|
2884
2883
|
* Type of security instrument.
|
|
2885
2884
|
* @type {string}
|
|
@@ -2944,7 +2943,7 @@ type FutureInstrumentKindEnum = 'future';
|
|
|
2944
2943
|
* @interface FutureOptionInstrument
|
|
2945
2944
|
*/
|
|
2946
2945
|
interface FutureOptionInstrument {
|
|
2947
|
-
[key: string]:
|
|
2946
|
+
[key: string]: unknown;
|
|
2948
2947
|
/**
|
|
2949
2948
|
* Type of security instrument.
|
|
2950
2949
|
* @type {string}
|
|
@@ -3046,7 +3045,7 @@ type UnderlyingOptionInstrument = {
|
|
|
3046
3045
|
* @interface OptionInstrument
|
|
3047
3046
|
*/
|
|
3048
3047
|
interface OptionInstrument {
|
|
3049
|
-
[key: string]:
|
|
3048
|
+
[key: string]: unknown;
|
|
3050
3049
|
/**
|
|
3051
3050
|
* Type of security instrument.
|
|
3052
3051
|
* @type {string}
|
|
@@ -3124,7 +3123,7 @@ type UnderlyingTokenizedAssetInstrument = {
|
|
|
3124
3123
|
* @interface TokenizedAssetInstrument
|
|
3125
3124
|
*/
|
|
3126
3125
|
interface TokenizedAssetInstrument {
|
|
3127
|
-
[key: string]:
|
|
3126
|
+
[key: string]: unknown;
|
|
3128
3127
|
/**
|
|
3129
3128
|
* Type of security instrument.
|
|
3130
3129
|
* @type {string}
|
|
@@ -3199,7 +3198,7 @@ type Instrument = {
|
|
|
3199
3198
|
* @interface AccountPosition
|
|
3200
3199
|
*/
|
|
3201
3200
|
interface AccountPosition {
|
|
3202
|
-
[key: string]:
|
|
3201
|
+
[key: string]: unknown;
|
|
3203
3202
|
/**
|
|
3204
3203
|
*
|
|
3205
3204
|
* @type {Instrument}
|
|
@@ -3251,7 +3250,7 @@ interface AccountPosition {
|
|
|
3251
3250
|
* @interface AccountSimple
|
|
3252
3251
|
*/
|
|
3253
3252
|
interface AccountSimple {
|
|
3254
|
-
[key: string]:
|
|
3253
|
+
[key: string]: unknown;
|
|
3255
3254
|
/**
|
|
3256
3255
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
3257
3256
|
* @type {string}
|
|
@@ -3291,7 +3290,7 @@ interface AccountSimple {
|
|
|
3291
3290
|
* @interface SymbolNullable
|
|
3292
3291
|
*/
|
|
3293
3292
|
interface SymbolNullable {
|
|
3294
|
-
[key: string]:
|
|
3293
|
+
[key: string]: unknown;
|
|
3295
3294
|
/**
|
|
3296
3295
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
3297
3296
|
* @type {string}
|
|
@@ -3355,7 +3354,7 @@ interface SymbolNullable {
|
|
|
3355
3354
|
* @interface AccountUniversalActivity
|
|
3356
3355
|
*/
|
|
3357
3356
|
interface AccountUniversalActivity {
|
|
3358
|
-
[key: string]:
|
|
3357
|
+
[key: string]: unknown;
|
|
3359
3358
|
/**
|
|
3360
3359
|
* Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade. Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.
|
|
3361
3360
|
* @type {string}
|
|
@@ -3467,7 +3466,7 @@ interface AccountUniversalActivity {
|
|
|
3467
3466
|
* @interface AccountValueHistoryItem
|
|
3468
3467
|
*/
|
|
3469
3468
|
interface AccountValueHistoryItem {
|
|
3470
|
-
[key: string]:
|
|
3469
|
+
[key: string]: unknown;
|
|
3471
3470
|
/**
|
|
3472
3471
|
* The date of the estimated account value
|
|
3473
3472
|
* @type {string}
|
|
@@ -3489,7 +3488,7 @@ interface AccountValueHistoryItem {
|
|
|
3489
3488
|
* @interface AccountValueHistoryResponse
|
|
3490
3489
|
*/
|
|
3491
3490
|
interface AccountValueHistoryResponse {
|
|
3492
|
-
[key: string]:
|
|
3491
|
+
[key: string]: unknown;
|
|
3493
3492
|
/**
|
|
3494
3493
|
* List of estimated account values over time returned by the endpoint. The data may contain gaps and is best used for charting trends, rather than as a complete or exact record of historical account values.
|
|
3495
3494
|
* @type {Array<AccountValueHistoryItem>}
|
|
@@ -3527,7 +3526,7 @@ type ActionStrictWithOptions = 'BUY' | 'SELL' | 'BUY_TO_OPEN' | 'BUY_TO_CLOSE' |
|
|
|
3527
3526
|
* @interface AllAccountPositionsResponseDataFreshness
|
|
3528
3527
|
*/
|
|
3529
3528
|
interface AllAccountPositionsResponseDataFreshness {
|
|
3530
|
-
[key: string]:
|
|
3529
|
+
[key: string]: unknown;
|
|
3531
3530
|
/**
|
|
3532
3531
|
* The time the returned positions data was fetched from the brokerage.
|
|
3533
3532
|
* @type {string}
|
|
@@ -3543,7 +3542,7 @@ interface AllAccountPositionsResponseDataFreshness {
|
|
|
3543
3542
|
* @interface AllAccountPositionsResponse
|
|
3544
3543
|
*/
|
|
3545
3544
|
interface AllAccountPositionsResponse {
|
|
3546
|
-
[key: string]:
|
|
3545
|
+
[key: string]: unknown;
|
|
3547
3546
|
/**
|
|
3548
3547
|
* Positions returned for the request.
|
|
3549
3548
|
* @type {Array<AccountPosition>}
|
|
@@ -3565,7 +3564,7 @@ interface AllAccountPositionsResponse {
|
|
|
3565
3564
|
* @interface DepositAccountNetValue
|
|
3566
3565
|
*/
|
|
3567
3566
|
interface DepositAccountNetValue {
|
|
3568
|
-
[key: string]:
|
|
3567
|
+
[key: string]: unknown;
|
|
3569
3568
|
/**
|
|
3570
3569
|
*
|
|
3571
3570
|
* @type {number}
|
|
@@ -3587,7 +3586,7 @@ interface DepositAccountNetValue {
|
|
|
3587
3586
|
* @interface DepositAccountSyncStatus
|
|
3588
3587
|
*/
|
|
3589
3588
|
interface DepositAccountSyncStatus {
|
|
3590
|
-
[key: string]:
|
|
3589
|
+
[key: string]: unknown;
|
|
3591
3590
|
/**
|
|
3592
3591
|
*
|
|
3593
3592
|
* @type {TransactionsStatus}
|
|
@@ -3609,7 +3608,7 @@ interface DepositAccountSyncStatus {
|
|
|
3609
3608
|
* @interface DepositAccount
|
|
3610
3609
|
*/
|
|
3611
3610
|
interface DepositAccount {
|
|
3612
|
-
[key: string]:
|
|
3611
|
+
[key: string]: unknown;
|
|
3613
3612
|
/**
|
|
3614
3613
|
* Discriminator for the account kind.
|
|
3615
3614
|
* @type {string}
|
|
@@ -3686,7 +3685,7 @@ type DepositAccountKindEnum = 'deposit';
|
|
|
3686
3685
|
* @interface ConnectionAccountSyncStatus
|
|
3687
3686
|
*/
|
|
3688
3687
|
interface ConnectionAccountSyncStatus {
|
|
3689
|
-
[key: string]:
|
|
3688
|
+
[key: string]: unknown;
|
|
3690
3689
|
/**
|
|
3691
3690
|
*
|
|
3692
3691
|
* @type {TransactionsStatus}
|
|
@@ -3720,7 +3719,7 @@ interface ConnectionAccountSyncStatus {
|
|
|
3720
3719
|
* @interface InvestmentAccountNetValue
|
|
3721
3720
|
*/
|
|
3722
3721
|
interface InvestmentAccountNetValue {
|
|
3723
|
-
[key: string]:
|
|
3722
|
+
[key: string]: unknown;
|
|
3724
3723
|
/**
|
|
3725
3724
|
*
|
|
3726
3725
|
* @type {number}
|
|
@@ -3742,7 +3741,7 @@ interface InvestmentAccountNetValue {
|
|
|
3742
3741
|
* @interface InvestmentAccount
|
|
3743
3742
|
*/
|
|
3744
3743
|
interface InvestmentAccount {
|
|
3745
|
-
[key: string]:
|
|
3744
|
+
[key: string]: unknown;
|
|
3746
3745
|
/**
|
|
3747
3746
|
* Discriminator for the account kind.
|
|
3748
3747
|
* @type {string}
|
|
@@ -3838,7 +3837,7 @@ type InvestmentAccountCashOrMarginEnum = 'cash' | 'margin' | 'unknown';
|
|
|
3838
3837
|
* @interface LineOfCreditAccountAvailableCredit
|
|
3839
3838
|
*/
|
|
3840
3839
|
interface LineOfCreditAccountAvailableCredit {
|
|
3841
|
-
[key: string]:
|
|
3840
|
+
[key: string]: unknown;
|
|
3842
3841
|
/**
|
|
3843
3842
|
*
|
|
3844
3843
|
* @type {number}
|
|
@@ -3860,7 +3859,7 @@ interface LineOfCreditAccountAvailableCredit {
|
|
|
3860
3859
|
* @interface LineOfCreditAccountMinimumPaymentAmount
|
|
3861
3860
|
*/
|
|
3862
3861
|
interface LineOfCreditAccountMinimumPaymentAmount {
|
|
3863
|
-
[key: string]:
|
|
3862
|
+
[key: string]: unknown;
|
|
3864
3863
|
/**
|
|
3865
3864
|
*
|
|
3866
3865
|
* @type {number}
|
|
@@ -3882,7 +3881,7 @@ interface LineOfCreditAccountMinimumPaymentAmount {
|
|
|
3882
3881
|
* @interface LineOfCreditAccountNetValue
|
|
3883
3882
|
*/
|
|
3884
3883
|
interface LineOfCreditAccountNetValue {
|
|
3885
|
-
[key: string]:
|
|
3884
|
+
[key: string]: unknown;
|
|
3886
3885
|
/**
|
|
3887
3886
|
*
|
|
3888
3887
|
* @type {number}
|
|
@@ -3904,7 +3903,7 @@ interface LineOfCreditAccountNetValue {
|
|
|
3904
3903
|
* @interface LineOfCreditAccountSyncStatus
|
|
3905
3904
|
*/
|
|
3906
3905
|
interface LineOfCreditAccountSyncStatus {
|
|
3907
|
-
[key: string]:
|
|
3906
|
+
[key: string]: unknown;
|
|
3908
3907
|
/**
|
|
3909
3908
|
*
|
|
3910
3909
|
* @type {TransactionsStatus}
|
|
@@ -3926,7 +3925,7 @@ interface LineOfCreditAccountSyncStatus {
|
|
|
3926
3925
|
* @interface LineOfCreditAccount
|
|
3927
3926
|
*/
|
|
3928
3927
|
interface LineOfCreditAccount {
|
|
3929
|
-
[key: string]:
|
|
3928
|
+
[key: string]: unknown;
|
|
3930
3929
|
/**
|
|
3931
3930
|
* Discriminator for the account kind.
|
|
3932
3931
|
* @type {string}
|
|
@@ -4035,7 +4034,7 @@ type ConnectionAccount = {
|
|
|
4035
4034
|
* @interface AllUserAccountsResponse
|
|
4036
4035
|
*/
|
|
4037
4036
|
interface AllUserAccountsResponse {
|
|
4038
|
-
[key: string]:
|
|
4037
|
+
[key: string]: unknown;
|
|
4039
4038
|
/**
|
|
4040
4039
|
* Accounts returned for the request.
|
|
4041
4040
|
* @type {Array<ConnectionAccount>}
|
|
@@ -4051,7 +4050,7 @@ interface AllUserAccountsResponse {
|
|
|
4051
4050
|
* @interface EncryptedResponseEncryptedMessageData
|
|
4052
4051
|
*/
|
|
4053
4052
|
interface EncryptedResponseEncryptedMessageData {
|
|
4054
|
-
[key: string]:
|
|
4053
|
+
[key: string]: unknown;
|
|
4055
4054
|
/**
|
|
4056
4055
|
*
|
|
4057
4056
|
* @type {string}
|
|
@@ -4128,7 +4127,7 @@ type AuthenticationLoginSnapTradeUser200Response = EncryptedResponse | LoginRedi
|
|
|
4128
4127
|
* @interface BrokerageAuthorizationDisabledConfirmation
|
|
4129
4128
|
*/
|
|
4130
4129
|
interface BrokerageAuthorizationDisabledConfirmation {
|
|
4131
|
-
[key: string]:
|
|
4130
|
+
[key: string]: unknown;
|
|
4132
4131
|
/**
|
|
4133
4132
|
* Connection disabled confirmation
|
|
4134
4133
|
* @type {string}
|
|
@@ -4144,7 +4143,7 @@ interface BrokerageAuthorizationDisabledConfirmation {
|
|
|
4144
4143
|
* @interface BrokerageAuthorizationRefreshConfirmation
|
|
4145
4144
|
*/
|
|
4146
4145
|
interface BrokerageAuthorizationRefreshConfirmation {
|
|
4147
|
-
[key: string]:
|
|
4146
|
+
[key: string]: unknown;
|
|
4148
4147
|
/**
|
|
4149
4148
|
* Refresh confirmation details
|
|
4150
4149
|
* @type {string}
|
|
@@ -4160,7 +4159,7 @@ interface BrokerageAuthorizationRefreshConfirmation {
|
|
|
4160
4159
|
* @interface BrokerageAuthorizationTransactionsSyncConfirmation
|
|
4161
4160
|
*/
|
|
4162
4161
|
interface BrokerageAuthorizationTransactionsSyncConfirmation {
|
|
4163
|
-
[key: string]:
|
|
4162
|
+
[key: string]: unknown;
|
|
4164
4163
|
/**
|
|
4165
4164
|
* Transactions sync confirmation details
|
|
4166
4165
|
* @type {string}
|
|
@@ -4176,7 +4175,7 @@ interface BrokerageAuthorizationTransactionsSyncConfirmation {
|
|
|
4176
4175
|
* @interface BrokerageAuthorizationTypeReadOnlyBrokerage
|
|
4177
4176
|
*/
|
|
4178
4177
|
interface BrokerageAuthorizationTypeReadOnlyBrokerage {
|
|
4179
|
-
[key: string]:
|
|
4178
|
+
[key: string]: unknown;
|
|
4180
4179
|
/**
|
|
4181
4180
|
*
|
|
4182
4181
|
* @type {string}
|
|
@@ -4204,7 +4203,7 @@ interface BrokerageAuthorizationTypeReadOnlyBrokerage {
|
|
|
4204
4203
|
* @interface BrokerageAuthorizationTypeReadOnly
|
|
4205
4204
|
*/
|
|
4206
4205
|
interface BrokerageAuthorizationTypeReadOnly {
|
|
4207
|
-
[key: string]:
|
|
4206
|
+
[key: string]: unknown;
|
|
4208
4207
|
/**
|
|
4209
4208
|
*
|
|
4210
4209
|
* @type {string}
|
|
@@ -4240,7 +4239,7 @@ type BrokerageAuthorizationTypeReadOnlyAuthTypeEnum = 'OAUTH' | 'SCRAPE' | 'UNOF
|
|
|
4240
4239
|
* @interface BrokerageInstrument
|
|
4241
4240
|
*/
|
|
4242
4241
|
interface BrokerageInstrument {
|
|
4243
|
-
[key: string]:
|
|
4242
|
+
[key: string]: unknown;
|
|
4244
4243
|
/**
|
|
4245
4244
|
* The instrument\'s trading symbol / ticker.
|
|
4246
4245
|
* @type {string}
|
|
@@ -4280,7 +4279,7 @@ interface BrokerageInstrument {
|
|
|
4280
4279
|
* @interface BrokerageInstrumentsResponse
|
|
4281
4280
|
*/
|
|
4282
4281
|
interface BrokerageInstrumentsResponse {
|
|
4283
|
-
[key: string]:
|
|
4282
|
+
[key: string]: unknown;
|
|
4284
4283
|
/**
|
|
4285
4284
|
*
|
|
4286
4285
|
* @type {Array<BrokerageInstrument>}
|
|
@@ -4296,7 +4295,7 @@ interface BrokerageInstrumentsResponse {
|
|
|
4296
4295
|
* @interface CancelOrderResponse
|
|
4297
4296
|
*/
|
|
4298
4297
|
interface CancelOrderResponse {
|
|
4299
|
-
[key: string]:
|
|
4298
|
+
[key: string]: unknown;
|
|
4300
4299
|
/**
|
|
4301
4300
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
4302
4301
|
* @type {string}
|
|
@@ -4305,11 +4304,11 @@ interface CancelOrderResponse {
|
|
|
4305
4304
|
'brokerage_order_id': string;
|
|
4306
4305
|
/**
|
|
4307
4306
|
* The raw response from the brokerage.
|
|
4308
|
-
* @type {{ [key: string]:
|
|
4307
|
+
* @type {{ [key: string]: unknown; }}
|
|
4309
4308
|
* @memberof CancelOrderResponse
|
|
4310
4309
|
*/
|
|
4311
4310
|
'raw_response'?: {
|
|
4312
|
-
[key: string]:
|
|
4311
|
+
[key: string]: unknown;
|
|
4313
4312
|
} | null;
|
|
4314
4313
|
}
|
|
4315
4314
|
//#endregion
|
|
@@ -4320,7 +4319,7 @@ interface CancelOrderResponse {
|
|
|
4320
4319
|
* @interface ChildBrokerageOrderIDs
|
|
4321
4320
|
*/
|
|
4322
4321
|
interface ChildBrokerageOrderIDs {
|
|
4323
|
-
[key: string]:
|
|
4322
|
+
[key: string]: unknown;
|
|
4324
4323
|
/**
|
|
4325
4324
|
* The brokerage order ID for the take profit leg of the bracket order
|
|
4326
4325
|
* @type {string}
|
|
@@ -4358,7 +4357,7 @@ type TimeInForceStrict = 'FOK' | 'Day' | 'GTC' | 'IOC';
|
|
|
4358
4357
|
* @interface TradingInstrument
|
|
4359
4358
|
*/
|
|
4360
4359
|
interface TradingInstrument {
|
|
4361
|
-
[key: string]:
|
|
4360
|
+
[key: string]: unknown;
|
|
4362
4361
|
/**
|
|
4363
4362
|
* The instrument\'s trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
|
|
4364
4363
|
* @type {string}
|
|
@@ -4381,7 +4380,7 @@ type TradingInstrumentTypeEnum = 'EQUITY' | 'OPTION' | 'CRYPTOCURRENCY' | 'CRYPT
|
|
|
4381
4380
|
* @interface ComplexOrderLeg
|
|
4382
4381
|
*/
|
|
4383
4382
|
interface ComplexOrderLeg {
|
|
4384
|
-
[key: string]:
|
|
4383
|
+
[key: string]: unknown;
|
|
4385
4384
|
/**
|
|
4386
4385
|
* The role of this leg within the complex order.
|
|
4387
4386
|
* @type {string}
|
|
@@ -4440,7 +4439,7 @@ type ComplexOrderLegOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
4440
4439
|
* @interface ComplexOrderResponse
|
|
4441
4440
|
*/
|
|
4442
4441
|
interface ComplexOrderResponse {
|
|
4443
|
-
[key: string]:
|
|
4442
|
+
[key: string]: unknown;
|
|
4444
4443
|
/**
|
|
4445
4444
|
* The complex order type that was placed.
|
|
4446
4445
|
* @type {string}
|
|
@@ -4463,7 +4462,7 @@ type ComplexOrderResponseTypeEnum = 'OCO' | 'OTO' | 'OTOCO';
|
|
|
4463
4462
|
* @interface ConnectionAccountsResponse
|
|
4464
4463
|
*/
|
|
4465
4464
|
interface ConnectionAccountsResponse {
|
|
4466
|
-
[key: string]:
|
|
4465
|
+
[key: string]: unknown;
|
|
4467
4466
|
/**
|
|
4468
4467
|
* Accounts returned for the request.
|
|
4469
4468
|
* @type {Array<ConnectionAccount>}
|
|
@@ -4479,7 +4478,7 @@ interface ConnectionAccountsResponse {
|
|
|
4479
4478
|
* @interface CryptoTradingInstrument
|
|
4480
4479
|
*/
|
|
4481
4480
|
interface CryptoTradingInstrument {
|
|
4482
|
-
[key: string]:
|
|
4481
|
+
[key: string]: unknown;
|
|
4483
4482
|
/**
|
|
4484
4483
|
* The instrument\'s trading ticker symbol
|
|
4485
4484
|
* @type {string}
|
|
@@ -4567,7 +4566,7 @@ type CryptoOrderFormTimeInForceEnum = 'GTC' | 'FOK' | 'IOC' | 'GTD';
|
|
|
4567
4566
|
* @interface CryptoOrderPreviewEstimatedFee
|
|
4568
4567
|
*/
|
|
4569
4568
|
interface CryptoOrderPreviewEstimatedFee {
|
|
4570
|
-
[key: string]:
|
|
4569
|
+
[key: string]: unknown;
|
|
4571
4570
|
/**
|
|
4572
4571
|
* Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes.
|
|
4573
4572
|
* @type {string}
|
|
@@ -4589,7 +4588,7 @@ interface CryptoOrderPreviewEstimatedFee {
|
|
|
4589
4588
|
* @interface CryptoOrderPreview
|
|
4590
4589
|
*/
|
|
4591
4590
|
interface CryptoOrderPreview {
|
|
4592
|
-
[key: string]:
|
|
4591
|
+
[key: string]: unknown;
|
|
4593
4592
|
/**
|
|
4594
4593
|
*
|
|
4595
4594
|
* @type {CryptoOrderPreviewEstimatedFee}
|
|
@@ -4605,7 +4604,7 @@ interface CryptoOrderPreview {
|
|
|
4605
4604
|
* @interface CryptocurrencyPair
|
|
4606
4605
|
*/
|
|
4607
4606
|
interface CryptocurrencyPair {
|
|
4608
|
-
[key: string]:
|
|
4607
|
+
[key: string]: unknown;
|
|
4609
4608
|
/**
|
|
4610
4609
|
* Cryptocurrency pair instrument symbol
|
|
4611
4610
|
* @type {string}
|
|
@@ -4639,7 +4638,7 @@ interface CryptocurrencyPair {
|
|
|
4639
4638
|
* @interface CryptocurrencyPairQuote
|
|
4640
4639
|
*/
|
|
4641
4640
|
interface CryptocurrencyPairQuote {
|
|
4642
|
-
[key: string]:
|
|
4641
|
+
[key: string]: unknown;
|
|
4643
4642
|
/**
|
|
4644
4643
|
* The highest price a buyer is willing to pay.
|
|
4645
4644
|
* @type {string}
|
|
@@ -4673,7 +4672,7 @@ interface CryptocurrencyPairQuote {
|
|
|
4673
4672
|
* @interface DeleteConnectionConfirmation
|
|
4674
4673
|
*/
|
|
4675
4674
|
interface DeleteConnectionConfirmation {
|
|
4676
|
-
[key: string]:
|
|
4675
|
+
[key: string]: unknown;
|
|
4677
4676
|
/**
|
|
4678
4677
|
* Connection queued for deletion; please wait for webhook for confirmation.
|
|
4679
4678
|
* @type {string}
|
|
@@ -4695,7 +4694,7 @@ interface DeleteConnectionConfirmation {
|
|
|
4695
4694
|
* @interface DeleteUserResponse
|
|
4696
4695
|
*/
|
|
4697
4696
|
interface DeleteUserResponse {
|
|
4698
|
-
[key: string]:
|
|
4697
|
+
[key: string]: unknown;
|
|
4699
4698
|
/**
|
|
4700
4699
|
* This is always `deleted` when a user is queued for deletion.
|
|
4701
4700
|
* @type {string}
|
|
@@ -4723,7 +4722,7 @@ interface DeleteUserResponse {
|
|
|
4723
4722
|
* @interface DividendAtDate
|
|
4724
4723
|
*/
|
|
4725
4724
|
interface DividendAtDate {
|
|
4726
|
-
[key: string]:
|
|
4725
|
+
[key: string]: unknown;
|
|
4727
4726
|
/**
|
|
4728
4727
|
* The ticker of the symbol that the dividend came from
|
|
4729
4728
|
* @type {string}
|
|
@@ -4751,7 +4750,7 @@ interface DividendAtDate {
|
|
|
4751
4750
|
* @interface Exchange
|
|
4752
4751
|
*/
|
|
4753
4752
|
interface Exchange {
|
|
4754
|
-
[key: string]:
|
|
4753
|
+
[key: string]: unknown;
|
|
4755
4754
|
/**
|
|
4756
4755
|
* Unique ID for the exchange in SnapTrade.
|
|
4757
4756
|
* @type {string}
|
|
@@ -4809,7 +4808,7 @@ interface Exchange {
|
|
|
4809
4808
|
* @interface ExchangeRatePairs
|
|
4810
4809
|
*/
|
|
4811
4810
|
interface ExchangeRatePairs {
|
|
4812
|
-
[key: string]:
|
|
4811
|
+
[key: string]: unknown;
|
|
4813
4812
|
/**
|
|
4814
4813
|
*
|
|
4815
4814
|
* @type {Currency}
|
|
@@ -4837,7 +4836,7 @@ interface ExchangeRatePairs {
|
|
|
4837
4836
|
* @interface FigiInstrument
|
|
4838
4837
|
*/
|
|
4839
4838
|
interface FigiInstrument {
|
|
4840
|
-
[key: string]:
|
|
4839
|
+
[key: string]: unknown;
|
|
4841
4840
|
/**
|
|
4842
4841
|
* This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
|
|
4843
4842
|
* @type {string}
|
|
@@ -4859,7 +4858,7 @@ interface FigiInstrument {
|
|
|
4859
4858
|
* @interface InstitutionConnectionNullable
|
|
4860
4859
|
*/
|
|
4861
4860
|
interface InstitutionConnectionNullable {
|
|
4862
|
-
[key: string]:
|
|
4861
|
+
[key: string]: unknown;
|
|
4863
4862
|
/**
|
|
4864
4863
|
* Ways an end user can connect. - `OAUTH`: the user signs in on the institution\'s own site and approves access. - `CREDENTIALS`: the user enters their login details in the SnapTrade Connection Portal. - `API_KEY`: the user creates an API key at the institution and pastes it in.
|
|
4865
4864
|
* @type {Array<string>}
|
|
@@ -4883,7 +4882,7 @@ type InstitutionConnectionNullableScopesEnum = 'READ' | 'TRADE';
|
|
|
4883
4882
|
* @interface Institution
|
|
4884
4883
|
*/
|
|
4885
4884
|
interface Institution {
|
|
4886
|
-
[key: string]:
|
|
4885
|
+
[key: string]: unknown;
|
|
4887
4886
|
/**
|
|
4888
4887
|
* A short, unique identifier for the institution. It is usually the name in capital letters and will never change. It matches the `slug` of the same brokerage in `GET /brokerages`.
|
|
4889
4888
|
* @type {string}
|
|
@@ -4961,7 +4960,7 @@ type InstitutionRegionsEnum = 'US' | 'CA' | 'EUROPE' | 'AU' | 'IN';
|
|
|
4961
4960
|
* @interface InstitutionConnection
|
|
4962
4961
|
*/
|
|
4963
4962
|
interface InstitutionConnection {
|
|
4964
|
-
[key: string]:
|
|
4963
|
+
[key: string]: unknown;
|
|
4965
4964
|
/**
|
|
4966
4965
|
* Ways an end user can connect. - `OAUTH`: the user signs in on the institution\'s own site and approves access. - `CREDENTIALS`: the user enters their login details in the SnapTrade Connection Portal. - `API_KEY`: the user creates an API key at the institution and pastes it in.
|
|
4967
4966
|
* @type {Array<string>}
|
|
@@ -4985,7 +4984,7 @@ type InstitutionConnectionScopesEnum = 'READ' | 'TRADE';
|
|
|
4985
4984
|
* @interface ManualTradeSymbol
|
|
4986
4985
|
*/
|
|
4987
4986
|
interface ManualTradeSymbol {
|
|
4988
|
-
[key: string]:
|
|
4987
|
+
[key: string]: unknown;
|
|
4989
4988
|
/**
|
|
4990
4989
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
4991
4990
|
* @type {string}
|
|
@@ -5035,7 +5034,7 @@ interface ManualTradeSymbol {
|
|
|
5035
5034
|
* @interface ManualTrade
|
|
5036
5035
|
*/
|
|
5037
5036
|
interface ManualTrade {
|
|
5038
|
-
[key: string]:
|
|
5037
|
+
[key: string]: unknown;
|
|
5039
5038
|
/**
|
|
5040
5039
|
* Unique identifier for the submitted order through SnapTrade.
|
|
5041
5040
|
* @type {string}
|
|
@@ -5093,7 +5092,7 @@ interface ManualTrade {
|
|
|
5093
5092
|
* @interface ManualTradeBalance
|
|
5094
5093
|
*/
|
|
5095
5094
|
interface ManualTradeBalance {
|
|
5096
|
-
[key: string]:
|
|
5095
|
+
[key: string]: unknown;
|
|
5097
5096
|
/**
|
|
5098
5097
|
*
|
|
5099
5098
|
* @type {AccountSimple}
|
|
@@ -5121,7 +5120,7 @@ interface ManualTradeBalance {
|
|
|
5121
5120
|
* @interface ManualTradeImpact
|
|
5122
5121
|
*/
|
|
5123
5122
|
interface ManualTradeImpact {
|
|
5124
|
-
[key: string]:
|
|
5123
|
+
[key: string]: unknown;
|
|
5125
5124
|
/**
|
|
5126
5125
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
5127
5126
|
* @type {string}
|
|
@@ -5161,7 +5160,7 @@ interface ManualTradeImpact {
|
|
|
5161
5160
|
* @interface ManualTradeAndImpact
|
|
5162
5161
|
*/
|
|
5163
5162
|
interface ManualTradeAndImpact {
|
|
5164
|
-
[key: string]:
|
|
5163
|
+
[key: string]: unknown;
|
|
5165
5164
|
/**
|
|
5166
5165
|
*
|
|
5167
5166
|
* @type {ManualTrade}
|
|
@@ -5260,7 +5259,7 @@ interface ManualTradeForm {
|
|
|
5260
5259
|
* @interface StopLoss
|
|
5261
5260
|
*/
|
|
5262
5261
|
interface StopLoss {
|
|
5263
|
-
[key: string]:
|
|
5262
|
+
[key: string]: unknown;
|
|
5264
5263
|
/**
|
|
5265
5264
|
*
|
|
5266
5265
|
* @type {string}
|
|
@@ -5282,7 +5281,7 @@ interface StopLoss {
|
|
|
5282
5281
|
* @interface TakeProfit
|
|
5283
5282
|
*/
|
|
5284
5283
|
interface TakeProfit {
|
|
5285
|
-
[key: string]:
|
|
5284
|
+
[key: string]: unknown;
|
|
5286
5285
|
/**
|
|
5287
5286
|
*
|
|
5288
5287
|
* @type {string}
|
|
@@ -5298,7 +5297,7 @@ interface TakeProfit {
|
|
|
5298
5297
|
* @interface ManualTradeFormBracket
|
|
5299
5298
|
*/
|
|
5300
5299
|
interface ManualTradeFormBracket {
|
|
5301
|
-
[key: string]:
|
|
5300
|
+
[key: string]: unknown;
|
|
5302
5301
|
/**
|
|
5303
5302
|
* 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.
|
|
5304
5303
|
* @type {ActionStrictWithOptions}
|
|
@@ -5566,7 +5565,7 @@ type MlegInstrumentType = 'OPTION' | 'EQUITY';
|
|
|
5566
5565
|
* @interface MlegTradingInstrument
|
|
5567
5566
|
*/
|
|
5568
5567
|
interface MlegTradingInstrument {
|
|
5569
|
-
[key: string]:
|
|
5568
|
+
[key: string]: unknown;
|
|
5570
5569
|
/**
|
|
5571
5570
|
* The security\'s trading ticker symbol. This currently supports stock symbols and Options symbols in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format)
|
|
5572
5571
|
* @type {string}
|
|
@@ -5588,7 +5587,7 @@ interface MlegTradingInstrument {
|
|
|
5588
5587
|
* @interface MlegLeg
|
|
5589
5588
|
*/
|
|
5590
5589
|
interface MlegLeg {
|
|
5591
|
-
[key: string]:
|
|
5590
|
+
[key: string]: unknown;
|
|
5592
5591
|
/**
|
|
5593
5592
|
*
|
|
5594
5593
|
* @type {MlegTradingInstrument}
|
|
@@ -5616,7 +5615,7 @@ interface MlegLeg {
|
|
|
5616
5615
|
* @interface MlegOrderResponse
|
|
5617
5616
|
*/
|
|
5618
5617
|
interface MlegOrderResponse {
|
|
5619
|
-
[key: string]:
|
|
5618
|
+
[key: string]: unknown;
|
|
5620
5619
|
/**
|
|
5621
5620
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
5622
5621
|
* @type {string}
|
|
@@ -5707,7 +5706,7 @@ interface MlegTradeForm {
|
|
|
5707
5706
|
* @interface Model400FailedRequestResponse
|
|
5708
5707
|
*/
|
|
5709
5708
|
interface Model400FailedRequestResponse {
|
|
5710
|
-
[key: string]:
|
|
5709
|
+
[key: string]: unknown;
|
|
5711
5710
|
/**
|
|
5712
5711
|
*
|
|
5713
5712
|
* @type {any}
|
|
@@ -5729,7 +5728,7 @@ interface Model400FailedRequestResponse {
|
|
|
5729
5728
|
* @interface Model401FailedRequestResponse
|
|
5730
5729
|
*/
|
|
5731
5730
|
interface Model401FailedRequestResponse {
|
|
5732
|
-
[key: string]:
|
|
5731
|
+
[key: string]: unknown;
|
|
5733
5732
|
/**
|
|
5734
5733
|
*
|
|
5735
5734
|
* @type {any}
|
|
@@ -5751,7 +5750,7 @@ interface Model401FailedRequestResponse {
|
|
|
5751
5750
|
* @interface Model402BrokerageAuthAlreadyDisabledException
|
|
5752
5751
|
*/
|
|
5753
5752
|
interface Model402BrokerageAuthAlreadyDisabledException {
|
|
5754
|
-
[key: string]:
|
|
5753
|
+
[key: string]: unknown;
|
|
5755
5754
|
/**
|
|
5756
5755
|
*
|
|
5757
5756
|
* @type {any}
|
|
@@ -5773,7 +5772,7 @@ interface Model402BrokerageAuthAlreadyDisabledException {
|
|
|
5773
5772
|
* @interface Model402BrokerageAuthDisabledResponse
|
|
5774
5773
|
*/
|
|
5775
5774
|
interface Model402BrokerageAuthDisabledResponse {
|
|
5776
|
-
[key: string]:
|
|
5775
|
+
[key: string]: unknown;
|
|
5777
5776
|
/**
|
|
5778
5777
|
*
|
|
5779
5778
|
* @type {any}
|
|
@@ -5795,7 +5794,7 @@ interface Model402BrokerageAuthDisabledResponse {
|
|
|
5795
5794
|
* @interface Model403FailedRequestResponse
|
|
5796
5795
|
*/
|
|
5797
5796
|
interface Model403FailedRequestResponse {
|
|
5798
|
-
[key: string]:
|
|
5797
|
+
[key: string]: unknown;
|
|
5799
5798
|
/**
|
|
5800
5799
|
*
|
|
5801
5800
|
* @type {any}
|
|
@@ -5817,7 +5816,7 @@ interface Model403FailedRequestResponse {
|
|
|
5817
5816
|
* @interface Model403FeatureNotEnabledResponse
|
|
5818
5817
|
*/
|
|
5819
5818
|
interface Model403FeatureNotEnabledResponse {
|
|
5820
|
-
[key: string]:
|
|
5819
|
+
[key: string]: unknown;
|
|
5821
5820
|
/**
|
|
5822
5821
|
*
|
|
5823
5822
|
* @type {any}
|
|
@@ -5839,7 +5838,7 @@ interface Model403FeatureNotEnabledResponse {
|
|
|
5839
5838
|
* @interface Model404FailedRequestResponse
|
|
5840
5839
|
*/
|
|
5841
5840
|
interface Model404FailedRequestResponse {
|
|
5842
|
-
[key: string]:
|
|
5841
|
+
[key: string]: unknown;
|
|
5843
5842
|
/**
|
|
5844
5843
|
*
|
|
5845
5844
|
* @type {any}
|
|
@@ -5861,7 +5860,7 @@ interface Model404FailedRequestResponse {
|
|
|
5861
5860
|
* @interface Model425FailedRequestResponse
|
|
5862
5861
|
*/
|
|
5863
5862
|
interface Model425FailedRequestResponse {
|
|
5864
|
-
[key: string]:
|
|
5863
|
+
[key: string]: unknown;
|
|
5865
5864
|
/**
|
|
5866
5865
|
*
|
|
5867
5866
|
* @type {any}
|
|
@@ -5883,7 +5882,7 @@ interface Model425FailedRequestResponse {
|
|
|
5883
5882
|
* @interface Model429TooManyRequestsResponse
|
|
5884
5883
|
*/
|
|
5885
5884
|
interface Model429TooManyRequestsResponse {
|
|
5886
|
-
[key: string]:
|
|
5885
|
+
[key: string]: unknown;
|
|
5887
5886
|
/**
|
|
5888
5887
|
*
|
|
5889
5888
|
* @type {any}
|
|
@@ -5911,7 +5910,7 @@ interface Model429TooManyRequestsResponse {
|
|
|
5911
5910
|
* @interface Model500UnexpectedExceptionResponse
|
|
5912
5911
|
*/
|
|
5913
5912
|
interface Model500UnexpectedExceptionResponse {
|
|
5914
|
-
[key: string]:
|
|
5913
|
+
[key: string]: unknown;
|
|
5915
5914
|
/**
|
|
5916
5915
|
*
|
|
5917
5916
|
* @type {any}
|
|
@@ -5939,7 +5938,7 @@ interface Model500UnexpectedExceptionResponse {
|
|
|
5939
5938
|
* @interface Model501NotImplementedResponse
|
|
5940
5939
|
*/
|
|
5941
5940
|
interface Model501NotImplementedResponse {
|
|
5942
|
-
[key: string]:
|
|
5941
|
+
[key: string]: unknown;
|
|
5943
5942
|
/**
|
|
5944
5943
|
*
|
|
5945
5944
|
* @type {any}
|
|
@@ -5955,7 +5954,7 @@ interface Model501NotImplementedResponse {
|
|
|
5955
5954
|
* @interface Model503BrokerageRequestResponse
|
|
5956
5955
|
*/
|
|
5957
5956
|
interface Model503BrokerageRequestResponse {
|
|
5958
|
-
[key: string]:
|
|
5957
|
+
[key: string]: unknown;
|
|
5959
5958
|
/**
|
|
5960
5959
|
*
|
|
5961
5960
|
* @type {any}
|
|
@@ -5983,7 +5982,7 @@ interface Model503BrokerageRequestResponse {
|
|
|
5983
5982
|
* @interface MonthlyDividends
|
|
5984
5983
|
*/
|
|
5985
5984
|
interface MonthlyDividends {
|
|
5986
|
-
[key: string]:
|
|
5985
|
+
[key: string]: unknown;
|
|
5987
5986
|
/**
|
|
5988
5987
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
5989
5988
|
* @type {string}
|
|
@@ -6005,7 +6004,7 @@ interface MonthlyDividends {
|
|
|
6005
6004
|
* @interface NetContributions
|
|
6006
6005
|
*/
|
|
6007
6006
|
interface NetContributions {
|
|
6008
|
-
[key: string]:
|
|
6007
|
+
[key: string]: unknown;
|
|
6009
6008
|
/**
|
|
6010
6009
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
6011
6010
|
* @type {string}
|
|
@@ -6033,7 +6032,7 @@ interface NetContributions {
|
|
|
6033
6032
|
* @interface NetDividend
|
|
6034
6033
|
*/
|
|
6035
6034
|
interface NetDividend {
|
|
6036
|
-
[key: string]:
|
|
6035
|
+
[key: string]: unknown;
|
|
6037
6036
|
/**
|
|
6038
6037
|
*
|
|
6039
6038
|
* @type {UniversalSymbol}
|
|
@@ -6069,7 +6068,7 @@ type NotionalValue = number | string;
|
|
|
6069
6068
|
* @interface OAuthWebhookBase
|
|
6070
6069
|
*/
|
|
6071
6070
|
interface OAuthWebhookBase {
|
|
6072
|
-
[key: string]:
|
|
6071
|
+
[key: string]: unknown;
|
|
6073
6072
|
/**
|
|
6074
6073
|
*
|
|
6075
6074
|
* @type {string}
|
|
@@ -6132,11 +6131,11 @@ interface OAuthWebhookBase {
|
|
|
6132
6131
|
'connectionAttemptedResult'?: string;
|
|
6133
6132
|
/**
|
|
6134
6133
|
*
|
|
6135
|
-
* @type {{ [key: string]:
|
|
6134
|
+
* @type {{ [key: string]: unknown; }}
|
|
6136
6135
|
* @memberof OAuthWebhookBase
|
|
6137
6136
|
*/
|
|
6138
6137
|
'details'?: {
|
|
6139
|
-
[key: string]:
|
|
6138
|
+
[key: string]: unknown;
|
|
6140
6139
|
};
|
|
6141
6140
|
}
|
|
6142
6141
|
type OAuthWebhookBaseSchemaVersionEnum = 'oauth_v1';
|
|
@@ -6148,7 +6147,7 @@ type OAuthWebhookBaseSchemaVersionEnum = 'oauth_v1';
|
|
|
6148
6147
|
* @interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
|
|
6149
6148
|
*/
|
|
6150
6149
|
interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
|
|
6151
|
-
[key: string]:
|
|
6150
|
+
[key: string]: unknown;
|
|
6152
6151
|
/**
|
|
6153
6152
|
*
|
|
6154
6153
|
* @type {number}
|
|
@@ -6176,7 +6175,7 @@ interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
|
|
|
6176
6175
|
* @interface OptionChainInnerChainPerRootInner
|
|
6177
6176
|
*/
|
|
6178
6177
|
interface OptionChainInnerChainPerRootInner {
|
|
6179
|
-
[key: string]:
|
|
6178
|
+
[key: string]: unknown;
|
|
6180
6179
|
/**
|
|
6181
6180
|
*
|
|
6182
6181
|
* @type {string}
|
|
@@ -6204,7 +6203,7 @@ interface OptionChainInnerChainPerRootInner {
|
|
|
6204
6203
|
* @interface OptionChainInner
|
|
6205
6204
|
*/
|
|
6206
6205
|
interface OptionChainInner {
|
|
6207
|
-
[key: string]:
|
|
6206
|
+
[key: string]: unknown;
|
|
6208
6207
|
/**
|
|
6209
6208
|
*
|
|
6210
6209
|
* @type {string}
|
|
@@ -6244,7 +6243,7 @@ interface OptionChainInner {
|
|
|
6244
6243
|
* @interface OptionImpact
|
|
6245
6244
|
*/
|
|
6246
6245
|
interface OptionImpact {
|
|
6247
|
-
[key: string]:
|
|
6246
|
+
[key: string]: unknown;
|
|
6248
6247
|
/**
|
|
6249
6248
|
* Estimated cash change for the order, before fees.
|
|
6250
6249
|
* @type {string}
|
|
@@ -6273,7 +6272,7 @@ type OptionImpactCashChangeDirectionEnum = 'CREDIT' | 'DEBIT' | 'EVEN' | 'UNKNOW
|
|
|
6273
6272
|
* @interface OptionLeg
|
|
6274
6273
|
*/
|
|
6275
6274
|
interface OptionLeg {
|
|
6276
|
-
[key: string]:
|
|
6275
|
+
[key: string]: unknown;
|
|
6277
6276
|
/**
|
|
6278
6277
|
*
|
|
6279
6278
|
* @type {string}
|
|
@@ -6302,7 +6301,7 @@ type OptionLegActionEnum = 'BUY_TO_OPEN' | 'BUY_TO_CLOSE' | 'SELL_TO_OPEN' | 'SE
|
|
|
6302
6301
|
* @interface OptionQuoteGreeks
|
|
6303
6302
|
*/
|
|
6304
6303
|
interface OptionQuoteGreeks {
|
|
6305
|
-
[key: string]:
|
|
6304
|
+
[key: string]: unknown;
|
|
6306
6305
|
/**
|
|
6307
6306
|
* Delta represents the rate of change between the option\'s price and a $1 change in the underlying asset\'s price.
|
|
6308
6307
|
* @type {number}
|
|
@@ -6336,7 +6335,7 @@ interface OptionQuoteGreeks {
|
|
|
6336
6335
|
* @interface OptionQuote
|
|
6337
6336
|
*/
|
|
6338
6337
|
interface OptionQuote {
|
|
6339
|
-
[key: string]:
|
|
6338
|
+
[key: string]: unknown;
|
|
6340
6339
|
/**
|
|
6341
6340
|
* The OCC-formatted option symbol.
|
|
6342
6341
|
* @type {string}
|
|
@@ -6409,7 +6408,7 @@ interface OptionStrategyLegsInner {
|
|
|
6409
6408
|
* @interface OptionStrategy
|
|
6410
6409
|
*/
|
|
6411
6410
|
interface OptionStrategy {
|
|
6412
|
-
[key: string]:
|
|
6411
|
+
[key: string]: unknown;
|
|
6413
6412
|
/**
|
|
6414
6413
|
*
|
|
6415
6414
|
* @type {string}
|
|
@@ -6449,7 +6448,7 @@ interface OptionStrategy {
|
|
|
6449
6448
|
* @interface OrderUpdatedResponse
|
|
6450
6449
|
*/
|
|
6451
6450
|
interface OrderUpdatedResponse {
|
|
6452
|
-
[key: string]:
|
|
6451
|
+
[key: string]: unknown;
|
|
6453
6452
|
/**
|
|
6454
6453
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
6455
6454
|
* @type {string}
|
|
@@ -6471,7 +6470,7 @@ interface OrderUpdatedResponse {
|
|
|
6471
6470
|
* @interface PaginationDetails
|
|
6472
6471
|
*/
|
|
6473
6472
|
interface PaginationDetails {
|
|
6474
|
-
[key: string]:
|
|
6473
|
+
[key: string]: unknown;
|
|
6475
6474
|
/**
|
|
6476
6475
|
* The starting point of the paginated results.
|
|
6477
6476
|
* @type {number}
|
|
@@ -6499,7 +6498,7 @@ interface PaginationDetails {
|
|
|
6499
6498
|
* @interface PaginatedUniversalActivity
|
|
6500
6499
|
*/
|
|
6501
6500
|
interface PaginatedUniversalActivity {
|
|
6502
|
-
[key: string]:
|
|
6501
|
+
[key: string]: unknown;
|
|
6503
6502
|
/**
|
|
6504
6503
|
*
|
|
6505
6504
|
* @type {Array<AccountUniversalActivity>}
|
|
@@ -6521,7 +6520,7 @@ interface PaginatedUniversalActivity {
|
|
|
6521
6520
|
* @interface PartnerData
|
|
6522
6521
|
*/
|
|
6523
6522
|
interface PartnerData {
|
|
6524
|
-
[key: string]:
|
|
6523
|
+
[key: string]: unknown;
|
|
6525
6524
|
/**
|
|
6526
6525
|
* A short, unique identifier for your company or product.
|
|
6527
6526
|
* @type {string}
|
|
@@ -6604,7 +6603,7 @@ interface PartnerData {
|
|
|
6604
6603
|
* @interface PastValue
|
|
6605
6604
|
*/
|
|
6606
6605
|
interface PastValue {
|
|
6607
|
-
[key: string]:
|
|
6606
|
+
[key: string]: unknown;
|
|
6608
6607
|
/**
|
|
6609
6608
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
6610
6609
|
* @type {string}
|
|
@@ -6632,7 +6631,7 @@ interface PastValue {
|
|
|
6632
6631
|
* @interface SubPeriodReturnRate
|
|
6633
6632
|
*/
|
|
6634
6633
|
interface SubPeriodReturnRate {
|
|
6635
|
-
[key: string]:
|
|
6634
|
+
[key: string]: unknown;
|
|
6636
6635
|
/**
|
|
6637
6636
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
6638
6637
|
* @type {string}
|
|
@@ -6660,7 +6659,7 @@ interface SubPeriodReturnRate {
|
|
|
6660
6659
|
* @interface PerformanceCustom
|
|
6661
6660
|
*/
|
|
6662
6661
|
interface PerformanceCustom {
|
|
6663
|
-
[key: string]:
|
|
6662
|
+
[key: string]: unknown;
|
|
6664
6663
|
/**
|
|
6665
6664
|
*
|
|
6666
6665
|
* @type {Array<PastValue>}
|
|
@@ -6784,7 +6783,7 @@ interface PerformanceCustom {
|
|
|
6784
6783
|
* @interface RateOfReturnObject
|
|
6785
6784
|
*/
|
|
6786
6785
|
interface RateOfReturnObject {
|
|
6787
|
-
[key: string]:
|
|
6786
|
+
[key: string]: unknown;
|
|
6788
6787
|
/**
|
|
6789
6788
|
* The timeframe this return percent is reflecting
|
|
6790
6789
|
* @type {string}
|
|
@@ -6813,7 +6812,7 @@ type RateOfReturnObjectTimeframeEnum = 'ALL' | '1Y' | 'YTD' | '1M' | '1W' | '1D'
|
|
|
6813
6812
|
* @interface RateOfReturnResponse
|
|
6814
6813
|
*/
|
|
6815
6814
|
interface RateOfReturnResponse {
|
|
6816
|
-
[key: string]:
|
|
6815
|
+
[key: string]: unknown;
|
|
6817
6816
|
/**
|
|
6818
6817
|
* List of return percentages
|
|
6819
6818
|
* @type {Array<RateOfReturnObject>}
|
|
@@ -6829,7 +6828,7 @@ interface RateOfReturnResponse {
|
|
|
6829
6828
|
* @interface RecentOrdersResponse
|
|
6830
6829
|
*/
|
|
6831
6830
|
interface RecentOrdersResponse {
|
|
6832
|
-
[key: string]:
|
|
6831
|
+
[key: string]: unknown;
|
|
6833
6832
|
/**
|
|
6834
6833
|
* List of orders executed in the last 24 hours
|
|
6835
6834
|
* @type {Array<AccountOrderRecord>}
|
|
@@ -6845,7 +6844,7 @@ interface RecentOrdersResponse {
|
|
|
6845
6844
|
* @interface SessionEvent
|
|
6846
6845
|
*/
|
|
6847
6846
|
interface SessionEvent {
|
|
6848
|
-
[key: string]:
|
|
6847
|
+
[key: string]: unknown;
|
|
6849
6848
|
/**
|
|
6850
6849
|
*
|
|
6851
6850
|
* @type {string}
|
|
@@ -6898,7 +6897,7 @@ type SessionEventSessionEventTypeEnum = 'OAUTH_REDIRECT' | 'DISCLAIMER_ACCEPTED'
|
|
|
6898
6897
|
* @interface SimpleOrderForm
|
|
6899
6898
|
*/
|
|
6900
6899
|
interface SimpleOrderForm {
|
|
6901
|
-
[key: string]:
|
|
6900
|
+
[key: string]: unknown;
|
|
6902
6901
|
/**
|
|
6903
6902
|
*
|
|
6904
6903
|
* @type {TradingInstrument}
|
|
@@ -6964,7 +6963,7 @@ type SimpleOrderFormTimeInForceEnum = 'GTC' | 'FOK' | 'IOC' | 'GTD';
|
|
|
6964
6963
|
* @interface SimpleTradeInstrument
|
|
6965
6964
|
*/
|
|
6966
6965
|
interface SimpleTradeInstrument {
|
|
6967
|
-
[key: string]:
|
|
6966
|
+
[key: string]: unknown;
|
|
6968
6967
|
/**
|
|
6969
6968
|
*
|
|
6970
6969
|
* @type {string}
|
|
@@ -6987,7 +6986,7 @@ type SimpleTradeInstrumentKindEnum = 'equity' | 'option' | 'future' | 'future_op
|
|
|
6987
6986
|
* @interface SimpleTradeLeg
|
|
6988
6987
|
*/
|
|
6989
6988
|
interface SimpleTradeLeg {
|
|
6990
|
-
[key: string]:
|
|
6989
|
+
[key: string]: unknown;
|
|
6991
6990
|
/**
|
|
6992
6991
|
*
|
|
6993
6992
|
* @type {SimpleTradeInstrument}
|
|
@@ -7089,7 +7088,7 @@ type SimpleTradeFormTradingSessionEnum = 'regular' | 'extended';
|
|
|
7089
7088
|
* @interface SimpleTradeResponse
|
|
7090
7089
|
*/
|
|
7091
7090
|
interface SimpleTradeResponse {
|
|
7092
|
-
[key: string]:
|
|
7091
|
+
[key: string]: unknown;
|
|
7093
7092
|
/**
|
|
7094
7093
|
* The brokerage-assigned ID of the submitted order.
|
|
7095
7094
|
* @type {string}
|
|
@@ -7185,7 +7184,7 @@ interface SnapTradeRegisterUserRequestBody {
|
|
|
7185
7184
|
* @interface Status
|
|
7186
7185
|
*/
|
|
7187
7186
|
interface Status {
|
|
7188
|
-
[key: string]:
|
|
7187
|
+
[key: string]: unknown;
|
|
7189
7188
|
/**
|
|
7190
7189
|
*
|
|
7191
7190
|
* @type {number}
|
|
@@ -7213,7 +7212,7 @@ interface Status {
|
|
|
7213
7212
|
* @interface StrategyOrderRecord
|
|
7214
7213
|
*/
|
|
7215
7214
|
interface StrategyOrderRecord {
|
|
7216
|
-
[key: string]:
|
|
7215
|
+
[key: string]: unknown;
|
|
7217
7216
|
/**
|
|
7218
7217
|
*
|
|
7219
7218
|
* @type {OptionStrategy}
|
|
@@ -7290,7 +7289,7 @@ type StrategyOrderRecordStatusEnum = 'PENDING' | 'ACCEPTED' | 'FAILED' | 'REJECT
|
|
|
7290
7289
|
* @interface StrategyQuotesGreek
|
|
7291
7290
|
*/
|
|
7292
7291
|
interface StrategyQuotesGreek {
|
|
7293
|
-
[key: string]:
|
|
7292
|
+
[key: string]: unknown;
|
|
7294
7293
|
/**
|
|
7295
7294
|
*
|
|
7296
7295
|
* @type {number}
|
|
@@ -7330,7 +7329,7 @@ interface StrategyQuotesGreek {
|
|
|
7330
7329
|
* @interface StrategyQuotes
|
|
7331
7330
|
*/
|
|
7332
7331
|
interface StrategyQuotes {
|
|
7333
|
-
[key: string]:
|
|
7332
|
+
[key: string]: unknown;
|
|
7334
7333
|
/**
|
|
7335
7334
|
*
|
|
7336
7335
|
* @type {OptionStrategy}
|
|
@@ -7376,7 +7375,7 @@ interface StrategyQuotes {
|
|
|
7376
7375
|
* @interface Symbol
|
|
7377
7376
|
*/
|
|
7378
7377
|
interface Symbol {
|
|
7379
|
-
[key: string]:
|
|
7378
|
+
[key: string]: unknown;
|
|
7380
7379
|
/**
|
|
7381
7380
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
7382
7381
|
* @type {string}
|
|
@@ -7536,7 +7535,7 @@ interface TradeDetectionCancelSubscriptionRequest {
|
|
|
7536
7535
|
* @interface TradeDetectionCancelSubscriptionResponse
|
|
7537
7536
|
*/
|
|
7538
7537
|
interface TradeDetectionCancelSubscriptionResponse {
|
|
7539
|
-
[key: string]:
|
|
7538
|
+
[key: string]: unknown;
|
|
7540
7539
|
/**
|
|
7541
7540
|
*
|
|
7542
7541
|
* @type {boolean}
|
|
@@ -7552,7 +7551,7 @@ interface TradeDetectionCancelSubscriptionResponse {
|
|
|
7552
7551
|
* @interface TradeDetectionSubscription
|
|
7553
7552
|
*/
|
|
7554
7553
|
interface TradeDetectionSubscription {
|
|
7555
|
-
[key: string]:
|
|
7554
|
+
[key: string]: unknown;
|
|
7556
7555
|
/**
|
|
7557
7556
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
7558
7557
|
* @type {string}
|
|
@@ -7580,7 +7579,7 @@ interface TradeDetectionSubscription {
|
|
|
7580
7579
|
* @interface TradingGetUserAccountOptionQuotes410Response
|
|
7581
7580
|
*/
|
|
7582
7581
|
interface TradingGetUserAccountOptionQuotes410Response {
|
|
7583
|
-
[key: string]:
|
|
7582
|
+
[key: string]: unknown;
|
|
7584
7583
|
/**
|
|
7585
7584
|
*
|
|
7586
7585
|
* @type {string}
|
|
@@ -7596,7 +7595,7 @@ interface TradingGetUserAccountOptionQuotes410Response {
|
|
|
7596
7595
|
* @interface TradingSearchCryptocurrencyPairInstruments200Response
|
|
7597
7596
|
*/
|
|
7598
7597
|
interface TradingSearchCryptocurrencyPairInstruments200Response {
|
|
7599
|
-
[key: string]:
|
|
7598
|
+
[key: string]: unknown;
|
|
7600
7599
|
/**
|
|
7601
7600
|
*
|
|
7602
7601
|
* @type {Array<CryptocurrencyPair>}
|
|
@@ -7612,7 +7611,7 @@ interface TradingSearchCryptocurrencyPairInstruments200Response {
|
|
|
7612
7611
|
* @interface TrailingStop
|
|
7613
7612
|
*/
|
|
7614
7613
|
interface TrailingStop {
|
|
7615
|
-
[key: string]:
|
|
7614
|
+
[key: string]: unknown;
|
|
7616
7615
|
/**
|
|
7617
7616
|
* The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`.
|
|
7618
7617
|
* @type {string}
|
|
@@ -7635,7 +7634,7 @@ type TrailingStopTypeEnum = 'DOLLAR' | 'PERCENT';
|
|
|
7635
7634
|
* @interface USExchange
|
|
7636
7635
|
*/
|
|
7637
7636
|
interface USExchange {
|
|
7638
|
-
[key: string]:
|
|
7637
|
+
[key: string]: unknown;
|
|
7639
7638
|
/**
|
|
7640
7639
|
*
|
|
7641
7640
|
* @type {string}
|
|
@@ -7699,7 +7698,7 @@ interface USExchange {
|
|
|
7699
7698
|
* @interface UniversalActivity
|
|
7700
7699
|
*/
|
|
7701
7700
|
interface UniversalActivity {
|
|
7702
|
-
[key: string]:
|
|
7701
|
+
[key: string]: unknown;
|
|
7703
7702
|
/**
|
|
7704
7703
|
* Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade. Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.
|
|
7705
7704
|
* @type {string}
|
|
@@ -8016,7 +8015,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8016
8015
|
* @param {*} [options] Override http request option.
|
|
8017
8016
|
* @throws {RequiredError}
|
|
8018
8017
|
*/
|
|
8019
|
-
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8018
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PaginatedUniversalActivity, unknown>>>;
|
|
8020
8019
|
/**
|
|
8021
8020
|
* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values.
|
|
8022
8021
|
* @summary List historical account total value
|
|
@@ -8024,7 +8023,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8024
8023
|
* @param {*} [options] Override http request option.
|
|
8025
8024
|
* @throws {RequiredError}
|
|
8026
8025
|
*/
|
|
8027
|
-
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8026
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountValueHistoryResponse, unknown>>>;
|
|
8028
8027
|
/**
|
|
8029
8028
|
* Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account. On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. 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 institution. 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. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
|
|
8030
8029
|
* @summary Get account details
|
|
@@ -8032,7 +8031,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8032
8031
|
* @param {*} [options] Override http request option.
|
|
8033
8032
|
* @throws {RequiredError}
|
|
8034
8033
|
*/
|
|
8035
|
-
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8034
|
+
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ConnectionAccount, unknown>>>;
|
|
8036
8035
|
/**
|
|
8037
8036
|
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, CFD positions, and tokenized asset positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change. Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
8038
8037
|
* @summary List all account positions
|
|
@@ -8040,7 +8039,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8040
8039
|
* @param {*} [options] Override http request option.
|
|
8041
8040
|
* @throws {RequiredError}
|
|
8042
8041
|
*/
|
|
8043
|
-
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8042
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AllAccountPositionsResponse, unknown>>>;
|
|
8044
8043
|
/**
|
|
8045
8044
|
* 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.
|
|
8046
8045
|
* @summary List account balances
|
|
@@ -8048,7 +8047,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8048
8047
|
* @param {*} [options] Override http request option.
|
|
8049
8048
|
* @throws {RequiredError}
|
|
8050
8049
|
*/
|
|
8051
|
-
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8050
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Balance>, unknown>>>;
|
|
8052
8051
|
/**
|
|
8053
8052
|
* **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, and line of credit accounts. Returns account detail known to SnapTrade for the specified account. 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.
|
|
8054
8053
|
* @summary Get account detail
|
|
@@ -8057,7 +8056,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8057
8056
|
* @deprecated
|
|
8058
8057
|
* @throws {RequiredError}
|
|
8059
8058
|
*/
|
|
8060
|
-
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8059
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Account, unknown>>>;
|
|
8061
8060
|
/**
|
|
8062
8061
|
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
8063
8062
|
* @summary Get account order detail
|
|
@@ -8065,7 +8064,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8065
8064
|
* @param {*} [options] Override http request option.
|
|
8066
8065
|
* @throws {RequiredError}
|
|
8067
8066
|
*/
|
|
8068
|
-
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8067
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
8069
8068
|
/**
|
|
8070
8069
|
* Returns a list of recent orders in the specified account. 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.
|
|
8071
8070
|
* @summary List account orders
|
|
@@ -8073,7 +8072,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8073
8072
|
* @param {*} [options] Override http request option.
|
|
8074
8073
|
* @throws {RequiredError}
|
|
8075
8074
|
*/
|
|
8076
|
-
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8075
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AccountOrderRecord>, unknown>>>;
|
|
8077
8076
|
/**
|
|
8078
8077
|
* 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
|
|
8079
8078
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8081,7 +8080,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8081
8080
|
* @param {*} [options] Override http request option.
|
|
8082
8081
|
* @throws {RequiredError}
|
|
8083
8082
|
*/
|
|
8084
|
-
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8083
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RecentOrdersResponse, unknown>>>;
|
|
8085
8084
|
/**
|
|
8086
8085
|
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8087
8086
|
* @summary List account rate of returns
|
|
@@ -8089,7 +8088,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8089
8088
|
* @param {*} [options] Override http request option.
|
|
8090
8089
|
* @throws {RequiredError}
|
|
8091
8090
|
*/
|
|
8092
|
-
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8091
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RateOfReturnResponse, unknown>>>;
|
|
8093
8092
|
/**
|
|
8094
8093
|
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. 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. Concurrent live holdings requests for the same account fail immediately with HTTP 409 and error code `1166`. Wait for the in-flight request to complete before retrying.
|
|
8095
8094
|
* @summary List account holdings
|
|
@@ -8098,7 +8097,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8098
8097
|
* @deprecated
|
|
8099
8098
|
* @throws {RequiredError}
|
|
8100
8099
|
*/
|
|
8101
|
-
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8100
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountHoldingsAccount, unknown>>>;
|
|
8102
8101
|
/**
|
|
8103
8102
|
* Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
8104
8103
|
* @summary List all user accounts
|
|
@@ -8106,7 +8105,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8106
8105
|
* @param {*} [options] Override http request option.
|
|
8107
8106
|
* @throws {RequiredError}
|
|
8108
8107
|
*/
|
|
8109
|
-
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8108
|
+
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AllUserAccountsResponse, unknown>>>;
|
|
8110
8109
|
/**
|
|
8111
8110
|
* **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, and line of credit accounts. Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
8112
8111
|
* @summary List user accounts
|
|
@@ -8115,7 +8114,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8115
8114
|
* @deprecated
|
|
8116
8115
|
* @throws {RequiredError}
|
|
8117
8116
|
*/
|
|
8118
|
-
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8117
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Account>, unknown>>>;
|
|
8119
8118
|
/**
|
|
8120
8119
|
* Updates various properties of a specified account.
|
|
8121
8120
|
* @summary Update details of an investment account
|
|
@@ -8123,7 +8122,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8123
8122
|
* @param {*} [options] Override http request option.
|
|
8124
8123
|
* @throws {RequiredError}
|
|
8125
8124
|
*/
|
|
8126
|
-
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8125
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Account>, unknown>>>;
|
|
8127
8126
|
};
|
|
8128
8127
|
/**
|
|
8129
8128
|
* AccountInformationApi - factory interface
|
|
@@ -8137,7 +8136,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8137
8136
|
* @param {*} [options] Override http request option.
|
|
8138
8137
|
* @throws {RequiredError}
|
|
8139
8138
|
*/
|
|
8140
|
-
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>):
|
|
8139
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<AxiosResponse<PaginatedUniversalActivity, unknown>>;
|
|
8141
8140
|
/**
|
|
8142
8141
|
* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values.
|
|
8143
8142
|
* @summary List historical account total value
|
|
@@ -8145,7 +8144,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8145
8144
|
* @param {*} [options] Override http request option.
|
|
8146
8145
|
* @throws {RequiredError}
|
|
8147
8146
|
*/
|
|
8148
|
-
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>):
|
|
8147
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<AxiosResponse<AccountValueHistoryResponse, unknown>>;
|
|
8149
8148
|
/**
|
|
8150
8149
|
* Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account. On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. 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 institution. 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. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
|
|
8151
8150
|
* @summary Get account details
|
|
@@ -8153,7 +8152,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8153
8152
|
* @param {*} [options] Override http request option.
|
|
8154
8153
|
* @throws {RequiredError}
|
|
8155
8154
|
*/
|
|
8156
|
-
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>):
|
|
8155
|
+
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccount, unknown>>;
|
|
8157
8156
|
/**
|
|
8158
8157
|
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, CFD positions, and tokenized asset positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change. Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
8159
8158
|
* @summary List all account positions
|
|
@@ -8161,7 +8160,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8161
8160
|
* @param {*} [options] Override http request option.
|
|
8162
8161
|
* @throws {RequiredError}
|
|
8163
8162
|
*/
|
|
8164
|
-
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>):
|
|
8163
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<AxiosResponse<AllAccountPositionsResponse, unknown>>;
|
|
8165
8164
|
/**
|
|
8166
8165
|
* 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.
|
|
8167
8166
|
* @summary List account balances
|
|
@@ -8169,7 +8168,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8169
8168
|
* @param {*} [options] Override http request option.
|
|
8170
8169
|
* @throws {RequiredError}
|
|
8171
8170
|
*/
|
|
8172
|
-
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>):
|
|
8171
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<AxiosResponse<Array<Balance>, unknown>>;
|
|
8173
8172
|
/**
|
|
8174
8173
|
* **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, and line of credit accounts. Returns account detail known to SnapTrade for the specified account. 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.
|
|
8175
8174
|
* @summary Get account detail
|
|
@@ -8178,7 +8177,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8178
8177
|
* @deprecated
|
|
8179
8178
|
* @throws {RequiredError}
|
|
8180
8179
|
*/
|
|
8181
|
-
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>):
|
|
8180
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<AxiosResponse<Account, unknown>>;
|
|
8182
8181
|
/**
|
|
8183
8182
|
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
8184
8183
|
* @summary Get account order detail
|
|
@@ -8186,7 +8185,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8186
8185
|
* @param {*} [options] Override http request option.
|
|
8187
8186
|
* @throws {RequiredError}
|
|
8188
8187
|
*/
|
|
8189
|
-
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>):
|
|
8188
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
8190
8189
|
/**
|
|
8191
8190
|
* Returns a list of recent orders in the specified account. 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.
|
|
8192
8191
|
* @summary List account orders
|
|
@@ -8194,7 +8193,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8194
8193
|
* @param {*} [options] Override http request option.
|
|
8195
8194
|
* @throws {RequiredError}
|
|
8196
8195
|
*/
|
|
8197
|
-
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>):
|
|
8196
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<AxiosResponse<Array<AccountOrderRecord>, unknown>>;
|
|
8198
8197
|
/**
|
|
8199
8198
|
* 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
|
|
8200
8199
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8202,7 +8201,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8202
8201
|
* @param {*} [options] Override http request option.
|
|
8203
8202
|
* @throws {RequiredError}
|
|
8204
8203
|
*/
|
|
8205
|
-
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>):
|
|
8204
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<AxiosResponse<RecentOrdersResponse, unknown>>;
|
|
8206
8205
|
/**
|
|
8207
8206
|
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8208
8207
|
* @summary List account rate of returns
|
|
@@ -8210,7 +8209,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8210
8209
|
* @param {*} [options] Override http request option.
|
|
8211
8210
|
* @throws {RequiredError}
|
|
8212
8211
|
*/
|
|
8213
|
-
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>):
|
|
8212
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown>>;
|
|
8214
8213
|
/**
|
|
8215
8214
|
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. 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. Concurrent live holdings requests for the same account fail immediately with HTTP 409 and error code `1166`. Wait for the in-flight request to complete before retrying.
|
|
8216
8215
|
* @summary List account holdings
|
|
@@ -8219,7 +8218,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8219
8218
|
* @deprecated
|
|
8220
8219
|
* @throws {RequiredError}
|
|
8221
8220
|
*/
|
|
8222
|
-
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>):
|
|
8221
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<AxiosResponse<AccountHoldingsAccount, unknown>>;
|
|
8223
8222
|
/**
|
|
8224
8223
|
* Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
8225
8224
|
* @summary List all user accounts
|
|
@@ -8227,7 +8226,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8227
8226
|
* @param {*} [options] Override http request option.
|
|
8228
8227
|
* @throws {RequiredError}
|
|
8229
8228
|
*/
|
|
8230
|
-
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>):
|
|
8229
|
+
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<AxiosResponse<AllUserAccountsResponse, unknown>>;
|
|
8231
8230
|
/**
|
|
8232
8231
|
* **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, and line of credit accounts. Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
8233
8232
|
* @summary List user accounts
|
|
@@ -8236,7 +8235,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8236
8235
|
* @deprecated
|
|
8237
8236
|
* @throws {RequiredError}
|
|
8238
8237
|
*/
|
|
8239
|
-
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>):
|
|
8238
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<AxiosResponse<Array<Account>, unknown>>;
|
|
8240
8239
|
/**
|
|
8241
8240
|
* Updates various properties of a specified account.
|
|
8242
8241
|
* @summary Update details of an investment account
|
|
@@ -8244,7 +8243,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8244
8243
|
* @param {*} [options] Override http request option.
|
|
8245
8244
|
* @throws {RequiredError}
|
|
8246
8245
|
*/
|
|
8247
|
-
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>):
|
|
8246
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<AxiosResponse<Array<Account>, unknown>>;
|
|
8248
8247
|
};
|
|
8249
8248
|
/**
|
|
8250
8249
|
* Request parameters for getAccountActivities operation in AccountInformationApi.
|
|
@@ -8679,7 +8678,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8679
8678
|
* @throws {RequiredError}
|
|
8680
8679
|
* @memberof AccountInformationApiGenerated
|
|
8681
8680
|
*/
|
|
8682
|
-
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<
|
|
8681
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<AxiosResponse<PaginatedUniversalActivity, unknown, {}, any>>;
|
|
8683
8682
|
/**
|
|
8684
8683
|
* An experimental endpoint that returns estimated historical total account value for the specified account. Total account value is the sum of the market value of all positions and cash in the account at a given time. This endpoint is experimental, disabled by default, and has a maximum lookback of 1 year. Because the data is dynamically generated, we recommend replacing your dataset with each request as opposed to combining data from multiple requests. Enable this feature for free in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons) The data may contain gaps and is best used for charting account value trends. It should not be relied on as a complete or exact record of historical account values.
|
|
8685
8684
|
* @summary List historical account total value
|
|
@@ -8688,7 +8687,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8688
8687
|
* @throws {RequiredError}
|
|
8689
8688
|
* @memberof AccountInformationApiGenerated
|
|
8690
8689
|
*/
|
|
8691
|
-
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<
|
|
8690
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<AxiosResponse<AccountValueHistoryResponse, unknown, {}, any>>;
|
|
8692
8691
|
/**
|
|
8693
8692
|
* Returns the specified account for the authenticated user. The account can be an investment, deposit, or line of credit account. Use the `kind` discriminator to determine the schema for the account. On Pay as you Go / Real-time, this endpoint refreshes the account\'s opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. 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 institution. 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. If the connection has become disabled, it can no longer access the latest data from the institution, 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.
|
|
8694
8693
|
* @summary Get account details
|
|
@@ -8697,7 +8696,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8697
8696
|
* @throws {RequiredError}
|
|
8698
8697
|
* @memberof AccountInformationApiGenerated
|
|
8699
8698
|
*/
|
|
8700
|
-
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<
|
|
8699
|
+
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccount, unknown, {}, any>>;
|
|
8701
8700
|
/**
|
|
8702
8701
|
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, bonds, crypto, futures, option positions, future option positions, CFD positions, and tokenized asset positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. **Beta:** future option positions (`instrument.kind: future_option`) are in beta. They are currently returned only for tastytrade and Interactive Brokers connections, and only for partners they have been enabled for — please contact the SnapTrade team to enable them. The `FutureOptionInstrument` schema may change. Positions counted in account cash balance or buying power include `cash_equivalent: true`. `stock`, `adr`, `etf`, `mutualfund`, and `crypto` positions may include `tax_lots` when tax lot data is enabled for the account. To see which institutions support tax lot data, please see our [supported institutions doc](https://support.snaptrade.com/brokerages). 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.
|
|
8703
8702
|
* @summary List all account positions
|
|
@@ -8706,7 +8705,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8706
8705
|
* @throws {RequiredError}
|
|
8707
8706
|
* @memberof AccountInformationApiGenerated
|
|
8708
8707
|
*/
|
|
8709
|
-
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<
|
|
8708
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<AxiosResponse<AllAccountPositionsResponse, unknown, {}, any>>;
|
|
8710
8709
|
/**
|
|
8711
8710
|
* 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.
|
|
8712
8711
|
* @summary List account balances
|
|
@@ -8715,7 +8714,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8715
8714
|
* @throws {RequiredError}
|
|
8716
8715
|
* @memberof AccountInformationApiGenerated
|
|
8717
8716
|
*/
|
|
8718
|
-
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<
|
|
8717
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<AxiosResponse<Balance[], unknown, {}, any>>;
|
|
8719
8718
|
/**
|
|
8720
8719
|
* **Deprecated.** Use the [get account details](/reference/Account%20Information/AccountInformation_getAccountDetails) endpoint instead, which supports all account types, including investment, deposit, and line of credit accounts. Returns account detail known to SnapTrade for the specified account. 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.
|
|
8721
8720
|
* @summary Get account detail
|
|
@@ -8725,7 +8724,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8725
8724
|
* @throws {RequiredError}
|
|
8726
8725
|
* @memberof AccountInformationApiGenerated
|
|
8727
8726
|
*/
|
|
8728
|
-
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<
|
|
8727
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<AxiosResponse<Account, unknown, {}, any>>;
|
|
8729
8728
|
/**
|
|
8730
8729
|
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
8731
8730
|
* @summary Get account order detail
|
|
@@ -8734,7 +8733,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8734
8733
|
* @throws {RequiredError}
|
|
8735
8734
|
* @memberof AccountInformationApiGenerated
|
|
8736
8735
|
*/
|
|
8737
|
-
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<
|
|
8736
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
8738
8737
|
/**
|
|
8739
8738
|
* Returns a list of recent orders in the specified account. 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.
|
|
8740
8739
|
* @summary List account orders
|
|
@@ -8743,7 +8742,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8743
8742
|
* @throws {RequiredError}
|
|
8744
8743
|
* @memberof AccountInformationApiGenerated
|
|
8745
8744
|
*/
|
|
8746
|
-
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<
|
|
8745
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord[], unknown, {}, any>>;
|
|
8747
8746
|
/**
|
|
8748
8747
|
* 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
|
|
8749
8748
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8752,7 +8751,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8752
8751
|
* @throws {RequiredError}
|
|
8753
8752
|
* @memberof AccountInformationApiGenerated
|
|
8754
8753
|
*/
|
|
8755
|
-
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<
|
|
8754
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<AxiosResponse<RecentOrdersResponse, unknown, {}, any>>;
|
|
8756
8755
|
/**
|
|
8757
8756
|
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8758
8757
|
* @summary List account rate of returns
|
|
@@ -8761,7 +8760,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8761
8760
|
* @throws {RequiredError}
|
|
8762
8761
|
* @memberof AccountInformationApiGenerated
|
|
8763
8762
|
*/
|
|
8764
|
-
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<
|
|
8763
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown, {}, any>>;
|
|
8765
8764
|
/**
|
|
8766
8765
|
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026. Returns a list of balances, positions, and recent orders for the specified account. 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. Concurrent live holdings requests for the same account fail immediately with HTTP 409 and error code `1166`. Wait for the in-flight request to complete before retrying.
|
|
8767
8766
|
* @summary List account holdings
|
|
@@ -8771,7 +8770,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8771
8770
|
* @throws {RequiredError}
|
|
8772
8771
|
* @memberof AccountInformationApiGenerated
|
|
8773
8772
|
*/
|
|
8774
|
-
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<
|
|
8773
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<AxiosResponse<AccountHoldingsAccount, unknown, {}, any>>;
|
|
8775
8774
|
/**
|
|
8776
8775
|
* Returns all accounts across all connections known to SnapTrade for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by institution. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listConnectionAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
8777
8776
|
* @summary List all user accounts
|
|
@@ -8780,7 +8779,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8780
8779
|
* @throws {RequiredError}
|
|
8781
8780
|
* @memberof AccountInformationApiGenerated
|
|
8782
8781
|
*/
|
|
8783
|
-
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<
|
|
8782
|
+
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<AxiosResponse<AllUserAccountsResponse, unknown, {}, any>>;
|
|
8784
8783
|
/**
|
|
8785
8784
|
* **Deprecated.** Use the [list all user accounts](/reference/Account%20Information/AccountInformation_listAllUserAccounts) endpoint instead, which returns all account types in a single response, including investment, deposit, and line of credit accounts. Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day, which makes this endpoint fast and well-suited to listing accounts across all of a user\'s connections in a single call. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts). Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
8786
8785
|
* @summary List user accounts
|
|
@@ -8790,7 +8789,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8790
8789
|
* @throws {RequiredError}
|
|
8791
8790
|
* @memberof AccountInformationApiGenerated
|
|
8792
8791
|
*/
|
|
8793
|
-
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<
|
|
8792
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<AxiosResponse<Account[], unknown, {}, any>>;
|
|
8794
8793
|
/**
|
|
8795
8794
|
* Updates various properties of a specified account.
|
|
8796
8795
|
* @summary Update details of an investment account
|
|
@@ -8799,7 +8798,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8799
8798
|
* @throws {RequiredError}
|
|
8800
8799
|
* @memberof AccountInformationApiGenerated
|
|
8801
8800
|
*/
|
|
8802
|
-
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<
|
|
8801
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<AxiosResponse<Account[], unknown, {}, any>>;
|
|
8803
8802
|
}
|
|
8804
8803
|
//#endregion
|
|
8805
8804
|
//#region api/account-information-api.d.ts
|
|
@@ -8830,7 +8829,7 @@ declare const ApiStatusApiFp: <TAuth extends AuthMode>(configuration?: Configura
|
|
|
8830
8829
|
* @param {*} [options] Override http request option.
|
|
8831
8830
|
* @throws {RequiredError}
|
|
8832
8831
|
*/
|
|
8833
|
-
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8832
|
+
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Status, unknown>>>;
|
|
8834
8833
|
};
|
|
8835
8834
|
/**
|
|
8836
8835
|
* ApiStatusApi - factory interface
|
|
@@ -8843,7 +8842,7 @@ declare const ApiStatusApiFactory: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8843
8842
|
* @param {*} [options] Override http request option.
|
|
8844
8843
|
* @throws {RequiredError}
|
|
8845
8844
|
*/
|
|
8846
|
-
check(options?: AxiosRequestConfig):
|
|
8845
|
+
check(options?: AxiosRequestConfig): Promise<AxiosResponse<Status, unknown>>;
|
|
8847
8846
|
};
|
|
8848
8847
|
/**
|
|
8849
8848
|
* ApiStatusApiGenerated - object-oriented interface
|
|
@@ -8859,7 +8858,7 @@ declare class ApiStatusApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAut
|
|
|
8859
8858
|
* @throws {RequiredError}
|
|
8860
8859
|
* @memberof ApiStatusApiGenerated
|
|
8861
8860
|
*/
|
|
8862
|
-
check(options?: AxiosRequestConfig): Promise<
|
|
8861
|
+
check(options?: AxiosRequestConfig): Promise<AxiosResponse<Status, unknown, {}, any>>;
|
|
8863
8862
|
}
|
|
8864
8863
|
//#endregion
|
|
8865
8864
|
//#region api/api-status-api.d.ts
|
|
@@ -8925,14 +8924,14 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8925
8924
|
* @param {*} [options] Override http request option.
|
|
8926
8925
|
* @throws {RequiredError}
|
|
8927
8926
|
*/
|
|
8928
|
-
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8927
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeleteUserResponse, unknown>>>;
|
|
8929
8928
|
/**
|
|
8930
8929
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8931
8930
|
* @summary List all users
|
|
8932
8931
|
* @param {*} [options] Override http request option.
|
|
8933
8932
|
* @throws {RequiredError}
|
|
8934
8933
|
*/
|
|
8935
|
-
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8934
|
+
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<string>, unknown>>>;
|
|
8936
8935
|
/**
|
|
8937
8936
|
* Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app. Please note that the returned URL expires in 5 minutes.
|
|
8938
8937
|
* @summary Generate Connection Portal URL
|
|
@@ -8940,7 +8939,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8940
8939
|
* @param {*} [options] Override http request option.
|
|
8941
8940
|
* @throws {RequiredError}
|
|
8942
8941
|
*/
|
|
8943
|
-
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8942
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AuthenticationLoginSnapTradeUser200Response, unknown>>>;
|
|
8944
8943
|
/**
|
|
8945
8944
|
* Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
|
|
8946
8945
|
* @summary Register user
|
|
@@ -8948,7 +8947,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8948
8947
|
* @param {*} [options] Override http request option.
|
|
8949
8948
|
* @throws {RequiredError}
|
|
8950
8949
|
*/
|
|
8951
|
-
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8950
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserIDandSecret, unknown>>>;
|
|
8952
8951
|
/**
|
|
8953
8952
|
* Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
|
|
8954
8953
|
* @summary Rotate user secret
|
|
@@ -8956,7 +8955,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8956
8955
|
* @param {*} [options] Override http request option.
|
|
8957
8956
|
* @throws {RequiredError}
|
|
8958
8957
|
*/
|
|
8959
|
-
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8958
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserIDandSecret, unknown>>>;
|
|
8960
8959
|
};
|
|
8961
8960
|
/**
|
|
8962
8961
|
* AuthenticationApi - factory interface
|
|
@@ -8970,14 +8969,14 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8970
8969
|
* @param {*} [options] Override http request option.
|
|
8971
8970
|
* @throws {RequiredError}
|
|
8972
8971
|
*/
|
|
8973
|
-
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>):
|
|
8972
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<DeleteUserResponse, unknown>>;
|
|
8974
8973
|
/**
|
|
8975
8974
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8976
8975
|
* @summary List all users
|
|
8977
8976
|
* @param {*} [options] Override http request option.
|
|
8978
8977
|
* @throws {RequiredError}
|
|
8979
8978
|
*/
|
|
8980
|
-
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
8979
|
+
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<string>, unknown>>;
|
|
8981
8980
|
/**
|
|
8982
8981
|
* Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app. Please note that the returned URL expires in 5 minutes.
|
|
8983
8982
|
* @summary Generate Connection Portal URL
|
|
@@ -8985,7 +8984,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8985
8984
|
* @param {*} [options] Override http request option.
|
|
8986
8985
|
* @throws {RequiredError}
|
|
8987
8986
|
*/
|
|
8988
|
-
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>):
|
|
8987
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<AuthenticationLoginSnapTradeUser200Response, unknown>>;
|
|
8989
8988
|
/**
|
|
8990
8989
|
* Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
|
|
8991
8990
|
* @summary Register user
|
|
@@ -8993,7 +8992,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8993
8992
|
* @param {*} [options] Override http request option.
|
|
8994
8993
|
* @throws {RequiredError}
|
|
8995
8994
|
*/
|
|
8996
|
-
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>):
|
|
8995
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown>>;
|
|
8997
8996
|
/**
|
|
8998
8997
|
* Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
|
|
8999
8998
|
* @summary Rotate user secret
|
|
@@ -9001,7 +9000,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9001
9000
|
* @param {*} [options] Override http request option.
|
|
9002
9001
|
* @throws {RequiredError}
|
|
9003
9002
|
*/
|
|
9004
|
-
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>):
|
|
9003
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown>>;
|
|
9005
9004
|
};
|
|
9006
9005
|
/**
|
|
9007
9006
|
* Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
|
|
@@ -9076,7 +9075,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9076
9075
|
* @throws {RequiredError}
|
|
9077
9076
|
* @memberof AuthenticationApiGenerated
|
|
9078
9077
|
*/
|
|
9079
|
-
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<
|
|
9078
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<DeleteUserResponse, unknown, {}, any>>;
|
|
9080
9079
|
/**
|
|
9081
9080
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
9082
9081
|
* @summary List all users
|
|
@@ -9084,7 +9083,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9084
9083
|
* @throws {RequiredError}
|
|
9085
9084
|
* @memberof AuthenticationApiGenerated
|
|
9086
9085
|
*/
|
|
9087
|
-
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
9086
|
+
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<string[], unknown, {}, any>>;
|
|
9088
9087
|
/**
|
|
9089
9088
|
* Authenticates a SnapTrade user and returns the Connection Portal URL used for connecting brokerage accounts. Please check [this guide](/docs/implement-connection-portal) for how to integrate the Connection Portal into your app. Please note that the returned URL expires in 5 minutes.
|
|
9090
9089
|
* @summary Generate Connection Portal URL
|
|
@@ -9093,7 +9092,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9093
9092
|
* @throws {RequiredError}
|
|
9094
9093
|
* @memberof AuthenticationApiGenerated
|
|
9095
9094
|
*/
|
|
9096
|
-
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<
|
|
9095
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<AuthenticationLoginSnapTradeUser200Response, unknown, {}, any>>;
|
|
9097
9096
|
/**
|
|
9098
9097
|
* Registers a new SnapTrade user under your Client ID. A user secret will be automatically generated for you and must be properly stored in your system. Most SnapTrade operations require a user ID and user secret to be passed in as parameters.
|
|
9099
9098
|
* @summary Register user
|
|
@@ -9102,7 +9101,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9102
9101
|
* @throws {RequiredError}
|
|
9103
9102
|
* @memberof AuthenticationApiGenerated
|
|
9104
9103
|
*/
|
|
9105
|
-
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<
|
|
9104
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown, {}, any>>;
|
|
9106
9105
|
/**
|
|
9107
9106
|
* Rotates the secret for a SnapTrade user. You might use this if `userSecret` is compromised. Please note that if you call this endpoint and fail to save the new secret, you\'ll no longer be able to access any data for this user, and your only option will be to delete and recreate the user, then ask them to reconnect.
|
|
9108
9107
|
* @summary Rotate user secret
|
|
@@ -9111,7 +9110,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9111
9110
|
* @throws {RequiredError}
|
|
9112
9111
|
* @memberof AuthenticationApiGenerated
|
|
9113
9112
|
*/
|
|
9114
|
-
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<
|
|
9113
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown, {}, any>>;
|
|
9115
9114
|
}
|
|
9116
9115
|
//#endregion
|
|
9117
9116
|
//#region api/authentication-api.d.ts
|
|
@@ -9226,7 +9225,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9226
9225
|
* @param {*} [options] Override http request option.
|
|
9227
9226
|
* @throws {RequiredError}
|
|
9228
9227
|
*/
|
|
9229
|
-
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9228
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeleteConnectionConfirmation, unknown>>>;
|
|
9230
9229
|
/**
|
|
9231
9230
|
* Returns a single connection for the specified ID.
|
|
9232
9231
|
* @summary Get connection detail
|
|
@@ -9234,7 +9233,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9234
9233
|
* @param {*} [options] Override http request option.
|
|
9235
9234
|
* @throws {RequiredError}
|
|
9236
9235
|
*/
|
|
9237
|
-
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9236
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorization, unknown>>>;
|
|
9238
9237
|
/**
|
|
9239
9238
|
* Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection. This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
|
|
9240
9239
|
* @summary Force disable connection
|
|
@@ -9242,7 +9241,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9242
9241
|
* @param {*} [options] Override http request option.
|
|
9243
9242
|
* @throws {RequiredError}
|
|
9244
9243
|
*/
|
|
9245
|
-
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9244
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorizationDisabledConfirmation, unknown>>>;
|
|
9246
9245
|
/**
|
|
9247
9246
|
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total 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.
|
|
9248
9247
|
* @summary List accounts for a connection
|
|
@@ -9250,7 +9249,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9250
9249
|
* @param {*} [options] Override http request option.
|
|
9251
9250
|
* @throws {RequiredError}
|
|
9252
9251
|
*/
|
|
9253
|
-
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9252
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Account>, unknown>>>;
|
|
9254
9253
|
/**
|
|
9255
9254
|
* Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
|
9256
9255
|
* @summary List all connections
|
|
@@ -9258,7 +9257,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9258
9257
|
* @param {*} [options] Override http request option.
|
|
9259
9258
|
* @throws {RequiredError}
|
|
9260
9259
|
*/
|
|
9261
|
-
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9260
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<BrokerageAuthorization>, unknown>>>;
|
|
9262
9261
|
/**
|
|
9263
9262
|
* Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. 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 institution. 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.
|
|
9264
9263
|
* @summary List accounts
|
|
@@ -9266,7 +9265,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9266
9265
|
* @param {*} [options] Override http request option.
|
|
9267
9266
|
* @throws {RequiredError}
|
|
9268
9267
|
*/
|
|
9269
|
-
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9268
|
+
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ConnectionAccountsResponse, unknown>>>;
|
|
9270
9269
|
/**
|
|
9271
9270
|
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless SnapTrade uses delayed data for the connection. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to `data_freshness_mode.snaptrade` on a connection to determine this.**
|
|
9272
9271
|
* @summary Refresh holdings for a connection
|
|
@@ -9274,7 +9273,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9274
9273
|
* @param {*} [options] Override http request option.
|
|
9275
9274
|
* @throws {RequiredError}
|
|
9276
9275
|
*/
|
|
9277
|
-
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9276
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorizationRefreshConfirmation, unknown>>>;
|
|
9278
9277
|
/**
|
|
9279
9278
|
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9280
9279
|
* @summary List connection rate of returns
|
|
@@ -9282,7 +9281,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9282
9281
|
* @param {*} [options] Override http request option.
|
|
9283
9282
|
* @throws {RequiredError}
|
|
9284
9283
|
*/
|
|
9285
|
-
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9284
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RateOfReturnResponse, unknown>>>;
|
|
9286
9285
|
/**
|
|
9287
9286
|
* 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
|
|
9288
9287
|
* @summary Sync transactions for a connection
|
|
@@ -9290,7 +9289,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9290
9289
|
* @param {*} [options] Override http request option.
|
|
9291
9290
|
* @throws {RequiredError}
|
|
9292
9291
|
*/
|
|
9293
|
-
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9292
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, unknown>>>;
|
|
9294
9293
|
};
|
|
9295
9294
|
/**
|
|
9296
9295
|
* ConnectionsApi - factory interface
|
|
@@ -9304,7 +9303,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9304
9303
|
* @param {*} [options] Override http request option.
|
|
9305
9304
|
* @throws {RequiredError}
|
|
9306
9305
|
*/
|
|
9307
|
-
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>):
|
|
9306
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<AxiosResponse<DeleteConnectionConfirmation, unknown>>;
|
|
9308
9307
|
/**
|
|
9309
9308
|
* Returns a single connection for the specified ID.
|
|
9310
9309
|
* @summary Get connection detail
|
|
@@ -9312,7 +9311,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9312
9311
|
* @param {*} [options] Override http request option.
|
|
9313
9312
|
* @throws {RequiredError}
|
|
9314
9313
|
*/
|
|
9315
|
-
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>):
|
|
9314
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorization, unknown>>;
|
|
9316
9315
|
/**
|
|
9317
9316
|
* Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection. This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
|
|
9318
9317
|
* @summary Force disable connection
|
|
@@ -9320,7 +9319,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9320
9319
|
* @param {*} [options] Override http request option.
|
|
9321
9320
|
* @throws {RequiredError}
|
|
9322
9321
|
*/
|
|
9323
|
-
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>):
|
|
9322
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationDisabledConfirmation, unknown>>;
|
|
9324
9323
|
/**
|
|
9325
9324
|
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total 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.
|
|
9326
9325
|
* @summary List accounts for a connection
|
|
@@ -9328,7 +9327,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9328
9327
|
* @param {*} [options] Override http request option.
|
|
9329
9328
|
* @throws {RequiredError}
|
|
9330
9329
|
*/
|
|
9331
|
-
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>):
|
|
9330
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<AxiosResponse<Array<Account>, unknown>>;
|
|
9332
9331
|
/**
|
|
9333
9332
|
* Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
|
9334
9333
|
* @summary List all connections
|
|
@@ -9336,7 +9335,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9336
9335
|
* @param {*} [options] Override http request option.
|
|
9337
9336
|
* @throws {RequiredError}
|
|
9338
9337
|
*/
|
|
9339
|
-
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>):
|
|
9338
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<AxiosResponse<Array<BrokerageAuthorization>, unknown>>;
|
|
9340
9339
|
/**
|
|
9341
9340
|
* Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. 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 institution. 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.
|
|
9342
9341
|
* @summary List accounts
|
|
@@ -9344,7 +9343,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9344
9343
|
* @param {*} [options] Override http request option.
|
|
9345
9344
|
* @throws {RequiredError}
|
|
9346
9345
|
*/
|
|
9347
|
-
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>):
|
|
9346
|
+
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccountsResponse, unknown>>;
|
|
9348
9347
|
/**
|
|
9349
9348
|
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless SnapTrade uses delayed data for the connection. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to `data_freshness_mode.snaptrade` on a connection to determine this.**
|
|
9350
9349
|
* @summary Refresh holdings for a connection
|
|
@@ -9352,7 +9351,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9352
9351
|
* @param {*} [options] Override http request option.
|
|
9353
9352
|
* @throws {RequiredError}
|
|
9354
9353
|
*/
|
|
9355
|
-
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>):
|
|
9354
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationRefreshConfirmation, unknown>>;
|
|
9356
9355
|
/**
|
|
9357
9356
|
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9358
9357
|
* @summary List connection rate of returns
|
|
@@ -9360,7 +9359,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9360
9359
|
* @param {*} [options] Override http request option.
|
|
9361
9360
|
* @throws {RequiredError}
|
|
9362
9361
|
*/
|
|
9363
|
-
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>):
|
|
9362
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown>>;
|
|
9364
9363
|
/**
|
|
9365
9364
|
* 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
|
|
9366
9365
|
* @summary Sync transactions for a connection
|
|
@@ -9368,7 +9367,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9368
9367
|
* @param {*} [options] Override http request option.
|
|
9369
9368
|
* @throws {RequiredError}
|
|
9370
9369
|
*/
|
|
9371
|
-
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>):
|
|
9370
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, unknown>>;
|
|
9372
9371
|
};
|
|
9373
9372
|
/**
|
|
9374
9373
|
* Request parameters for deleteConnection operation in ConnectionsApi.
|
|
@@ -9627,7 +9626,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9627
9626
|
* @throws {RequiredError}
|
|
9628
9627
|
* @memberof ConnectionsApiGenerated
|
|
9629
9628
|
*/
|
|
9630
|
-
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<
|
|
9629
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<AxiosResponse<DeleteConnectionConfirmation, unknown, {}, any>>;
|
|
9631
9630
|
/**
|
|
9632
9631
|
* Returns a single connection for the specified ID.
|
|
9633
9632
|
* @summary Get connection detail
|
|
@@ -9636,7 +9635,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9636
9635
|
* @throws {RequiredError}
|
|
9637
9636
|
* @memberof ConnectionsApiGenerated
|
|
9638
9637
|
*/
|
|
9639
|
-
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<
|
|
9638
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorization, unknown, {}, any>>;
|
|
9640
9639
|
/**
|
|
9641
9640
|
* Manually force the specified connection to become disabled. This should only be used for testing a reconnect flow, and never used on production connections. Will trigger a disconnect as if it happened naturally, and send a [`CONNECTION_BROKEN` webhook](/docs/webhooks#webhooks-connection_broken) for the connection. This endpoint is available on test keys. If you would like it enabled on production keys as well, please contact support as it is disabled by default.
|
|
9642
9641
|
* @summary Force disable connection
|
|
@@ -9645,7 +9644,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9645
9644
|
* @throws {RequiredError}
|
|
9646
9645
|
* @memberof ConnectionsApiGenerated
|
|
9647
9646
|
*/
|
|
9648
|
-
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<
|
|
9647
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationDisabledConfirmation, unknown, {}, any>>;
|
|
9649
9648
|
/**
|
|
9650
9649
|
* Returns all brokerage accounts that belong to the specified connection for the authenticated user. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date, funding date, and total 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.
|
|
9651
9650
|
* @summary List accounts for a connection
|
|
@@ -9654,7 +9653,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9654
9653
|
* @throws {RequiredError}
|
|
9655
9654
|
* @memberof ConnectionsApiGenerated
|
|
9656
9655
|
*/
|
|
9657
|
-
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<
|
|
9656
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<AxiosResponse<Account[], unknown, {}, any>>;
|
|
9658
9657
|
/**
|
|
9659
9658
|
* Returns a list of all connections for the specified user. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency. A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts. SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
|
|
9660
9659
|
* @summary List all connections
|
|
@@ -9663,7 +9662,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9663
9662
|
* @throws {RequiredError}
|
|
9664
9663
|
* @memberof ConnectionsApiGenerated
|
|
9665
9664
|
*/
|
|
9666
|
-
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<
|
|
9665
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorization[], unknown, {}, any>>;
|
|
9667
9666
|
/**
|
|
9668
9667
|
* Returns all accounts that belong to the specified connection for the authenticated user. The `results` list can contain multiple account types in the same response, including investment, deposit, and line of credit accounts. Use the `kind` discriminator to determine the schema for each account. On Pay as you Go / Real-time, this endpoint refreshes each account\'s opening date and total net value (`net_value`) live from the institution on each call, along with funding date for `investment` accounts. 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 institution. 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.
|
|
9669
9668
|
* @summary List accounts
|
|
@@ -9672,7 +9671,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9672
9671
|
* @throws {RequiredError}
|
|
9673
9672
|
* @memberof ConnectionsApiGenerated
|
|
9674
9673
|
*/
|
|
9675
|
-
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<
|
|
9674
|
+
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccountsResponse, unknown, {}, any>>;
|
|
9676
9675
|
/**
|
|
9677
9676
|
* Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occurred. **Because of the cost of refreshing a connection, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)** **Please note this endpoint is disabled for Real-time plans (Personal and Pay as you go) unless SnapTrade uses delayed data for the connection. Real-time connections do not benefit from this feature since data is refreshed when calls are made. Refer to `data_freshness_mode.snaptrade` on a connection to determine this.**
|
|
9678
9677
|
* @summary Refresh holdings for a connection
|
|
@@ -9681,7 +9680,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9681
9680
|
* @throws {RequiredError}
|
|
9682
9681
|
* @memberof ConnectionsApiGenerated
|
|
9683
9682
|
*/
|
|
9684
|
-
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<
|
|
9683
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationRefreshConfirmation, unknown, {}, any>>;
|
|
9685
9684
|
/**
|
|
9686
9685
|
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9687
9686
|
* @summary List connection rate of returns
|
|
@@ -9690,7 +9689,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9690
9689
|
* @throws {RequiredError}
|
|
9691
9690
|
* @memberof ConnectionsApiGenerated
|
|
9692
9691
|
*/
|
|
9693
|
-
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<
|
|
9692
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown, {}, any>>;
|
|
9694
9693
|
/**
|
|
9695
9694
|
* 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
|
|
9696
9695
|
* @summary Sync transactions for a connection
|
|
@@ -9699,7 +9698,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9699
9698
|
* @throws {RequiredError}
|
|
9700
9699
|
* @memberof ConnectionsApiGenerated
|
|
9701
9700
|
*/
|
|
9702
|
-
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<
|
|
9701
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, unknown, {}, any>>;
|
|
9703
9702
|
}
|
|
9704
9703
|
//#endregion
|
|
9705
9704
|
//#region api/connections-api.d.ts
|
|
@@ -9794,7 +9793,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9794
9793
|
* @param {*} [options] Override http request option.
|
|
9795
9794
|
* @throws {RequiredError}
|
|
9796
9795
|
*/
|
|
9797
|
-
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9796
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TradeDetectionSubscription, unknown>>>;
|
|
9798
9797
|
/**
|
|
9799
9798
|
* Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
|
|
9800
9799
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9802,7 +9801,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9802
9801
|
* @param {*} [options] Override http request option.
|
|
9803
9802
|
* @throws {RequiredError}
|
|
9804
9803
|
*/
|
|
9805
|
-
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9804
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TradeDetectionCancelSubscriptionResponse, unknown>>>;
|
|
9806
9805
|
/**
|
|
9807
9806
|
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
9808
9807
|
* @summary Get account order detail (V2)
|
|
@@ -9810,7 +9809,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9810
9809
|
* @param {*} [options] Override http request option.
|
|
9811
9810
|
* @throws {RequiredError}
|
|
9812
9811
|
*/
|
|
9813
|
-
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9812
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecordV2, unknown>>>;
|
|
9814
9813
|
/**
|
|
9815
9814
|
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. 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.
|
|
9816
9815
|
* @summary List account orders v2
|
|
@@ -9818,7 +9817,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9818
9817
|
* @param {*} [options] Override http request option.
|
|
9819
9818
|
* @throws {RequiredError}
|
|
9820
9819
|
*/
|
|
9821
|
-
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9820
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrdersV2Response, unknown>>>;
|
|
9822
9821
|
/**
|
|
9823
9822
|
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. 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 realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
9824
9823
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9826,14 +9825,14 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9826
9825
|
* @param {*} [options] Override http request option.
|
|
9827
9826
|
* @throws {RequiredError}
|
|
9828
9827
|
*/
|
|
9829
|
-
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9828
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrdersV2Response, unknown>>>;
|
|
9830
9829
|
/**
|
|
9831
9830
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9832
9831
|
* @summary List active Trade Detection subscriptions
|
|
9833
9832
|
* @param {*} [options] Override http request option.
|
|
9834
9833
|
* @throws {RequiredError}
|
|
9835
9834
|
*/
|
|
9836
|
-
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9835
|
+
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<TradeDetectionSubscription>, unknown>>>;
|
|
9837
9836
|
/**
|
|
9838
9837
|
* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase. Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages). An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders. All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces. A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details.
|
|
9839
9838
|
* @summary Place a simple order (beta)
|
|
@@ -9841,7 +9840,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9841
9840
|
* @param {*} [options] Override http request option.
|
|
9842
9841
|
* @throws {RequiredError}
|
|
9843
9842
|
*/
|
|
9844
|
-
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9843
|
+
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SimpleTradeResponse, unknown>>>;
|
|
9845
9844
|
};
|
|
9846
9845
|
/**
|
|
9847
9846
|
* ExperimentalEndpointsApi - factory interface
|
|
@@ -9855,7 +9854,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9855
9854
|
* @param {*} [options] Override http request option.
|
|
9856
9855
|
* @throws {RequiredError}
|
|
9857
9856
|
*/
|
|
9858
|
-
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>):
|
|
9857
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionSubscription, unknown>>;
|
|
9859
9858
|
/**
|
|
9860
9859
|
* Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
|
|
9861
9860
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9863,7 +9862,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9863
9862
|
* @param {*} [options] Override http request option.
|
|
9864
9863
|
* @throws {RequiredError}
|
|
9865
9864
|
*/
|
|
9866
|
-
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>):
|
|
9865
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionCancelSubscriptionResponse, unknown>>;
|
|
9867
9866
|
/**
|
|
9868
9867
|
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
9869
9868
|
* @summary Get account order detail (V2)
|
|
@@ -9871,7 +9870,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9871
9870
|
* @param {*} [options] Override http request option.
|
|
9872
9871
|
* @throws {RequiredError}
|
|
9873
9872
|
*/
|
|
9874
|
-
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>):
|
|
9873
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<AxiosResponse<AccountOrderRecordV2, unknown>>;
|
|
9875
9874
|
/**
|
|
9876
9875
|
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. 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.
|
|
9877
9876
|
* @summary List account orders v2
|
|
@@ -9879,7 +9878,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9879
9878
|
* @param {*} [options] Override http request option.
|
|
9880
9879
|
* @throws {RequiredError}
|
|
9881
9880
|
*/
|
|
9882
|
-
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>):
|
|
9881
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown>>;
|
|
9883
9882
|
/**
|
|
9884
9883
|
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. 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 realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
9885
9884
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9887,14 +9886,14 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9887
9886
|
* @param {*} [options] Override http request option.
|
|
9888
9887
|
* @throws {RequiredError}
|
|
9889
9888
|
*/
|
|
9890
|
-
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>):
|
|
9889
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown>>;
|
|
9891
9890
|
/**
|
|
9892
9891
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9893
9892
|
* @summary List active Trade Detection subscriptions
|
|
9894
9893
|
* @param {*} [options] Override http request option.
|
|
9895
9894
|
* @throws {RequiredError}
|
|
9896
9895
|
*/
|
|
9897
|
-
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
9896
|
+
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<TradeDetectionSubscription>, unknown>>;
|
|
9898
9897
|
/**
|
|
9899
9898
|
* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase. Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages). An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders. All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces. A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details.
|
|
9900
9899
|
* @summary Place a simple order (beta)
|
|
@@ -9902,7 +9901,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9902
9901
|
* @param {*} [options] Override http request option.
|
|
9903
9902
|
* @throws {RequiredError}
|
|
9904
9903
|
*/
|
|
9905
|
-
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>):
|
|
9904
|
+
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<AxiosResponse<SimpleTradeResponse, unknown>>;
|
|
9906
9905
|
};
|
|
9907
9906
|
/**
|
|
9908
9907
|
* Request parameters for addSubscription operation in ExperimentalEndpointsApi.
|
|
@@ -10085,7 +10084,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10085
10084
|
* @throws {RequiredError}
|
|
10086
10085
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10087
10086
|
*/
|
|
10088
|
-
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<
|
|
10087
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionSubscription, unknown, {}, any>>;
|
|
10089
10088
|
/**
|
|
10090
10089
|
* Cancels a Trade Detection subscription for a connected brokerage account. This endpoint requires partner signature authentication only and does not require `userId` or `userSecret`.
|
|
10091
10090
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -10094,7 +10093,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10094
10093
|
* @throws {RequiredError}
|
|
10095
10094
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10096
10095
|
*/
|
|
10097
|
-
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<
|
|
10096
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionCancelSubscriptionResponse, unknown, {}, any>>;
|
|
10098
10097
|
/**
|
|
10099
10098
|
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
10100
10099
|
* @summary Get account order detail (V2)
|
|
@@ -10103,7 +10102,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10103
10102
|
* @throws {RequiredError}
|
|
10104
10103
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10105
10104
|
*/
|
|
10106
|
-
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<
|
|
10105
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<AxiosResponse<AccountOrderRecordV2, unknown, {}, any>>;
|
|
10107
10106
|
/**
|
|
10108
10107
|
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. 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.
|
|
10109
10108
|
* @summary List account orders v2
|
|
@@ -10112,7 +10111,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10112
10111
|
* @throws {RequiredError}
|
|
10113
10112
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10114
10113
|
*/
|
|
10115
|
-
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<
|
|
10114
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown, {}, any>>;
|
|
10116
10115
|
/**
|
|
10117
10116
|
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. 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 realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
10118
10117
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -10121,7 +10120,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10121
10120
|
* @throws {RequiredError}
|
|
10122
10121
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10123
10122
|
*/
|
|
10124
|
-
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<
|
|
10123
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown, {}, any>>;
|
|
10125
10124
|
/**
|
|
10126
10125
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
10127
10126
|
* @summary List active Trade Detection subscriptions
|
|
@@ -10129,7 +10128,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10129
10128
|
* @throws {RequiredError}
|
|
10130
10129
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10131
10130
|
*/
|
|
10132
|
-
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10131
|
+
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<TradeDetectionSubscription[], unknown, {}, any>>;
|
|
10133
10132
|
/**
|
|
10134
10133
|
* **Beta.** Places a single-leg or multi-leg order using a common request format for equities, equity options, futures, and future options. This endpoint is experimental; breaking changes are possible during the experimental phase. Equity and equity-option orders use the existing brokerage trading capabilities. Futures and future options are currently supported only on tastytrade. Order types, time in force, optional fields, and strategy combinations remain subject to brokerage support. See the [brokerage trading support page](https://support.snaptrade.com/brokerages). An order may contain equity/option legs or future/future_option legs, but cannot mix those two families. Equity/option strategies must share the same underlying symbol. Each strategy is submitted as one brokerage order; unsupported strategies are never split into independent orders. Tastytrade supports single-leg outright futures and up to four future-option legs, and does not support multi-leg market orders. All string choices use lower snake_case and are case-sensitive. Symbols retain their native format: equity tickers, OCC equity-option symbols, or the exact tastytrade BrokerageInstrument ticker for futures and future options, including any spaces. A successful response contains only the brokerage order ID. Use the existing order endpoints to retrieve order details.
|
|
10135
10134
|
* @summary Place a simple order (beta)
|
|
@@ -10138,7 +10137,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10138
10137
|
* @throws {RequiredError}
|
|
10139
10138
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10140
10139
|
*/
|
|
10141
|
-
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<
|
|
10140
|
+
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<AxiosResponse<SimpleTradeResponse, unknown, {}, any>>;
|
|
10142
10141
|
}
|
|
10143
10142
|
//#endregion
|
|
10144
10143
|
//#region api/experimental-endpoints-api.d.ts
|
|
@@ -10233,14 +10232,14 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10233
10232
|
* @param {*} [options] Override http request option.
|
|
10234
10233
|
* @throws {RequiredError}
|
|
10235
10234
|
*/
|
|
10236
|
-
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10235
|
+
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PartnerData, unknown>>>;
|
|
10237
10236
|
/**
|
|
10238
10237
|
* Returns a list of all supported Exchanges.
|
|
10239
10238
|
* @summary Get exchanges
|
|
10240
10239
|
* @param {*} [options] Override http request option.
|
|
10241
10240
|
* @throws {RequiredError}
|
|
10242
10241
|
*/
|
|
10243
|
-
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10242
|
+
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Exchange>, unknown>>>;
|
|
10244
10243
|
/**
|
|
10245
10244
|
* 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.
|
|
10246
10245
|
* @summary Search symbols
|
|
@@ -10248,7 +10247,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10248
10247
|
* @param {*} [options] Override http request option.
|
|
10249
10248
|
* @throws {RequiredError}
|
|
10250
10249
|
*/
|
|
10251
|
-
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10250
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>>;
|
|
10252
10251
|
/**
|
|
10253
10252
|
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Share classes and preferred series use SnapTrade\'s canonical dotted form: use `HBND.U.TO` (not Yahoo\'s `HBND-U.TO`), `FTN.PR.A.TO` (not `FTN-PA.TO`), and `ECF.PRA` (not `ECF-P-A`). Please use the ticker with the proper suffix and canonical share-class notation for the best results.
|
|
10254
10253
|
* @summary Get symbol detail
|
|
@@ -10256,7 +10255,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10256
10255
|
* @param {*} [options] Override http request option.
|
|
10257
10256
|
* @throws {RequiredError}
|
|
10258
10257
|
*/
|
|
10259
|
-
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10258
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UniversalSymbol, unknown>>>;
|
|
10260
10259
|
/**
|
|
10261
10260
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
10262
10261
|
* @summary Get all brokerage authorization types
|
|
@@ -10264,7 +10263,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10264
10263
|
* @param {*} [options] Override http request option.
|
|
10265
10264
|
* @throws {RequiredError}
|
|
10266
10265
|
*/
|
|
10267
|
-
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10266
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<BrokerageAuthorizationTypeReadOnly>, unknown>>>;
|
|
10268
10267
|
/**
|
|
10269
10268
|
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
10270
10269
|
* @summary Get brokerage instruments
|
|
@@ -10272,21 +10271,21 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10272
10271
|
* @param {*} [options] Override http request option.
|
|
10273
10272
|
* @throws {RequiredError}
|
|
10274
10273
|
*/
|
|
10275
|
-
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10274
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageInstrumentsResponse, unknown>>>;
|
|
10276
10275
|
/**
|
|
10277
10276
|
* Returns a list of all defined Brokerage objects.
|
|
10278
10277
|
* @summary Get brokerages
|
|
10279
10278
|
* @param {*} [options] Override http request option.
|
|
10280
10279
|
* @throws {RequiredError}
|
|
10281
10280
|
*/
|
|
10282
|
-
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10281
|
+
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Brokerage>, unknown>>>;
|
|
10283
10282
|
/**
|
|
10284
10283
|
* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead. A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize.
|
|
10285
10284
|
* @summary List institutions
|
|
10286
10285
|
* @param {*} [options] Override http request option.
|
|
10287
10286
|
* @throws {RequiredError}
|
|
10288
10287
|
*/
|
|
10289
|
-
listInstitutions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10288
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Institution>, unknown>>>;
|
|
10290
10289
|
/**
|
|
10291
10290
|
* 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.
|
|
10292
10291
|
* @summary Search account symbols
|
|
@@ -10294,7 +10293,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10294
10293
|
* @param {*} [options] Override http request option.
|
|
10295
10294
|
* @throws {RequiredError}
|
|
10296
10295
|
*/
|
|
10297
|
-
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10296
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>>;
|
|
10298
10297
|
};
|
|
10299
10298
|
/**
|
|
10300
10299
|
* ReferenceDataApi - factory interface
|
|
@@ -10307,14 +10306,14 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10307
10306
|
* @param {*} [options] Override http request option.
|
|
10308
10307
|
* @throws {RequiredError}
|
|
10309
10308
|
*/
|
|
10310
|
-
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
10309
|
+
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<PartnerData, unknown>>;
|
|
10311
10310
|
/**
|
|
10312
10311
|
* Returns a list of all supported Exchanges.
|
|
10313
10312
|
* @summary Get exchanges
|
|
10314
10313
|
* @param {*} [options] Override http request option.
|
|
10315
10314
|
* @throws {RequiredError}
|
|
10316
10315
|
*/
|
|
10317
|
-
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
10316
|
+
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<Exchange>, unknown>>;
|
|
10318
10317
|
/**
|
|
10319
10318
|
* 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.
|
|
10320
10319
|
* @summary Search symbols
|
|
@@ -10322,7 +10321,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10322
10321
|
* @param {*} [options] Override http request option.
|
|
10323
10322
|
* @throws {RequiredError}
|
|
10324
10323
|
*/
|
|
10325
|
-
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>):
|
|
10324
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>;
|
|
10326
10325
|
/**
|
|
10327
10326
|
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Share classes and preferred series use SnapTrade\'s canonical dotted form: use `HBND.U.TO` (not Yahoo\'s `HBND-U.TO`), `FTN.PR.A.TO` (not `FTN-PA.TO`), and `ECF.PRA` (not `ECF-P-A`). Please use the ticker with the proper suffix and canonical share-class notation for the best results.
|
|
10328
10327
|
* @summary Get symbol detail
|
|
@@ -10330,7 +10329,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10330
10329
|
* @param {*} [options] Override http request option.
|
|
10331
10330
|
* @throws {RequiredError}
|
|
10332
10331
|
*/
|
|
10333
|
-
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>):
|
|
10332
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol, unknown>>;
|
|
10334
10333
|
/**
|
|
10335
10334
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
10336
10335
|
* @summary Get all brokerage authorization types
|
|
@@ -10338,7 +10337,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10338
10337
|
* @param {*} [options] Override http request option.
|
|
10339
10338
|
* @throws {RequiredError}
|
|
10340
10339
|
*/
|
|
10341
|
-
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>):
|
|
10340
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<AxiosResponse<Array<BrokerageAuthorizationTypeReadOnly>, unknown>>;
|
|
10342
10341
|
/**
|
|
10343
10342
|
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
10344
10343
|
* @summary Get brokerage instruments
|
|
@@ -10346,21 +10345,21 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10346
10345
|
* @param {*} [options] Override http request option.
|
|
10347
10346
|
* @throws {RequiredError}
|
|
10348
10347
|
*/
|
|
10349
|
-
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>):
|
|
10348
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<AxiosResponse<BrokerageInstrumentsResponse, unknown>>;
|
|
10350
10349
|
/**
|
|
10351
10350
|
* Returns a list of all defined Brokerage objects.
|
|
10352
10351
|
* @summary Get brokerages
|
|
10353
10352
|
* @param {*} [options] Override http request option.
|
|
10354
10353
|
* @throws {RequiredError}
|
|
10355
10354
|
*/
|
|
10356
|
-
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
10355
|
+
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<Brokerage>, unknown>>;
|
|
10357
10356
|
/**
|
|
10358
10357
|
* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead. A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize.
|
|
10359
10358
|
* @summary List institutions
|
|
10360
10359
|
* @param {*} [options] Override http request option.
|
|
10361
10360
|
* @throws {RequiredError}
|
|
10362
10361
|
*/
|
|
10363
|
-
listInstitutions(options?: AxiosRequestConfig):
|
|
10362
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Institution>, unknown>>;
|
|
10364
10363
|
/**
|
|
10365
10364
|
* 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.
|
|
10366
10365
|
* @summary Search account symbols
|
|
@@ -10368,7 +10367,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10368
10367
|
* @param {*} [options] Override http request option.
|
|
10369
10368
|
* @throws {RequiredError}
|
|
10370
10369
|
*/
|
|
10371
|
-
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>):
|
|
10370
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>;
|
|
10372
10371
|
};
|
|
10373
10372
|
/**
|
|
10374
10373
|
* Request parameters for getSymbols operation in ReferenceDataApi.
|
|
@@ -10488,7 +10487,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10488
10487
|
* @throws {RequiredError}
|
|
10489
10488
|
* @memberof ReferenceDataApiGenerated
|
|
10490
10489
|
*/
|
|
10491
|
-
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10490
|
+
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<PartnerData, unknown, {}, any>>;
|
|
10492
10491
|
/**
|
|
10493
10492
|
* Returns a list of all supported Exchanges.
|
|
10494
10493
|
* @summary Get exchanges
|
|
@@ -10496,7 +10495,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10496
10495
|
* @throws {RequiredError}
|
|
10497
10496
|
* @memberof ReferenceDataApiGenerated
|
|
10498
10497
|
*/
|
|
10499
|
-
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10498
|
+
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Exchange[], unknown, {}, any>>;
|
|
10500
10499
|
/**
|
|
10501
10500
|
* 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.
|
|
10502
10501
|
* @summary Search symbols
|
|
@@ -10505,7 +10504,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10505
10504
|
* @throws {RequiredError}
|
|
10506
10505
|
* @memberof ReferenceDataApiGenerated
|
|
10507
10506
|
*/
|
|
10508
|
-
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<
|
|
10507
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol[], unknown, {}, any>>;
|
|
10509
10508
|
/**
|
|
10510
10509
|
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Share classes and preferred series use SnapTrade\'s canonical dotted form: use `HBND.U.TO` (not Yahoo\'s `HBND-U.TO`), `FTN.PR.A.TO` (not `FTN-PA.TO`), and `ECF.PRA` (not `ECF-P-A`). Please use the ticker with the proper suffix and canonical share-class notation for the best results.
|
|
10511
10510
|
* @summary Get symbol detail
|
|
@@ -10514,7 +10513,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10514
10513
|
* @throws {RequiredError}
|
|
10515
10514
|
* @memberof ReferenceDataApiGenerated
|
|
10516
10515
|
*/
|
|
10517
|
-
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<
|
|
10516
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol, unknown, {}, any>>;
|
|
10518
10517
|
/**
|
|
10519
10518
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
10520
10519
|
* @summary Get all brokerage authorization types
|
|
@@ -10523,7 +10522,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10523
10522
|
* @throws {RequiredError}
|
|
10524
10523
|
* @memberof ReferenceDataApiGenerated
|
|
10525
10524
|
*/
|
|
10526
|
-
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<
|
|
10525
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationTypeReadOnly[], unknown, {}, any>>;
|
|
10527
10526
|
/**
|
|
10528
10527
|
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
10529
10528
|
* @summary Get brokerage instruments
|
|
@@ -10532,7 +10531,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10532
10531
|
* @throws {RequiredError}
|
|
10533
10532
|
* @memberof ReferenceDataApiGenerated
|
|
10534
10533
|
*/
|
|
10535
|
-
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<
|
|
10534
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<AxiosResponse<BrokerageInstrumentsResponse, unknown, {}, any>>;
|
|
10536
10535
|
/**
|
|
10537
10536
|
* Returns a list of all defined Brokerage objects.
|
|
10538
10537
|
* @summary Get brokerages
|
|
@@ -10540,7 +10539,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10540
10539
|
* @throws {RequiredError}
|
|
10541
10540
|
* @memberof ReferenceDataApiGenerated
|
|
10542
10541
|
*/
|
|
10543
|
-
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10542
|
+
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Brokerage[], unknown, {}, any>>;
|
|
10544
10543
|
/**
|
|
10545
10544
|
* Returns the public catalog of institutions SnapTrade supports and what each one supports. The response is the same for every caller and needs no authentication. To list the brokerages a specific Client ID can connect to right now, use `GET /brokerages` instead. A `null` field means the information is not documented yet, never that the institution lacks it. New fields and new enum values may be added over time, so ignore any you don\'t recognize.
|
|
10546
10545
|
* @summary List institutions
|
|
@@ -10548,7 +10547,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10548
10547
|
* @throws {RequiredError}
|
|
10549
10548
|
* @memberof ReferenceDataApiGenerated
|
|
10550
10549
|
*/
|
|
10551
|
-
listInstitutions(options?: AxiosRequestConfig): Promise<
|
|
10550
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<AxiosResponse<Institution[], unknown, {}, any>>;
|
|
10552
10551
|
/**
|
|
10553
10552
|
* 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.
|
|
10554
10553
|
* @summary Search account symbols
|
|
@@ -10557,7 +10556,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10557
10556
|
* @throws {RequiredError}
|
|
10558
10557
|
* @memberof ReferenceDataApiGenerated
|
|
10559
10558
|
*/
|
|
10560
|
-
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<
|
|
10559
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol[], unknown, {}, any>>;
|
|
10561
10560
|
}
|
|
10562
10561
|
//#endregion
|
|
10563
10562
|
//#region api/reference-data-api.d.ts
|
|
@@ -10737,7 +10736,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10737
10736
|
* @param {*} [options] Override http request option.
|
|
10738
10737
|
* @throws {RequiredError}
|
|
10739
10738
|
*/
|
|
10740
|
-
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10739
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CancelOrderResponse, unknown>>>;
|
|
10741
10740
|
/**
|
|
10742
10741
|
* Gets a quote for the specified account.
|
|
10743
10742
|
* @summary Get crypto pair quote
|
|
@@ -10745,7 +10744,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10745
10744
|
* @param {*} [options] Override http request option.
|
|
10746
10745
|
* @throws {RequiredError}
|
|
10747
10746
|
*/
|
|
10748
|
-
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10747
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CryptocurrencyPairQuote, unknown>>>;
|
|
10749
10748
|
/**
|
|
10750
10749
|
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
10751
10750
|
* @summary Get option order impact
|
|
@@ -10753,7 +10752,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10753
10752
|
* @param {*} [options] Override http request option.
|
|
10754
10753
|
* @throws {RequiredError}
|
|
10755
10754
|
*/
|
|
10756
|
-
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10755
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OptionImpact, unknown>>>;
|
|
10757
10756
|
/**
|
|
10758
10757
|
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
10759
10758
|
* @summary Check equity order impact
|
|
@@ -10761,7 +10760,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10761
10760
|
* @param {*} [options] Override http request option.
|
|
10762
10761
|
* @throws {RequiredError}
|
|
10763
10762
|
*/
|
|
10764
|
-
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10763
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ManualTradeAndImpact, unknown>>>;
|
|
10765
10764
|
/**
|
|
10766
10765
|
* **Deprecated.** This endpoint was sunset on October 1, 2026 and now always returns `410 Gone`. Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
10767
10766
|
* @summary Get option quote
|
|
@@ -10770,7 +10769,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10770
10769
|
* @deprecated
|
|
10771
10770
|
* @throws {RequiredError}
|
|
10772
10771
|
*/
|
|
10773
|
-
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10772
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OptionQuote, unknown>>>;
|
|
10774
10773
|
/**
|
|
10775
10774
|
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
10776
10775
|
* @summary Get equity symbol quotes
|
|
@@ -10778,7 +10777,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10778
10777
|
* @param {*} [options] Override http request option.
|
|
10779
10778
|
* @throws {RequiredError}
|
|
10780
10779
|
*/
|
|
10781
|
-
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10780
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<SymbolsQuotesInner>, unknown>>>;
|
|
10782
10781
|
/**
|
|
10783
10782
|
* 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. Option OCO peers must trade the same OCC option symbol with the same closing action and positive whole-contract quantity. On tastytrade, option OCO supports closing an existing long or short option position with one `Limit` order and one `Stop` or `StopLimit` order. Both `PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with `Day` or `GTC` time in force. Opening option OCOs are not supported. On enabled Webull US v3 accounts, option OCO supports closing an existing long option position with one `Limit` take-profit order and one `Stop` stop-loss order. Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol, and the same positive whole-contract quantity. Webull receives these as `STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order. Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs are not supported on Webull. Equity complex-order behavior is unchanged.
|
|
10784
10783
|
* @summary Place complex order
|
|
@@ -10786,7 +10785,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10786
10785
|
* @param {*} [options] Override http request option.
|
|
10787
10786
|
* @throws {RequiredError}
|
|
10788
10787
|
*/
|
|
10789
|
-
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10788
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ComplexOrderResponse, unknown>>>;
|
|
10790
10789
|
/**
|
|
10791
10790
|
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
10792
10791
|
* @summary Place crypto order
|
|
@@ -10794,7 +10793,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10794
10793
|
* @param {*} [options] Override http request option.
|
|
10795
10794
|
* @throws {RequiredError}
|
|
10796
10795
|
*/
|
|
10797
|
-
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10796
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OrderUpdatedResponse, unknown>>>;
|
|
10798
10797
|
/**
|
|
10799
10798
|
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
10800
10799
|
* @summary Place equity order
|
|
@@ -10802,7 +10801,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10802
10801
|
* @param {*} [options] Override http request option.
|
|
10803
10802
|
* @throws {RequiredError}
|
|
10804
10803
|
*/
|
|
10805
|
-
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10804
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
10806
10805
|
/**
|
|
10807
10806
|
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
10808
10807
|
* @summary Place option order
|
|
@@ -10810,7 +10809,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10810
10809
|
* @param {*} [options] Override http request option.
|
|
10811
10810
|
* @throws {RequiredError}
|
|
10812
10811
|
*/
|
|
10813
|
-
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10812
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<MlegOrderResponse, unknown>>>;
|
|
10814
10813
|
/**
|
|
10815
10814
|
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
10816
10815
|
* @summary Place checked equity order
|
|
@@ -10818,7 +10817,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10818
10817
|
* @param {*} [options] Override http request option.
|
|
10819
10818
|
* @throws {RequiredError}
|
|
10820
10819
|
*/
|
|
10821
|
-
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10820
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
10822
10821
|
/**
|
|
10823
10822
|
* Previews an order using the specified account.
|
|
10824
10823
|
* @summary Preview crypto order
|
|
@@ -10826,7 +10825,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10826
10825
|
* @param {*} [options] Override http request option.
|
|
10827
10826
|
* @throws {RequiredError}
|
|
10828
10827
|
*/
|
|
10829
|
-
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10828
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CryptoOrderPreview, unknown>>>;
|
|
10830
10829
|
/**
|
|
10831
10830
|
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
10832
10831
|
* @summary Replace order
|
|
@@ -10834,7 +10833,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10834
10833
|
* @param {*} [options] Override http request option.
|
|
10835
10834
|
* @throws {RequiredError}
|
|
10836
10835
|
*/
|
|
10837
|
-
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10836
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
10838
10837
|
/**
|
|
10839
10838
|
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
10840
10839
|
* @summary Get crypto pairs
|
|
@@ -10842,7 +10841,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10842
10841
|
* @param {*} [options] Override http request option.
|
|
10843
10842
|
* @throws {RequiredError}
|
|
10844
10843
|
*/
|
|
10845
|
-
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10844
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, unknown>>>;
|
|
10846
10845
|
};
|
|
10847
10846
|
/**
|
|
10848
10847
|
* TradingApi - factory interface
|
|
@@ -10856,7 +10855,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10856
10855
|
* @param {*} [options] Override http request option.
|
|
10857
10856
|
* @throws {RequiredError}
|
|
10858
10857
|
*/
|
|
10859
|
-
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>):
|
|
10858
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<AxiosResponse<CancelOrderResponse, unknown>>;
|
|
10860
10859
|
/**
|
|
10861
10860
|
* Gets a quote for the specified account.
|
|
10862
10861
|
* @summary Get crypto pair quote
|
|
@@ -10864,7 +10863,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10864
10863
|
* @param {*} [options] Override http request option.
|
|
10865
10864
|
* @throws {RequiredError}
|
|
10866
10865
|
*/
|
|
10867
|
-
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>):
|
|
10866
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<AxiosResponse<CryptocurrencyPairQuote, unknown>>;
|
|
10868
10867
|
/**
|
|
10869
10868
|
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
10870
10869
|
* @summary Get option order impact
|
|
@@ -10872,7 +10871,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10872
10871
|
* @param {*} [options] Override http request option.
|
|
10873
10872
|
* @throws {RequiredError}
|
|
10874
10873
|
*/
|
|
10875
|
-
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>):
|
|
10874
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<AxiosResponse<OptionImpact, unknown>>;
|
|
10876
10875
|
/**
|
|
10877
10876
|
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
10878
10877
|
* @summary Check equity order impact
|
|
@@ -10880,7 +10879,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10880
10879
|
* @param {*} [options] Override http request option.
|
|
10881
10880
|
* @throws {RequiredError}
|
|
10882
10881
|
*/
|
|
10883
|
-
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>):
|
|
10882
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<AxiosResponse<ManualTradeAndImpact, unknown>>;
|
|
10884
10883
|
/**
|
|
10885
10884
|
* **Deprecated.** This endpoint was sunset on October 1, 2026 and now always returns `410 Gone`. Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
10886
10885
|
* @summary Get option quote
|
|
@@ -10889,7 +10888,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10889
10888
|
* @deprecated
|
|
10890
10889
|
* @throws {RequiredError}
|
|
10891
10890
|
*/
|
|
10892
|
-
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>):
|
|
10891
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<AxiosResponse<OptionQuote, unknown>>;
|
|
10893
10892
|
/**
|
|
10894
10893
|
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
10895
10894
|
* @summary Get equity symbol quotes
|
|
@@ -10897,7 +10896,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10897
10896
|
* @param {*} [options] Override http request option.
|
|
10898
10897
|
* @throws {RequiredError}
|
|
10899
10898
|
*/
|
|
10900
|
-
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>):
|
|
10899
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<AxiosResponse<Array<SymbolsQuotesInner>, unknown>>;
|
|
10901
10900
|
/**
|
|
10902
10901
|
* 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. Option OCO peers must trade the same OCC option symbol with the same closing action and positive whole-contract quantity. On tastytrade, option OCO supports closing an existing long or short option position with one `Limit` order and one `Stop` or `StopLimit` order. Both `PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with `Day` or `GTC` time in force. Opening option OCOs are not supported. On enabled Webull US v3 accounts, option OCO supports closing an existing long option position with one `Limit` take-profit order and one `Stop` stop-loss order. Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol, and the same positive whole-contract quantity. Webull receives these as `STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order. Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs are not supported on Webull. Equity complex-order behavior is unchanged.
|
|
10903
10902
|
* @summary Place complex order
|
|
@@ -10905,7 +10904,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10905
10904
|
* @param {*} [options] Override http request option.
|
|
10906
10905
|
* @throws {RequiredError}
|
|
10907
10906
|
*/
|
|
10908
|
-
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>):
|
|
10907
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<AxiosResponse<ComplexOrderResponse, unknown>>;
|
|
10909
10908
|
/**
|
|
10910
10909
|
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
10911
10910
|
* @summary Place crypto order
|
|
@@ -10913,7 +10912,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10913
10912
|
* @param {*} [options] Override http request option.
|
|
10914
10913
|
* @throws {RequiredError}
|
|
10915
10914
|
*/
|
|
10916
|
-
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>):
|
|
10915
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<AxiosResponse<OrderUpdatedResponse, unknown>>;
|
|
10917
10916
|
/**
|
|
10918
10917
|
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
10919
10918
|
* @summary Place equity order
|
|
@@ -10921,7 +10920,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10921
10920
|
* @param {*} [options] Override http request option.
|
|
10922
10921
|
* @throws {RequiredError}
|
|
10923
10922
|
*/
|
|
10924
|
-
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>):
|
|
10923
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
10925
10924
|
/**
|
|
10926
10925
|
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
10927
10926
|
* @summary Place option order
|
|
@@ -10929,7 +10928,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10929
10928
|
* @param {*} [options] Override http request option.
|
|
10930
10929
|
* @throws {RequiredError}
|
|
10931
10930
|
*/
|
|
10932
|
-
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>):
|
|
10931
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<AxiosResponse<MlegOrderResponse, unknown>>;
|
|
10933
10932
|
/**
|
|
10934
10933
|
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
10935
10934
|
* @summary Place checked equity order
|
|
@@ -10937,7 +10936,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10937
10936
|
* @param {*} [options] Override http request option.
|
|
10938
10937
|
* @throws {RequiredError}
|
|
10939
10938
|
*/
|
|
10940
|
-
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>):
|
|
10939
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
10941
10940
|
/**
|
|
10942
10941
|
* Previews an order using the specified account.
|
|
10943
10942
|
* @summary Preview crypto order
|
|
@@ -10945,7 +10944,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10945
10944
|
* @param {*} [options] Override http request option.
|
|
10946
10945
|
* @throws {RequiredError}
|
|
10947
10946
|
*/
|
|
10948
|
-
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>):
|
|
10947
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<AxiosResponse<CryptoOrderPreview, unknown>>;
|
|
10949
10948
|
/**
|
|
10950
10949
|
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
10951
10950
|
* @summary Replace order
|
|
@@ -10953,7 +10952,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10953
10952
|
* @param {*} [options] Override http request option.
|
|
10954
10953
|
* @throws {RequiredError}
|
|
10955
10954
|
*/
|
|
10956
|
-
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>):
|
|
10955
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
10957
10956
|
/**
|
|
10958
10957
|
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
10959
10958
|
* @summary Get crypto pairs
|
|
@@ -10961,7 +10960,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10961
10960
|
* @param {*} [options] Override http request option.
|
|
10962
10961
|
* @throws {RequiredError}
|
|
10963
10962
|
*/
|
|
10964
|
-
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>):
|
|
10963
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, unknown>>;
|
|
10965
10964
|
};
|
|
10966
10965
|
/**
|
|
10967
10966
|
* Request parameters for cancelOrder operation in TradingApi.
|
|
@@ -11378,7 +11377,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11378
11377
|
* @throws {RequiredError}
|
|
11379
11378
|
* @memberof TradingApiGenerated
|
|
11380
11379
|
*/
|
|
11381
|
-
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<
|
|
11380
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<AxiosResponse<CancelOrderResponse, unknown, {}, any>>;
|
|
11382
11381
|
/**
|
|
11383
11382
|
* Gets a quote for the specified account.
|
|
11384
11383
|
* @summary Get crypto pair quote
|
|
@@ -11387,7 +11386,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11387
11386
|
* @throws {RequiredError}
|
|
11388
11387
|
* @memberof TradingApiGenerated
|
|
11389
11388
|
*/
|
|
11390
|
-
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<
|
|
11389
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<AxiosResponse<CryptocurrencyPairQuote, unknown, {}, any>>;
|
|
11391
11390
|
/**
|
|
11392
11391
|
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
11393
11392
|
* @summary Get option order impact
|
|
@@ -11396,7 +11395,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11396
11395
|
* @throws {RequiredError}
|
|
11397
11396
|
* @memberof TradingApiGenerated
|
|
11398
11397
|
*/
|
|
11399
|
-
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<
|
|
11398
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<AxiosResponse<OptionImpact, unknown, {}, any>>;
|
|
11400
11399
|
/**
|
|
11401
11400
|
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
11402
11401
|
* @summary Check equity order impact
|
|
@@ -11405,7 +11404,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11405
11404
|
* @throws {RequiredError}
|
|
11406
11405
|
* @memberof TradingApiGenerated
|
|
11407
11406
|
*/
|
|
11408
|
-
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<
|
|
11407
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<AxiosResponse<ManualTradeAndImpact, unknown, {}, any>>;
|
|
11409
11408
|
/**
|
|
11410
11409
|
* **Deprecated.** This endpoint was sunset on October 1, 2026 and now always returns `410 Gone`. Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
11411
11410
|
* @summary Get option quote
|
|
@@ -11415,7 +11414,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11415
11414
|
* @throws {RequiredError}
|
|
11416
11415
|
* @memberof TradingApiGenerated
|
|
11417
11416
|
*/
|
|
11418
|
-
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<
|
|
11417
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<AxiosResponse<OptionQuote, unknown, {}, any>>;
|
|
11419
11418
|
/**
|
|
11420
11419
|
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes.
|
|
11421
11420
|
* @summary Get equity symbol quotes
|
|
@@ -11424,7 +11423,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11424
11423
|
* @throws {RequiredError}
|
|
11425
11424
|
* @memberof TradingApiGenerated
|
|
11426
11425
|
*/
|
|
11427
|
-
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<
|
|
11426
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<AxiosResponse<SymbolsQuotesInner[], unknown, {}, any>>;
|
|
11428
11427
|
/**
|
|
11429
11428
|
* 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. Option OCO peers must trade the same OCC option symbol with the same closing action and positive whole-contract quantity. On tastytrade, option OCO supports closing an existing long or short option position with one `Limit` order and one `Stop` or `StopLimit` order. Both `PEER` orders must use `SELL_TO_CLOSE` or both must use `BUY_TO_CLOSE`, with `Day` or `GTC` time in force. Opening option OCOs are not supported. On enabled Webull US v3 accounts, option OCO supports closing an existing long option position with one `Limit` take-profit order and one `Stop` stop-loss order. Both `PEER` orders must use `SELL_TO_CLOSE`, `Day`, the same OCC option symbol, and the same positive whole-contract quantity. Webull receives these as `STOP_PROFIT` and `STOP_LOSS` orders sharing a combo ID, without a MASTER order. Opening option OCOs, `BUY_TO_CLOSE`, `StopLimit`, and other option order pairs are not supported on Webull. Equity complex-order behavior is unchanged.
|
|
11430
11429
|
* @summary Place complex order
|
|
@@ -11433,7 +11432,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11433
11432
|
* @throws {RequiredError}
|
|
11434
11433
|
* @memberof TradingApiGenerated
|
|
11435
11434
|
*/
|
|
11436
|
-
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<
|
|
11435
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<AxiosResponse<ComplexOrderResponse, unknown, {}, any>>;
|
|
11437
11436
|
/**
|
|
11438
11437
|
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
11439
11438
|
* @summary Place crypto order
|
|
@@ -11442,7 +11441,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11442
11441
|
* @throws {RequiredError}
|
|
11443
11442
|
* @memberof TradingApiGenerated
|
|
11444
11443
|
*/
|
|
11445
|
-
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<
|
|
11444
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<AxiosResponse<OrderUpdatedResponse, unknown, {}, any>>;
|
|
11446
11445
|
/**
|
|
11447
11446
|
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
11448
11447
|
* @summary Place equity order
|
|
@@ -11451,7 +11450,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11451
11450
|
* @throws {RequiredError}
|
|
11452
11451
|
* @memberof TradingApiGenerated
|
|
11453
11452
|
*/
|
|
11454
|
-
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<
|
|
11453
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
11455
11454
|
/**
|
|
11456
11455
|
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
11457
11456
|
* @summary Place option order
|
|
@@ -11460,7 +11459,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11460
11459
|
* @throws {RequiredError}
|
|
11461
11460
|
* @memberof TradingApiGenerated
|
|
11462
11461
|
*/
|
|
11463
|
-
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<
|
|
11462
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<AxiosResponse<MlegOrderResponse, unknown, {}, any>>;
|
|
11464
11463
|
/**
|
|
11465
11464
|
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
11466
11465
|
* @summary Place checked equity order
|
|
@@ -11469,7 +11468,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11469
11468
|
* @throws {RequiredError}
|
|
11470
11469
|
* @memberof TradingApiGenerated
|
|
11471
11470
|
*/
|
|
11472
|
-
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<
|
|
11471
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
11473
11472
|
/**
|
|
11474
11473
|
* Previews an order using the specified account.
|
|
11475
11474
|
* @summary Preview crypto order
|
|
@@ -11478,7 +11477,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11478
11477
|
* @throws {RequiredError}
|
|
11479
11478
|
* @memberof TradingApiGenerated
|
|
11480
11479
|
*/
|
|
11481
|
-
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<
|
|
11480
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<AxiosResponse<CryptoOrderPreview, unknown, {}, any>>;
|
|
11482
11481
|
/**
|
|
11483
11482
|
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
11484
11483
|
* @summary Replace order
|
|
@@ -11487,7 +11486,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11487
11486
|
* @throws {RequiredError}
|
|
11488
11487
|
* @memberof TradingApiGenerated
|
|
11489
11488
|
*/
|
|
11490
|
-
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<
|
|
11489
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
11491
11490
|
/**
|
|
11492
11491
|
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
11493
11492
|
* @summary Get crypto pairs
|
|
@@ -11496,7 +11495,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11496
11495
|
* @throws {RequiredError}
|
|
11497
11496
|
* @memberof TradingApiGenerated
|
|
11498
11497
|
*/
|
|
11499
|
-
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<
|
|
11498
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, unknown, {}, any>>;
|
|
11500
11499
|
}
|
|
11501
11500
|
//#endregion
|
|
11502
11501
|
//#region api/trading-api.d.ts
|
|
@@ -11566,4 +11565,4 @@ declare class SnaptradeError extends Error {
|
|
|
11566
11565
|
declare function readableStreamToString(stream: ReadableStream): Promise<string>;
|
|
11567
11566
|
declare function parseIfJson(input: unknown): object | unknown;
|
|
11568
11567
|
//#endregion
|
|
11569
|
-
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesArgs, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryArgs, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, AccountInformationApiGetAccountDetailsArgs, AccountInformationApiGetAccountDetailsBaseRequest, AccountInformationApiGetAccountDetailsRequest, AccountInformationApiGetAccountDetailsRequestByAuthMode, AccountInformationApiGetAccountDetailscommercialApiKeyRequest, AccountInformationApiGetAccountDetailspersonalApiKeyRequest, AccountInformationApiGetAllAccountPositionsArgs, AccountInformationApiGetAllAccountPositionsBaseRequest, AccountInformationApiGetAllAccountPositionsRequest, AccountInformationApiGetAllAccountPositionsRequestByAuthMode, AccountInformationApiGetAllAccountPositionscommercialApiKeyRequest, AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest, AccountInformationApiGetUserAccountBalanceArgs, AccountInformationApiGetUserAccountBalanceBaseRequest, AccountInformationApiGetUserAccountBalanceRequest, AccountInformationApiGetUserAccountBalanceRequestByAuthMode, AccountInformationApiGetUserAccountBalancecommercialApiKeyRequest, AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest, AccountInformationApiGetUserAccountDetailsArgs, AccountInformationApiGetUserAccountDetailsBaseRequest, AccountInformationApiGetUserAccountDetailsRequest, AccountInformationApiGetUserAccountDetailsRequestByAuthMode, AccountInformationApiGetUserAccountDetailscommercialApiKeyRequest, AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailArgs, AccountInformationApiGetUserAccountOrderDetailBaseRequest, AccountInformationApiGetUserAccountOrderDetailRequest, AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode, AccountInformationApiGetUserAccountOrderDetailcommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest, AccountInformationApiGetUserAccountOrdersArgs, AccountInformationApiGetUserAccountOrdersBaseRequest, AccountInformationApiGetUserAccountOrdersRequest, AccountInformationApiGetUserAccountOrdersRequestByAuthMode, AccountInformationApiGetUserAccountOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountRecentOrdersArgs, AccountInformationApiGetUserAccountRecentOrdersBaseRequest, AccountInformationApiGetUserAccountRecentOrdersRequest, AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode, AccountInformationApiGetUserAccountRecentOrderscommercialApiKeyRequest, AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest, AccountInformationApiGetUserAccountReturnRatesArgs, AccountInformationApiGetUserAccountReturnRatesBaseRequest, AccountInformationApiGetUserAccountReturnRatesRequest, AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode, AccountInformationApiGetUserAccountReturnRatescommercialApiKeyRequest, AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest, AccountInformationApiGetUserHoldingsArgs, AccountInformationApiGetUserHoldingsBaseRequest, AccountInformationApiGetUserHoldingsRequest, AccountInformationApiGetUserHoldingsRequestByAuthMode, AccountInformationApiGetUserHoldingscommercialApiKeyRequest, AccountInformationApiGetUserHoldingspersonalApiKeyRequest, AccountInformationApiListAllUserAccountsArgs, AccountInformationApiListAllUserAccountsBaseRequest, AccountInformationApiListAllUserAccountsRequest, AccountInformationApiListAllUserAccountsRequestByAuthMode, AccountInformationApiListAllUserAccountscommercialApiKeyRequest, AccountInformationApiListAllUserAccountspersonalApiKeyRequest, AccountInformationApiListUserAccountsArgs, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountArgs, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountInformationGetUserHoldings409Response, AccountOrderRecord, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordNullable, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordStatusV2Nullable, AccountOrderRecordV2, AccountOrderRecordV2OrderRole, AccountOrderRecordV2OrderRoleNullable, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, AllUserAccountsResponse, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiDeleteSnapTradeUserArgs, AuthenticationApiDeleteSnapTradeUserBaseRequest, AuthenticationApiDeleteSnapTradeUserRequest, AuthenticationApiDeleteSnapTradeUserRequestByAuthMode, AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, AuthenticationApiLoginSnapTradeUserArgs, AuthenticationApiLoginSnapTradeUserBaseRequest, AuthenticationApiLoginSnapTradeUserRequest, AuthenticationApiLoginSnapTradeUserRequestByAuthMode, AuthenticationApiLoginSnapTradeUsercommercialApiKeyRequest, AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest, AuthenticationApiRegisterSnapTradeUserArgs, AuthenticationApiRegisterSnapTradeUserBaseRequest, AuthenticationApiRegisterSnapTradeUserRequest, AuthenticationApiRegisterSnapTradeUserRequestByAuthMode, AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest, AuthenticationApiResetSnapTradeUserSecretArgs, AuthenticationApiResetSnapTradeUserSecretBaseRequest, AuthenticationApiResetSnapTradeUserSecretRequest, AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode, AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDataFreshnessMode, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, CfdInstrument, ChildBrokerageOrderIDs, ChildBrokerageOrderIDsNullable, CommercialApiKeyAuth, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConfigurationParametersShared, ConnectionAccount, ConnectionAccountSyncStatus, ConnectionAccountsResponse, ConnectionsApi, ConnectionsApiAxiosParamCreator, ConnectionsApiDeleteConnectionArgs, ConnectionsApiDeleteConnectionBaseRequest, ConnectionsApiDeleteConnectionRequest, ConnectionsApiDeleteConnectionRequestByAuthMode, ConnectionsApiDeleteConnectioncommercialApiKeyRequest, ConnectionsApiDeleteConnectionpersonalApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationArgs, ConnectionsApiDetailBrokerageAuthorizationBaseRequest, ConnectionsApiDetailBrokerageAuthorizationRequest, ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDetailBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationArgs, ConnectionsApiDisableBrokerageAuthorizationBaseRequest, ConnectionsApiDisableBrokerageAuthorizationRequest, ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode, ConnectionsApiDisableBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, ConnectionsApiListBrokerageAuthorizationAccountsArgs, ConnectionsApiListBrokerageAuthorizationAccountsBaseRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequest, ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationAccountscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest, ConnectionsApiListBrokerageAuthorizationsArgs, ConnectionsApiListBrokerageAuthorizationsBaseRequest, ConnectionsApiListBrokerageAuthorizationsRequest, ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode, ConnectionsApiListBrokerageAuthorizationscommercialApiKeyRequest, ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest, ConnectionsApiListConnectionAccountsArgs, ConnectionsApiListConnectionAccountsBaseRequest, ConnectionsApiListConnectionAccountsRequest, ConnectionsApiListConnectionAccountsRequestByAuthMode, ConnectionsApiListConnectionAccountscommercialApiKeyRequest, ConnectionsApiListConnectionAccountspersonalApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationArgs, ConnectionsApiRefreshBrokerageAuthorizationBaseRequest, ConnectionsApiRefreshBrokerageAuthorizationRequest, ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode, ConnectionsApiRefreshBrokerageAuthorizationcommercialApiKeyRequest, ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiReturnRatesArgs, ConnectionsApiReturnRatesBaseRequest, ConnectionsApiReturnRatesRequest, ConnectionsApiReturnRatesRequestByAuthMode, ConnectionsApiReturnRatescommercialApiKeyRequest, ConnectionsApiReturnRatespersonalApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs, ConnectionsApiSyncBrokerageAuthorizationTransactionsBaseRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode, ConnectionsApiSyncBrokerageAuthorizationTransactionscommercialApiKeyRequest, ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, CurrencyNullable, DeleteConnectionConfirmation, DeleteUserResponse, DepositAccount, DepositAccountNetValue, DepositAccountSyncStatus, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, ExperimentalEndpointsApiAddSubscriptionArgs, ExperimentalEndpointsApiAddSubscriptionBaseRequest, ExperimentalEndpointsApiAddSubscriptionRequest, ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode, ExperimentalEndpointsApiAddSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiAxiosParamCreator, ExperimentalEndpointsApiCancelSubscriptionArgs, ExperimentalEndpointsApiCancelSubscriptionBaseRequest, ExperimentalEndpointsApiCancelSubscriptionRequest, ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode, ExperimentalEndpointsApiCancelSubscriptioncommercialApiKeyRequest, ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args, ExperimentalEndpointsApiGetUserAccountOrderDetailV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrderDetailV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Args, ExperimentalEndpointsApiGetUserAccountOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2Request, ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2BaseRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2commercialApiKeyRequest, ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest, ExperimentalEndpointsApiPlaceSimpleOrderArgs, ExperimentalEndpointsApiPlaceSimpleOrderBaseRequest, ExperimentalEndpointsApiPlaceSimpleOrderRequest, ExperimentalEndpointsApiPlaceSimpleOrderRequestByAuthMode, ExperimentalEndpointsApiPlaceSimpleOrdercommercialApiKeyRequest, ExperimentalEndpointsApiPlaceSimpleOrderpersonalApiKeyRequest, FigiInstrument, FigiInstrumentNullable, FutureInstrument, FutureOptionInstrument, HoldingsStatus, Institution, InstitutionConnection, InstitutionConnectionNullable, Instrument, InvestmentAccount, InvestmentAccountNetValue, LineOfCreditAccount, LineOfCreditAccountAvailableCredit, LineOfCreditAccountMinimumPaymentAmount, LineOfCreditAccountNetValue, LineOfCreditAccountSyncStatus, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegPriceEffectStrictNullable, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, NotionalValueNullable, OAuthWebhookBase, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsPosition, OptionsSymbol, OptionsSymbolNullable, OrderTypeStrict, OrderUpdatedResponse, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, ReferenceDataApiGetSymbolsArgs, ReferenceDataApiGetSymbolsBaseRequest, ReferenceDataApiGetSymbolsByTickerArgs, ReferenceDataApiGetSymbolsByTickerBaseRequest, ReferenceDataApiGetSymbolsByTickerRequest, ReferenceDataApiGetSymbolsByTickerRequestByAuthMode, ReferenceDataApiGetSymbolsByTickercommercialApiKeyRequest, ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest, ReferenceDataApiGetSymbolsRequest, ReferenceDataApiGetSymbolsRequestByAuthMode, ReferenceDataApiGetSymbolscommercialApiKeyRequest, ReferenceDataApiGetSymbolspersonalApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeArgs, ReferenceDataApiListAllBrokerageAuthorizationTypeBaseRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode, ReferenceDataApiListAllBrokerageAuthorizationTypecommercialApiKeyRequest, ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentsArgs, ReferenceDataApiListAllBrokerageInstrumentsBaseRequest, ReferenceDataApiListAllBrokerageInstrumentsRequest, ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode, ReferenceDataApiListAllBrokerageInstrumentscommercialApiKeyRequest, ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountArgs, ReferenceDataApiSymbolSearchUserAccountBaseRequest, ReferenceDataApiSymbolSearchUserAccountRequest, ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode, ReferenceDataApiSymbolSearchUserAccountcommercialApiKeyRequest, ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest, SecurityType, SessionEvent, SimpleOrderForm, SimpleTradeForm, SimpleTradeInstrument, SimpleTradeLeg, SimpleTradeResponse, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, SymbolNullable, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TokenizedAssetInstrument, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, TradingApiCancelOrderArgs, TradingApiCancelOrderBaseRequest, TradingApiCancelOrderRequest, TradingApiCancelOrderRequestByAuthMode, TradingApiCancelOrdercommercialApiKeyRequest, TradingApiCancelOrderpersonalApiKeyRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, TradingApiGetCryptocurrencyPairQuoteArgs, TradingApiGetCryptocurrencyPairQuoteBaseRequest, TradingApiGetCryptocurrencyPairQuoteRequest, TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode, TradingApiGetCryptocurrencyPairQuotecommercialApiKeyRequest, TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest, TradingApiGetOptionImpactArgs, TradingApiGetOptionImpactBaseRequest, TradingApiGetOptionImpactRequest, TradingApiGetOptionImpactRequestByAuthMode, TradingApiGetOptionImpactcommercialApiKeyRequest, TradingApiGetOptionImpactpersonalApiKeyRequest, TradingApiGetOrderImpactArgs, TradingApiGetOrderImpactBaseRequest, TradingApiGetOrderImpactRequest, TradingApiGetOrderImpactRequestByAuthMode, TradingApiGetOrderImpactcommercialApiKeyRequest, TradingApiGetOrderImpactpersonalApiKeyRequest, TradingApiGetUserAccountOptionQuotesArgs, TradingApiGetUserAccountOptionQuotesBaseRequest, TradingApiGetUserAccountOptionQuotesRequest, TradingApiGetUserAccountOptionQuotesRequestByAuthMode, TradingApiGetUserAccountOptionQuotescommercialApiKeyRequest, TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest, TradingApiGetUserAccountQuotesArgs, TradingApiGetUserAccountQuotesBaseRequest, TradingApiGetUserAccountQuotesRequest, TradingApiGetUserAccountQuotesRequestByAuthMode, TradingApiGetUserAccountQuotescommercialApiKeyRequest, TradingApiGetUserAccountQuotespersonalApiKeyRequest, TradingApiPlaceComplexOrderArgs, TradingApiPlaceComplexOrderBaseRequest, TradingApiPlaceComplexOrderRequest, TradingApiPlaceComplexOrderRequestByAuthMode, TradingApiPlaceComplexOrdercommercialApiKeyRequest, TradingApiPlaceComplexOrderpersonalApiKeyRequest, TradingApiPlaceCryptoOrderArgs, TradingApiPlaceCryptoOrderBaseRequest, TradingApiPlaceCryptoOrderRequest, TradingApiPlaceCryptoOrderRequestByAuthMode, TradingApiPlaceCryptoOrdercommercialApiKeyRequest, TradingApiPlaceCryptoOrderpersonalApiKeyRequest, TradingApiPlaceForceOrderArgs, TradingApiPlaceForceOrderBaseRequest, TradingApiPlaceForceOrderRequest, TradingApiPlaceForceOrderRequestByAuthMode, TradingApiPlaceForceOrdercommercialApiKeyRequest, TradingApiPlaceForceOrderpersonalApiKeyRequest, TradingApiPlaceMlegOrderArgs, TradingApiPlaceMlegOrderBaseRequest, TradingApiPlaceMlegOrderRequest, TradingApiPlaceMlegOrderRequestByAuthMode, TradingApiPlaceMlegOrdercommercialApiKeyRequest, TradingApiPlaceMlegOrderpersonalApiKeyRequest, TradingApiPlaceOrderArgs, TradingApiPlaceOrderBaseRequest, TradingApiPlaceOrderRequest, TradingApiPlaceOrderRequestByAuthMode, TradingApiPlaceOrdercommercialApiKeyRequest, TradingApiPlaceOrderpersonalApiKeyRequest, TradingApiPreviewCryptoOrderArgs, TradingApiPreviewCryptoOrderBaseRequest, TradingApiPreviewCryptoOrderRequest, TradingApiPreviewCryptoOrderRequestByAuthMode, TradingApiPreviewCryptoOrdercommercialApiKeyRequest, TradingApiPreviewCryptoOrderpersonalApiKeyRequest, TradingApiReplaceOrderArgs, TradingApiReplaceOrderBaseRequest, TradingApiReplaceOrderRequest, TradingApiReplaceOrderRequestByAuthMode, TradingApiReplaceOrdercommercialApiKeyRequest, TradingApiReplaceOrderpersonalApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentsArgs, TradingApiSearchCryptocurrencyPairInstrumentsBaseRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequest, TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode, TradingApiSearchCryptocurrencyPairInstrumentscommercialApiKeyRequest, TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest, TradingGetUserAccountOptionQuotes410Response, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TrailingStopNullable, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UnderlyingTokenizedAssetInstrument, UniversalActivity, UniversalSymbol, UniversalSymbolNullable, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|
|
11568
|
+
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, type AccountInformationApiGetAccountActivitiesArgs, type AccountInformationApiGetAccountActivitiesBaseRequest, type AccountInformationApiGetAccountActivitiesRequest, type AccountInformationApiGetAccountActivitiesRequestByAuthMode, type AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, type AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, type AccountInformationApiGetAccountBalanceHistoryArgs, type AccountInformationApiGetAccountBalanceHistoryBaseRequest, type AccountInformationApiGetAccountBalanceHistoryRequest, type AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, type AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, type AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, type AccountInformationApiGetAccountDetailsArgs, type AccountInformationApiGetAccountDetailsBaseRequest, type AccountInformationApiGetAccountDetailsRequest, type AccountInformationApiGetAccountDetailsRequestByAuthMode, type AccountInformationApiGetAccountDetailscommercialApiKeyRequest, type AccountInformationApiGetAccountDetailspersonalApiKeyRequest, type AccountInformationApiGetAllAccountPositionsArgs, type AccountInformationApiGetAllAccountPositionsBaseRequest, type AccountInformationApiGetAllAccountPositionsRequest, type AccountInformationApiGetAllAccountPositionsRequestByAuthMode, type AccountInformationApiGetAllAccountPositionscommercialApiKeyRequest, type AccountInformationApiGetAllAccountPositionspersonalApiKeyRequest, type AccountInformationApiGetUserAccountBalanceArgs, type AccountInformationApiGetUserAccountBalanceBaseRequest, type AccountInformationApiGetUserAccountBalanceRequest, type AccountInformationApiGetUserAccountBalanceRequestByAuthMode, type AccountInformationApiGetUserAccountBalancecommercialApiKeyRequest, type AccountInformationApiGetUserAccountBalancepersonalApiKeyRequest, type AccountInformationApiGetUserAccountDetailsArgs, type AccountInformationApiGetUserAccountDetailsBaseRequest, type AccountInformationApiGetUserAccountDetailsRequest, type AccountInformationApiGetUserAccountDetailsRequestByAuthMode, type AccountInformationApiGetUserAccountDetailscommercialApiKeyRequest, type AccountInformationApiGetUserAccountDetailspersonalApiKeyRequest, type AccountInformationApiGetUserAccountOrderDetailArgs, type AccountInformationApiGetUserAccountOrderDetailBaseRequest, type AccountInformationApiGetUserAccountOrderDetailRequest, type AccountInformationApiGetUserAccountOrderDetailRequestByAuthMode, type AccountInformationApiGetUserAccountOrderDetailcommercialApiKeyRequest, type AccountInformationApiGetUserAccountOrderDetailpersonalApiKeyRequest, type AccountInformationApiGetUserAccountOrdersArgs, type AccountInformationApiGetUserAccountOrdersBaseRequest, type AccountInformationApiGetUserAccountOrdersRequest, type AccountInformationApiGetUserAccountOrdersRequestByAuthMode, type AccountInformationApiGetUserAccountOrderscommercialApiKeyRequest, type AccountInformationApiGetUserAccountOrderspersonalApiKeyRequest, type AccountInformationApiGetUserAccountRecentOrdersArgs, type AccountInformationApiGetUserAccountRecentOrdersBaseRequest, type AccountInformationApiGetUserAccountRecentOrdersRequest, type AccountInformationApiGetUserAccountRecentOrdersRequestByAuthMode, type AccountInformationApiGetUserAccountRecentOrderscommercialApiKeyRequest, type AccountInformationApiGetUserAccountRecentOrderspersonalApiKeyRequest, type AccountInformationApiGetUserAccountReturnRatesArgs, type AccountInformationApiGetUserAccountReturnRatesBaseRequest, type AccountInformationApiGetUserAccountReturnRatesRequest, type AccountInformationApiGetUserAccountReturnRatesRequestByAuthMode, type AccountInformationApiGetUserAccountReturnRatescommercialApiKeyRequest, type AccountInformationApiGetUserAccountReturnRatespersonalApiKeyRequest, type AccountInformationApiGetUserHoldingsArgs, type AccountInformationApiGetUserHoldingsBaseRequest, type AccountInformationApiGetUserHoldingsRequest, type AccountInformationApiGetUserHoldingsRequestByAuthMode, type AccountInformationApiGetUserHoldingscommercialApiKeyRequest, type AccountInformationApiGetUserHoldingspersonalApiKeyRequest, type AccountInformationApiListAllUserAccountsArgs, type AccountInformationApiListAllUserAccountsBaseRequest, type AccountInformationApiListAllUserAccountsRequest, type AccountInformationApiListAllUserAccountsRequestByAuthMode, type AccountInformationApiListAllUserAccountscommercialApiKeyRequest, type AccountInformationApiListAllUserAccountspersonalApiKeyRequest, type AccountInformationApiListUserAccountsArgs, type AccountInformationApiListUserAccountsBaseRequest, type AccountInformationApiListUserAccountsRequest, type AccountInformationApiListUserAccountsRequestByAuthMode, type AccountInformationApiListUserAccountscommercialApiKeyRequest, type AccountInformationApiListUserAccountspersonalApiKeyRequest, type AccountInformationApiUpdateUserAccountArgs, type AccountInformationApiUpdateUserAccountBaseRequest, type AccountInformationApiUpdateUserAccountRequest, type AccountInformationApiUpdateUserAccountRequestByAuthMode, type AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, type AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountInformationGetUserHoldings409Response, AccountOrderRecord, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordNullable, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordStatusV2Nullable, AccountOrderRecordV2, AccountOrderRecordV2OrderRole, AccountOrderRecordV2OrderRoleNullable, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, AllUserAccountsResponse, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, type AuthenticationApiDeleteSnapTradeUserArgs, type AuthenticationApiDeleteSnapTradeUserBaseRequest, type AuthenticationApiDeleteSnapTradeUserRequest, type AuthenticationApiDeleteSnapTradeUserRequestByAuthMode, type AuthenticationApiDeleteSnapTradeUsercommercialApiKeyRequest, AuthenticationApiFactory, AuthenticationApiFp, AuthenticationApiGenerated, type AuthenticationApiLoginSnapTradeUserArgs, type AuthenticationApiLoginSnapTradeUserBaseRequest, type AuthenticationApiLoginSnapTradeUserRequest, type AuthenticationApiLoginSnapTradeUserRequestByAuthMode, type AuthenticationApiLoginSnapTradeUsercommercialApiKeyRequest, type AuthenticationApiLoginSnapTradeUserpersonalApiKeyRequest, type AuthenticationApiRegisterSnapTradeUserArgs, type AuthenticationApiRegisterSnapTradeUserBaseRequest, type AuthenticationApiRegisterSnapTradeUserRequest, type AuthenticationApiRegisterSnapTradeUserRequestByAuthMode, type AuthenticationApiRegisterSnapTradeUsercommercialApiKeyRequest, type AuthenticationApiResetSnapTradeUserSecretArgs, type AuthenticationApiResetSnapTradeUserSecretBaseRequest, type AuthenticationApiResetSnapTradeUserSecretRequest, type AuthenticationApiResetSnapTradeUserSecretRequestByAuthMode, type AuthenticationApiResetSnapTradeUserSecretcommercialApiKeyRequest, AuthenticationLoginSnapTradeUser200Response, Balance, BalanceCurrency, Brokerage, BrokerageAuthorization, BrokerageAuthorizationDataFreshnessMode, BrokerageAuthorizationDisabledConfirmation, BrokerageAuthorizationRefreshConfirmation, BrokerageAuthorizationTransactionsSyncConfirmation, BrokerageAuthorizationTypeReadOnly, BrokerageAuthorizationTypeReadOnlyBrokerage, BrokerageInstrument, BrokerageInstrumentsResponse, BrokerageType, CancelOrderResponse, CefInstrument, CfdInstrument, ChildBrokerageOrderIDs, ChildBrokerageOrderIDsNullable, CommercialApiKeyAuth, ComplexOrderLeg, ComplexOrderResponse, Configuration, ConfigurationParameters, ConfigurationParametersShared, ConnectionAccount, ConnectionAccountSyncStatus, ConnectionAccountsResponse, ConnectionsApi, ConnectionsApiAxiosParamCreator, type ConnectionsApiDeleteConnectionArgs, type ConnectionsApiDeleteConnectionBaseRequest, type ConnectionsApiDeleteConnectionRequest, type ConnectionsApiDeleteConnectionRequestByAuthMode, type ConnectionsApiDeleteConnectioncommercialApiKeyRequest, type ConnectionsApiDeleteConnectionpersonalApiKeyRequest, type ConnectionsApiDetailBrokerageAuthorizationArgs, type ConnectionsApiDetailBrokerageAuthorizationBaseRequest, type ConnectionsApiDetailBrokerageAuthorizationRequest, type ConnectionsApiDetailBrokerageAuthorizationRequestByAuthMode, type ConnectionsApiDetailBrokerageAuthorizationcommercialApiKeyRequest, type ConnectionsApiDetailBrokerageAuthorizationpersonalApiKeyRequest, type ConnectionsApiDisableBrokerageAuthorizationArgs, type ConnectionsApiDisableBrokerageAuthorizationBaseRequest, type ConnectionsApiDisableBrokerageAuthorizationRequest, type ConnectionsApiDisableBrokerageAuthorizationRequestByAuthMode, type ConnectionsApiDisableBrokerageAuthorizationcommercialApiKeyRequest, type ConnectionsApiDisableBrokerageAuthorizationpersonalApiKeyRequest, ConnectionsApiFactory, ConnectionsApiFp, ConnectionsApiGenerated, type ConnectionsApiListBrokerageAuthorizationAccountsArgs, type ConnectionsApiListBrokerageAuthorizationAccountsBaseRequest, type ConnectionsApiListBrokerageAuthorizationAccountsRequest, type ConnectionsApiListBrokerageAuthorizationAccountsRequestByAuthMode, type ConnectionsApiListBrokerageAuthorizationAccountscommercialApiKeyRequest, type ConnectionsApiListBrokerageAuthorizationAccountspersonalApiKeyRequest, type ConnectionsApiListBrokerageAuthorizationsArgs, type ConnectionsApiListBrokerageAuthorizationsBaseRequest, type ConnectionsApiListBrokerageAuthorizationsRequest, type ConnectionsApiListBrokerageAuthorizationsRequestByAuthMode, type ConnectionsApiListBrokerageAuthorizationscommercialApiKeyRequest, type ConnectionsApiListBrokerageAuthorizationspersonalApiKeyRequest, type ConnectionsApiListConnectionAccountsArgs, type ConnectionsApiListConnectionAccountsBaseRequest, type ConnectionsApiListConnectionAccountsRequest, type ConnectionsApiListConnectionAccountsRequestByAuthMode, type ConnectionsApiListConnectionAccountscommercialApiKeyRequest, type ConnectionsApiListConnectionAccountspersonalApiKeyRequest, type ConnectionsApiRefreshBrokerageAuthorizationArgs, type ConnectionsApiRefreshBrokerageAuthorizationBaseRequest, type ConnectionsApiRefreshBrokerageAuthorizationRequest, type ConnectionsApiRefreshBrokerageAuthorizationRequestByAuthMode, type ConnectionsApiRefreshBrokerageAuthorizationcommercialApiKeyRequest, type ConnectionsApiRefreshBrokerageAuthorizationpersonalApiKeyRequest, type ConnectionsApiReturnRatesArgs, type ConnectionsApiReturnRatesBaseRequest, type ConnectionsApiReturnRatesRequest, type ConnectionsApiReturnRatesRequestByAuthMode, type ConnectionsApiReturnRatescommercialApiKeyRequest, type ConnectionsApiReturnRatespersonalApiKeyRequest, type ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs, type ConnectionsApiSyncBrokerageAuthorizationTransactionsBaseRequest, type ConnectionsApiSyncBrokerageAuthorizationTransactionsRequest, type ConnectionsApiSyncBrokerageAuthorizationTransactionsRequestByAuthMode, type ConnectionsApiSyncBrokerageAuthorizationTransactionscommercialApiKeyRequest, type ConnectionsApiSyncBrokerageAuthorizationTransactionspersonalApiKeyRequest, CryptoInstrument, CryptoOrderForm, CryptoOrderPreview, CryptoOrderPreviewEstimatedFee, CryptoTradingInstrument, CryptocurrencyPair, CryptocurrencyPairQuote, Currency, CurrencyNullable, DeleteConnectionConfirmation, DeleteUserResponse, DepositAccount, DepositAccountNetValue, DepositAccountSyncStatus, DividendAtDate, EncryptedResponse, EncryptedResponseEncryptedMessageData, EtfInstrument, Exchange, ExchangeRatePairs, ExperimentalEndpointsApi, type ExperimentalEndpointsApiAddSubscriptionArgs, type ExperimentalEndpointsApiAddSubscriptionBaseRequest, type ExperimentalEndpointsApiAddSubscriptionRequest, type ExperimentalEndpointsApiAddSubscriptionRequestByAuthMode, type ExperimentalEndpointsApiAddSubscriptioncommercialApiKeyRequest, type ExperimentalEndpointsApiAddSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiAxiosParamCreator, type ExperimentalEndpointsApiCancelSubscriptionArgs, type ExperimentalEndpointsApiCancelSubscriptionBaseRequest, type ExperimentalEndpointsApiCancelSubscriptionRequest, type ExperimentalEndpointsApiCancelSubscriptionRequestByAuthMode, type ExperimentalEndpointsApiCancelSubscriptioncommercialApiKeyRequest, type ExperimentalEndpointsApiCancelSubscriptionpersonalApiKeyRequest, ExperimentalEndpointsApiFactory, ExperimentalEndpointsApiFp, ExperimentalEndpointsApiGenerated, type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args, type ExperimentalEndpointsApiGetUserAccountOrderDetailV2BaseRequest, type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, type ExperimentalEndpointsApiGetUserAccountOrderDetailV2RequestByAuthMode, type ExperimentalEndpointsApiGetUserAccountOrderDetailV2commercialApiKeyRequest, type ExperimentalEndpointsApiGetUserAccountOrderDetailV2personalApiKeyRequest, type ExperimentalEndpointsApiGetUserAccountOrdersV2Args, type ExperimentalEndpointsApiGetUserAccountOrdersV2BaseRequest, type ExperimentalEndpointsApiGetUserAccountOrdersV2Request, type ExperimentalEndpointsApiGetUserAccountOrdersV2RequestByAuthMode, type ExperimentalEndpointsApiGetUserAccountOrdersV2commercialApiKeyRequest, type ExperimentalEndpointsApiGetUserAccountOrdersV2personalApiKeyRequest, type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args, type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2BaseRequest, type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2RequestByAuthMode, type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2commercialApiKeyRequest, type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2personalApiKeyRequest, type ExperimentalEndpointsApiPlaceSimpleOrderArgs, type ExperimentalEndpointsApiPlaceSimpleOrderBaseRequest, type ExperimentalEndpointsApiPlaceSimpleOrderRequest, type ExperimentalEndpointsApiPlaceSimpleOrderRequestByAuthMode, type ExperimentalEndpointsApiPlaceSimpleOrdercommercialApiKeyRequest, type ExperimentalEndpointsApiPlaceSimpleOrderpersonalApiKeyRequest, FigiInstrument, FigiInstrumentNullable, FutureInstrument, FutureOptionInstrument, HoldingsStatus, Institution, InstitutionConnection, InstitutionConnectionNullable, Instrument, InvestmentAccount, InvestmentAccountNetValue, LineOfCreditAccount, LineOfCreditAccountAvailableCredit, LineOfCreditAccountMinimumPaymentAmount, LineOfCreditAccountNetValue, LineOfCreditAccountSyncStatus, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegPriceEffectStrictNullable, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, NotionalValueNullable, OAuthWebhookBase, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsPosition, OptionsSymbol, OptionsSymbolNullable, OrderTypeStrict, OrderUpdatedResponse, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, type ReferenceDataApiGetSymbolsArgs, type ReferenceDataApiGetSymbolsBaseRequest, type ReferenceDataApiGetSymbolsByTickerArgs, type ReferenceDataApiGetSymbolsByTickerBaseRequest, type ReferenceDataApiGetSymbolsByTickerRequest, type ReferenceDataApiGetSymbolsByTickerRequestByAuthMode, type ReferenceDataApiGetSymbolsByTickercommercialApiKeyRequest, type ReferenceDataApiGetSymbolsByTickerpersonalApiKeyRequest, type ReferenceDataApiGetSymbolsRequest, type ReferenceDataApiGetSymbolsRequestByAuthMode, type ReferenceDataApiGetSymbolscommercialApiKeyRequest, type ReferenceDataApiGetSymbolspersonalApiKeyRequest, type ReferenceDataApiListAllBrokerageAuthorizationTypeArgs, type ReferenceDataApiListAllBrokerageAuthorizationTypeBaseRequest, type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, type ReferenceDataApiListAllBrokerageAuthorizationTypeRequestByAuthMode, type ReferenceDataApiListAllBrokerageAuthorizationTypecommercialApiKeyRequest, type ReferenceDataApiListAllBrokerageAuthorizationTypepersonalApiKeyRequest, type ReferenceDataApiListAllBrokerageInstrumentsArgs, type ReferenceDataApiListAllBrokerageInstrumentsBaseRequest, type ReferenceDataApiListAllBrokerageInstrumentsRequest, type ReferenceDataApiListAllBrokerageInstrumentsRequestByAuthMode, type ReferenceDataApiListAllBrokerageInstrumentscommercialApiKeyRequest, type ReferenceDataApiListAllBrokerageInstrumentspersonalApiKeyRequest, type ReferenceDataApiSymbolSearchUserAccountArgs, type ReferenceDataApiSymbolSearchUserAccountBaseRequest, type ReferenceDataApiSymbolSearchUserAccountRequest, type ReferenceDataApiSymbolSearchUserAccountRequestByAuthMode, type ReferenceDataApiSymbolSearchUserAccountcommercialApiKeyRequest, type ReferenceDataApiSymbolSearchUserAccountpersonalApiKeyRequest, SecurityType, SessionEvent, SimpleOrderForm, SimpleTradeForm, SimpleTradeInstrument, SimpleTradeLeg, SimpleTradeResponse, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, SymbolNullable, SymbolQuery, SymbolsQuotesInner, TakeProfit, TaxLot, TimeInForceStrict, TokenizedAssetInstrument, TradeDetectionAddSubscriptionRequest, TradeDetectionCancelSubscriptionRequest, TradeDetectionCancelSubscriptionResponse, TradeDetectionSubscription, TradingApi, TradingApiAxiosParamCreator, type TradingApiCancelOrderArgs, type TradingApiCancelOrderBaseRequest, type TradingApiCancelOrderRequest, type TradingApiCancelOrderRequestByAuthMode, type TradingApiCancelOrdercommercialApiKeyRequest, type TradingApiCancelOrderpersonalApiKeyRequest, TradingApiFactory, TradingApiFp, TradingApiGenerated, type TradingApiGetCryptocurrencyPairQuoteArgs, type TradingApiGetCryptocurrencyPairQuoteBaseRequest, type TradingApiGetCryptocurrencyPairQuoteRequest, type TradingApiGetCryptocurrencyPairQuoteRequestByAuthMode, type TradingApiGetCryptocurrencyPairQuotecommercialApiKeyRequest, type TradingApiGetCryptocurrencyPairQuotepersonalApiKeyRequest, type TradingApiGetOptionImpactArgs, type TradingApiGetOptionImpactBaseRequest, type TradingApiGetOptionImpactRequest, type TradingApiGetOptionImpactRequestByAuthMode, type TradingApiGetOptionImpactcommercialApiKeyRequest, type TradingApiGetOptionImpactpersonalApiKeyRequest, type TradingApiGetOrderImpactArgs, type TradingApiGetOrderImpactBaseRequest, type TradingApiGetOrderImpactRequest, type TradingApiGetOrderImpactRequestByAuthMode, type TradingApiGetOrderImpactcommercialApiKeyRequest, type TradingApiGetOrderImpactpersonalApiKeyRequest, type TradingApiGetUserAccountOptionQuotesArgs, type TradingApiGetUserAccountOptionQuotesBaseRequest, type TradingApiGetUserAccountOptionQuotesRequest, type TradingApiGetUserAccountOptionQuotesRequestByAuthMode, type TradingApiGetUserAccountOptionQuotescommercialApiKeyRequest, type TradingApiGetUserAccountOptionQuotespersonalApiKeyRequest, type TradingApiGetUserAccountQuotesArgs, type TradingApiGetUserAccountQuotesBaseRequest, type TradingApiGetUserAccountQuotesRequest, type TradingApiGetUserAccountQuotesRequestByAuthMode, type TradingApiGetUserAccountQuotescommercialApiKeyRequest, type TradingApiGetUserAccountQuotespersonalApiKeyRequest, type TradingApiPlaceComplexOrderArgs, type TradingApiPlaceComplexOrderBaseRequest, type TradingApiPlaceComplexOrderRequest, type TradingApiPlaceComplexOrderRequestByAuthMode, type TradingApiPlaceComplexOrdercommercialApiKeyRequest, type TradingApiPlaceComplexOrderpersonalApiKeyRequest, type TradingApiPlaceCryptoOrderArgs, type TradingApiPlaceCryptoOrderBaseRequest, type TradingApiPlaceCryptoOrderRequest, type TradingApiPlaceCryptoOrderRequestByAuthMode, type TradingApiPlaceCryptoOrdercommercialApiKeyRequest, type TradingApiPlaceCryptoOrderpersonalApiKeyRequest, type TradingApiPlaceForceOrderArgs, type TradingApiPlaceForceOrderBaseRequest, type TradingApiPlaceForceOrderRequest, type TradingApiPlaceForceOrderRequestByAuthMode, type TradingApiPlaceForceOrdercommercialApiKeyRequest, type TradingApiPlaceForceOrderpersonalApiKeyRequest, type TradingApiPlaceMlegOrderArgs, type TradingApiPlaceMlegOrderBaseRequest, type TradingApiPlaceMlegOrderRequest, type TradingApiPlaceMlegOrderRequestByAuthMode, type TradingApiPlaceMlegOrdercommercialApiKeyRequest, type TradingApiPlaceMlegOrderpersonalApiKeyRequest, type TradingApiPlaceOrderArgs, type TradingApiPlaceOrderBaseRequest, type TradingApiPlaceOrderRequest, type TradingApiPlaceOrderRequestByAuthMode, type TradingApiPlaceOrdercommercialApiKeyRequest, type TradingApiPlaceOrderpersonalApiKeyRequest, type TradingApiPreviewCryptoOrderArgs, type TradingApiPreviewCryptoOrderBaseRequest, type TradingApiPreviewCryptoOrderRequest, type TradingApiPreviewCryptoOrderRequestByAuthMode, type TradingApiPreviewCryptoOrdercommercialApiKeyRequest, type TradingApiPreviewCryptoOrderpersonalApiKeyRequest, type TradingApiReplaceOrderArgs, type TradingApiReplaceOrderBaseRequest, type TradingApiReplaceOrderRequest, type TradingApiReplaceOrderRequestByAuthMode, type TradingApiReplaceOrdercommercialApiKeyRequest, type TradingApiReplaceOrderpersonalApiKeyRequest, type TradingApiSearchCryptocurrencyPairInstrumentsArgs, type TradingApiSearchCryptocurrencyPairInstrumentsBaseRequest, type TradingApiSearchCryptocurrencyPairInstrumentsRequest, type TradingApiSearchCryptocurrencyPairInstrumentsRequestByAuthMode, type TradingApiSearchCryptocurrencyPairInstrumentscommercialApiKeyRequest, type TradingApiSearchCryptocurrencyPairInstrumentspersonalApiKeyRequest, TradingGetUserAccountOptionQuotes410Response, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TrailingStopNullable, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UnderlyingTokenizedAssetInstrument, UniversalActivity, UniversalSymbol, UniversalSymbolNullable, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|