snaptrade-typescript-sdk 12.2.22 → 13.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +403 -400
- package/dist/index.d.mts +403 -400
- package/dist/index.d.ts +403 -400
- 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 {
|
|
@@ -133,6 +132,7 @@ declare class BaseAPI<TAuth extends AuthMode> {
|
|
|
133
132
|
* @interface AccountBalanceTotal
|
|
134
133
|
*/
|
|
135
134
|
interface AccountBalanceTotal {
|
|
135
|
+
[key: string]: unknown;
|
|
136
136
|
/**
|
|
137
137
|
* Total value denominated in the currency of the `currency` field.
|
|
138
138
|
* @type {number}
|
|
@@ -154,6 +154,7 @@ interface AccountBalanceTotal {
|
|
|
154
154
|
* @interface AccountBalance
|
|
155
155
|
*/
|
|
156
156
|
interface AccountBalance {
|
|
157
|
+
[key: string]: unknown;
|
|
157
158
|
/**
|
|
158
159
|
*
|
|
159
160
|
* @type {AccountBalanceTotal}
|
|
@@ -244,7 +245,7 @@ interface AccountSyncStatus {
|
|
|
244
245
|
* @interface Account
|
|
245
246
|
*/
|
|
246
247
|
interface Account {
|
|
247
|
-
[key: string]:
|
|
248
|
+
[key: string]: unknown;
|
|
248
249
|
/**
|
|
249
250
|
* 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
251
|
* @type {string}
|
|
@@ -331,12 +332,12 @@ interface Account {
|
|
|
331
332
|
'account_category'?: AccountAccountCategoryEnum;
|
|
332
333
|
/**
|
|
333
334
|
* 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]:
|
|
335
|
+
* @type {{ [key: string]: unknown; }}
|
|
335
336
|
* @memberof Account
|
|
336
337
|
* @deprecated
|
|
337
338
|
*/
|
|
338
339
|
'meta'?: {
|
|
339
|
-
[key: string]:
|
|
340
|
+
[key: string]: unknown;
|
|
340
341
|
};
|
|
341
342
|
/**
|
|
342
343
|
* Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.
|
|
@@ -396,7 +397,7 @@ interface BalanceCurrency {
|
|
|
396
397
|
* @interface Balance
|
|
397
398
|
*/
|
|
398
399
|
interface Balance {
|
|
399
|
-
[key: string]:
|
|
400
|
+
[key: string]: unknown;
|
|
400
401
|
/**
|
|
401
402
|
*
|
|
402
403
|
* @type {BalanceCurrency}
|
|
@@ -451,7 +452,7 @@ interface PositionCurrency {
|
|
|
451
452
|
* @interface Currency
|
|
452
453
|
*/
|
|
453
454
|
interface Currency {
|
|
454
|
-
[key: string]:
|
|
455
|
+
[key: string]: unknown;
|
|
455
456
|
/**
|
|
456
457
|
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
457
458
|
* @type {string}
|
|
@@ -479,7 +480,7 @@ interface Currency {
|
|
|
479
480
|
* @interface FigiInstrumentNullable
|
|
480
481
|
*/
|
|
481
482
|
interface FigiInstrumentNullable {
|
|
482
|
-
[key: string]:
|
|
483
|
+
[key: string]: unknown;
|
|
483
484
|
/**
|
|
484
485
|
* 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
486
|
* @type {string}
|
|
@@ -501,7 +502,7 @@ interface FigiInstrumentNullable {
|
|
|
501
502
|
* @interface SecurityType
|
|
502
503
|
*/
|
|
503
504
|
interface SecurityType {
|
|
504
|
-
[key: string]:
|
|
505
|
+
[key: string]: unknown;
|
|
505
506
|
/**
|
|
506
507
|
* Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
|
|
507
508
|
* @type {string}
|
|
@@ -620,7 +621,7 @@ interface SymbolExchange {
|
|
|
620
621
|
* @interface UniversalSymbol
|
|
621
622
|
*/
|
|
622
623
|
interface UniversalSymbol {
|
|
623
|
-
[key: string]:
|
|
624
|
+
[key: string]: unknown;
|
|
624
625
|
/**
|
|
625
626
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
626
627
|
* @type {string}
|
|
@@ -691,7 +692,7 @@ interface UniversalSymbol {
|
|
|
691
692
|
* @interface PositionSymbol
|
|
692
693
|
*/
|
|
693
694
|
interface PositionSymbol {
|
|
694
|
-
[key: string]:
|
|
695
|
+
[key: string]: unknown;
|
|
695
696
|
/**
|
|
696
697
|
*
|
|
697
698
|
* @type {UniversalSymbol}
|
|
@@ -742,7 +743,7 @@ interface PositionSymbol {
|
|
|
742
743
|
* @interface TaxLot
|
|
743
744
|
*/
|
|
744
745
|
interface TaxLot {
|
|
745
|
-
[key: string]:
|
|
746
|
+
[key: string]: unknown;
|
|
746
747
|
/**
|
|
747
748
|
* The date and time of the purchase.
|
|
748
749
|
* @type {string}
|
|
@@ -794,7 +795,7 @@ interface TaxLot {
|
|
|
794
795
|
* @interface Position
|
|
795
796
|
*/
|
|
796
797
|
interface Position {
|
|
797
|
-
[key: string]:
|
|
798
|
+
[key: string]: unknown;
|
|
798
799
|
/**
|
|
799
800
|
*
|
|
800
801
|
* @type {PositionSymbol}
|
|
@@ -859,7 +860,7 @@ interface Position {
|
|
|
859
860
|
* @interface BrokerageType
|
|
860
861
|
*/
|
|
861
862
|
interface BrokerageType {
|
|
862
|
-
[key: string]:
|
|
863
|
+
[key: string]: unknown;
|
|
863
864
|
/**
|
|
864
865
|
*
|
|
865
866
|
* @type {string}
|
|
@@ -881,7 +882,7 @@ interface BrokerageType {
|
|
|
881
882
|
* @interface Brokerage
|
|
882
883
|
*/
|
|
883
884
|
interface Brokerage {
|
|
884
|
-
[key: string]:
|
|
885
|
+
[key: string]: unknown;
|
|
885
886
|
/**
|
|
886
887
|
* Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
|
|
887
888
|
* @type {string}
|
|
@@ -983,11 +984,11 @@ interface Brokerage {
|
|
|
983
984
|
'brokerage_type'?: BrokerageType;
|
|
984
985
|
/**
|
|
985
986
|
* This field is deprecated. Please contact us if you have a valid use case for it.
|
|
986
|
-
* @type {Array<
|
|
987
|
+
* @type {Array<string>}
|
|
987
988
|
* @memberof Brokerage
|
|
988
989
|
* @deprecated
|
|
989
990
|
*/
|
|
990
|
-
'exchanges'?: Array<
|
|
991
|
+
'exchanges'?: Array<string>;
|
|
991
992
|
/**
|
|
992
993
|
* This field is deprecated.
|
|
993
994
|
* @type {string}
|
|
@@ -1004,7 +1005,7 @@ interface Brokerage {
|
|
|
1004
1005
|
* @interface BrokerageAuthorizationDataFreshnessMode
|
|
1005
1006
|
*/
|
|
1006
1007
|
interface BrokerageAuthorizationDataFreshnessMode {
|
|
1007
|
-
[key: string]:
|
|
1008
|
+
[key: string]: unknown;
|
|
1008
1009
|
/**
|
|
1009
1010
|
* 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
1011
|
* @type {string}
|
|
@@ -1028,7 +1029,7 @@ type BrokerageAuthorizationDataFreshnessModeSnaptradeEnum = 'realtime' | 'delaye
|
|
|
1028
1029
|
* @interface BrokerageAuthorization
|
|
1029
1030
|
*/
|
|
1030
1031
|
interface BrokerageAuthorization {
|
|
1031
|
-
[key: string]:
|
|
1032
|
+
[key: string]: unknown;
|
|
1032
1033
|
/**
|
|
1033
1034
|
* Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
|
|
1034
1035
|
* @type {string}
|
|
@@ -1073,12 +1074,12 @@ interface BrokerageAuthorization {
|
|
|
1073
1074
|
'disabled_date'?: string | null;
|
|
1074
1075
|
/**
|
|
1075
1076
|
* 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]:
|
|
1077
|
+
* @type {{ [key: string]: unknown; }}
|
|
1077
1078
|
* @memberof BrokerageAuthorization
|
|
1078
1079
|
* @deprecated
|
|
1079
1080
|
*/
|
|
1080
1081
|
'meta'?: {
|
|
1081
|
-
[key: string]:
|
|
1082
|
+
[key: string]: unknown;
|
|
1082
1083
|
};
|
|
1083
1084
|
/**
|
|
1084
1085
|
* 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 +1109,7 @@ interface BrokerageAuthorization {
|
|
|
1108
1109
|
* @interface SnapTradeHoldingsAccount
|
|
1109
1110
|
*/
|
|
1110
1111
|
interface SnapTradeHoldingsAccount {
|
|
1111
|
-
[key: string]:
|
|
1112
|
+
[key: string]: unknown;
|
|
1112
1113
|
/**
|
|
1113
1114
|
*
|
|
1114
1115
|
* @type {string}
|
|
@@ -1153,11 +1154,11 @@ interface SnapTradeHoldingsAccount {
|
|
|
1153
1154
|
'sync_status'?: AccountSyncStatus;
|
|
1154
1155
|
/**
|
|
1155
1156
|
*
|
|
1156
|
-
* @type {{ [key: string]:
|
|
1157
|
+
* @type {{ [key: string]: unknown; }}
|
|
1157
1158
|
* @memberof SnapTradeHoldingsAccount
|
|
1158
1159
|
*/
|
|
1159
1160
|
'meta'?: {
|
|
1160
|
-
[key: string]:
|
|
1161
|
+
[key: string]: unknown;
|
|
1161
1162
|
};
|
|
1162
1163
|
}
|
|
1163
1164
|
//#endregion
|
|
@@ -1168,7 +1169,7 @@ interface SnapTradeHoldingsAccount {
|
|
|
1168
1169
|
* @interface SnapTradeHoldingsTotalValue
|
|
1169
1170
|
*/
|
|
1170
1171
|
interface SnapTradeHoldingsTotalValue {
|
|
1171
|
-
[key: string]:
|
|
1172
|
+
[key: string]: unknown;
|
|
1172
1173
|
/**
|
|
1173
1174
|
* Total value denominated in the currency of the `currency` field.
|
|
1174
1175
|
* @type {number}
|
|
@@ -1190,7 +1191,7 @@ interface SnapTradeHoldingsTotalValue {
|
|
|
1190
1191
|
* @interface AccountHoldings
|
|
1191
1192
|
*/
|
|
1192
1193
|
interface AccountHoldings {
|
|
1193
|
-
[key: string]:
|
|
1194
|
+
[key: string]: unknown;
|
|
1194
1195
|
/**
|
|
1195
1196
|
*
|
|
1196
1197
|
* @type {SnapTradeHoldingsAccount}
|
|
@@ -1233,7 +1234,7 @@ type AccountOrderRecordStatus = 'NONE' | 'PENDING' | 'ACCEPTED' | 'FAILED' | 'RE
|
|
|
1233
1234
|
* @interface ChildBrokerageOrderIDsNullable
|
|
1234
1235
|
*/
|
|
1235
1236
|
interface ChildBrokerageOrderIDsNullable {
|
|
1236
|
-
[key: string]:
|
|
1237
|
+
[key: string]: unknown;
|
|
1237
1238
|
/**
|
|
1238
1239
|
* The brokerage order ID for the take profit leg of the bracket order
|
|
1239
1240
|
* @type {string}
|
|
@@ -1255,7 +1256,7 @@ interface ChildBrokerageOrderIDsNullable {
|
|
|
1255
1256
|
* @interface CurrencyNullable
|
|
1256
1257
|
*/
|
|
1257
1258
|
interface CurrencyNullable {
|
|
1258
|
-
[key: string]:
|
|
1259
|
+
[key: string]: unknown;
|
|
1259
1260
|
/**
|
|
1260
1261
|
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
1261
1262
|
* @type {string}
|
|
@@ -1380,7 +1381,7 @@ interface UnderlyingSymbolType {
|
|
|
1380
1381
|
* @interface UnderlyingSymbol
|
|
1381
1382
|
*/
|
|
1382
1383
|
interface UnderlyingSymbol {
|
|
1383
|
-
[key: string]:
|
|
1384
|
+
[key: string]: unknown;
|
|
1384
1385
|
/**
|
|
1385
1386
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1386
1387
|
* @type {string}
|
|
@@ -1451,7 +1452,7 @@ interface UnderlyingSymbol {
|
|
|
1451
1452
|
* @interface OptionsSymbolNullable
|
|
1452
1453
|
*/
|
|
1453
1454
|
interface OptionsSymbolNullable {
|
|
1454
|
-
[key: string]:
|
|
1455
|
+
[key: string]: unknown;
|
|
1455
1456
|
/**
|
|
1456
1457
|
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1457
1458
|
* @type {string}
|
|
@@ -1504,7 +1505,7 @@ type OptionsSymbolNullableOptionTypeEnum = 'CALL' | 'PUT';
|
|
|
1504
1505
|
* @interface TrailingStopNullable
|
|
1505
1506
|
*/
|
|
1506
1507
|
interface TrailingStopNullable {
|
|
1507
|
-
[key: string]:
|
|
1508
|
+
[key: string]: unknown;
|
|
1508
1509
|
/**
|
|
1509
1510
|
* The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`.
|
|
1510
1511
|
* @type {string}
|
|
@@ -1527,7 +1528,7 @@ type TrailingStopNullableTypeEnum = 'DOLLAR' | 'PERCENT';
|
|
|
1527
1528
|
* @interface UniversalSymbolNullable
|
|
1528
1529
|
*/
|
|
1529
1530
|
interface UniversalSymbolNullable {
|
|
1530
|
-
[key: string]:
|
|
1531
|
+
[key: string]: unknown;
|
|
1531
1532
|
/**
|
|
1532
1533
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1533
1534
|
* @type {string}
|
|
@@ -1598,7 +1599,7 @@ interface UniversalSymbolNullable {
|
|
|
1598
1599
|
* @interface AccountOrderRecord
|
|
1599
1600
|
*/
|
|
1600
1601
|
interface AccountOrderRecord {
|
|
1601
|
-
[key: string]:
|
|
1602
|
+
[key: string]: unknown;
|
|
1602
1603
|
/**
|
|
1603
1604
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
1604
1605
|
* @type {string}
|
|
@@ -1760,7 +1761,7 @@ type AccountOrderRecordOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
1760
1761
|
* @interface OptionsSymbol
|
|
1761
1762
|
*/
|
|
1762
1763
|
interface OptionsSymbol {
|
|
1763
|
-
[key: string]:
|
|
1764
|
+
[key: string]: unknown;
|
|
1764
1765
|
/**
|
|
1765
1766
|
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1766
1767
|
* @type {string}
|
|
@@ -1813,7 +1814,7 @@ type OptionsSymbolOptionTypeEnum = 'CALL' | 'PUT';
|
|
|
1813
1814
|
* @interface OptionBrokerageSymbol
|
|
1814
1815
|
*/
|
|
1815
1816
|
interface OptionBrokerageSymbol {
|
|
1816
|
-
[key: string]:
|
|
1817
|
+
[key: string]: unknown;
|
|
1817
1818
|
/**
|
|
1818
1819
|
*
|
|
1819
1820
|
* @type {OptionsSymbol}
|
|
@@ -1843,7 +1844,7 @@ interface OptionBrokerageSymbol {
|
|
|
1843
1844
|
* @interface OptionsPosition
|
|
1844
1845
|
*/
|
|
1845
1846
|
interface OptionsPosition {
|
|
1846
|
-
[key: string]:
|
|
1847
|
+
[key: string]: unknown;
|
|
1847
1848
|
/**
|
|
1848
1849
|
*
|
|
1849
1850
|
* @type {OptionBrokerageSymbol}
|
|
@@ -1883,7 +1884,7 @@ interface OptionsPosition {
|
|
|
1883
1884
|
* @interface AccountHoldingsAccount
|
|
1884
1885
|
*/
|
|
1885
1886
|
interface AccountHoldingsAccount {
|
|
1886
|
-
[key: string]:
|
|
1887
|
+
[key: string]: unknown;
|
|
1887
1888
|
/**
|
|
1888
1889
|
*
|
|
1889
1890
|
* @type {Account}
|
|
@@ -1945,7 +1946,7 @@ interface AccountInformationGetUserAccountOrderDetailRequest {
|
|
|
1945
1946
|
* @interface AccountInformationGetUserHoldings409Response
|
|
1946
1947
|
*/
|
|
1947
1948
|
interface AccountInformationGetUserHoldings409Response {
|
|
1948
|
-
[key: string]:
|
|
1949
|
+
[key: string]: unknown;
|
|
1949
1950
|
/**
|
|
1950
1951
|
*
|
|
1951
1952
|
* @type {string}
|
|
@@ -1973,7 +1974,7 @@ interface AccountInformationGetUserHoldings409Response {
|
|
|
1973
1974
|
* @interface AccountOrderRecordLegInstrument
|
|
1974
1975
|
*/
|
|
1975
1976
|
interface AccountOrderRecordLegInstrument {
|
|
1976
|
-
[key: string]:
|
|
1977
|
+
[key: string]: unknown;
|
|
1977
1978
|
/**
|
|
1978
1979
|
* The symbol or ticker for the security.
|
|
1979
1980
|
* @type {string}
|
|
@@ -2021,7 +2022,7 @@ type AccountOrderRecordStatusV2Nullable = 'PENDING' | 'REJECTED' | 'CANCELED' |
|
|
|
2021
2022
|
* @interface AccountOrderRecordLeg
|
|
2022
2023
|
*/
|
|
2023
2024
|
interface AccountOrderRecordLeg {
|
|
2024
|
-
[key: string]:
|
|
2025
|
+
[key: string]: unknown;
|
|
2025
2026
|
/**
|
|
2026
2027
|
* Brokerage order identifier for this leg, if available.
|
|
2027
2028
|
* @type {string}
|
|
@@ -2079,7 +2080,7 @@ interface AccountOrderRecordLeg {
|
|
|
2079
2080
|
* @interface AccountOrderRecordNullable
|
|
2080
2081
|
*/
|
|
2081
2082
|
interface AccountOrderRecordNullable {
|
|
2082
|
-
[key: string]:
|
|
2083
|
+
[key: string]: unknown;
|
|
2083
2084
|
/**
|
|
2084
2085
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
2085
2086
|
* @type {string}
|
|
@@ -2257,7 +2258,7 @@ type AccountOrderRecordV2OrderRoleNullable = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
2257
2258
|
* @interface AccountOrderRecordV2
|
|
2258
2259
|
*/
|
|
2259
2260
|
interface AccountOrderRecordV2 {
|
|
2260
|
-
[key: string]:
|
|
2261
|
+
[key: string]: unknown;
|
|
2261
2262
|
/**
|
|
2262
2263
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
2263
2264
|
* @type {string}
|
|
@@ -2366,7 +2367,7 @@ type AccountOrderRecordV2OrderRole = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
2366
2367
|
* @interface AccountOrdersV2Response
|
|
2367
2368
|
*/
|
|
2368
2369
|
interface AccountOrdersV2Response {
|
|
2369
|
-
[key: string]:
|
|
2370
|
+
[key: string]: unknown;
|
|
2370
2371
|
/**
|
|
2371
2372
|
* List of orders returned by the endpoint.
|
|
2372
2373
|
* @type {Array<AccountOrderRecordV2>}
|
|
@@ -2382,7 +2383,7 @@ interface AccountOrdersV2Response {
|
|
|
2382
2383
|
* @interface AdrInstrument
|
|
2383
2384
|
*/
|
|
2384
2385
|
interface AdrInstrument {
|
|
2385
|
-
[key: string]:
|
|
2386
|
+
[key: string]: unknown;
|
|
2386
2387
|
/**
|
|
2387
2388
|
* Type of security instrument.
|
|
2388
2389
|
* @type {string}
|
|
@@ -2441,7 +2442,7 @@ type AdrInstrumentKindEnum = 'adr';
|
|
|
2441
2442
|
* @interface CefInstrument
|
|
2442
2443
|
*/
|
|
2443
2444
|
interface CefInstrument {
|
|
2444
|
-
[key: string]:
|
|
2445
|
+
[key: string]: unknown;
|
|
2445
2446
|
/**
|
|
2446
2447
|
* Type of security instrument.
|
|
2447
2448
|
* @type {string}
|
|
@@ -2500,7 +2501,7 @@ type CefInstrumentKindEnum = 'cef';
|
|
|
2500
2501
|
* @interface CryptoInstrument
|
|
2501
2502
|
*/
|
|
2502
2503
|
interface CryptoInstrument {
|
|
2503
|
-
[key: string]:
|
|
2504
|
+
[key: string]: unknown;
|
|
2504
2505
|
/**
|
|
2505
2506
|
* Type of security instrument.
|
|
2506
2507
|
* @type {string}
|
|
@@ -2560,7 +2561,7 @@ type CryptoInstrumentKindEnum = 'crypto';
|
|
|
2560
2561
|
* @interface EtfInstrument
|
|
2561
2562
|
*/
|
|
2562
2563
|
interface EtfInstrument {
|
|
2563
|
-
[key: string]:
|
|
2564
|
+
[key: string]: unknown;
|
|
2564
2565
|
/**
|
|
2565
2566
|
* Type of security instrument.
|
|
2566
2567
|
* @type {string}
|
|
@@ -2619,7 +2620,7 @@ type EtfInstrumentKindEnum = 'etf';
|
|
|
2619
2620
|
* @interface MutualFundInstrument
|
|
2620
2621
|
*/
|
|
2621
2622
|
interface MutualFundInstrument {
|
|
2622
|
-
[key: string]:
|
|
2623
|
+
[key: string]: unknown;
|
|
2623
2624
|
/**
|
|
2624
2625
|
* Type of security instrument.
|
|
2625
2626
|
* @type {string}
|
|
@@ -2678,7 +2679,7 @@ type MutualFundInstrumentKindEnum = 'mutualfund';
|
|
|
2678
2679
|
* @interface OtherInstrument
|
|
2679
2680
|
*/
|
|
2680
2681
|
interface OtherInstrument {
|
|
2681
|
-
[key: string]:
|
|
2682
|
+
[key: string]: unknown;
|
|
2682
2683
|
/**
|
|
2683
2684
|
* Type of security instrument.
|
|
2684
2685
|
* @type {string}
|
|
@@ -2737,7 +2738,7 @@ type OtherInstrumentKindEnum = 'bond' | 'other';
|
|
|
2737
2738
|
* @interface StockInstrument
|
|
2738
2739
|
*/
|
|
2739
2740
|
interface StockInstrument {
|
|
2740
|
-
[key: string]:
|
|
2741
|
+
[key: string]: unknown;
|
|
2741
2742
|
/**
|
|
2742
2743
|
* Type of security instrument.
|
|
2743
2744
|
* @type {string}
|
|
@@ -2820,7 +2821,7 @@ type UnderlyingCfdInstrument = {
|
|
|
2820
2821
|
* @interface CfdInstrument
|
|
2821
2822
|
*/
|
|
2822
2823
|
interface CfdInstrument {
|
|
2823
|
-
[key: string]:
|
|
2824
|
+
[key: string]: unknown;
|
|
2824
2825
|
/**
|
|
2825
2826
|
* Type of security instrument.
|
|
2826
2827
|
* @type {string}
|
|
@@ -2879,7 +2880,7 @@ type CfdInstrumentKindEnum = 'cfd';
|
|
|
2879
2880
|
* @interface FutureInstrument
|
|
2880
2881
|
*/
|
|
2881
2882
|
interface FutureInstrument {
|
|
2882
|
-
[key: string]:
|
|
2883
|
+
[key: string]: unknown;
|
|
2883
2884
|
/**
|
|
2884
2885
|
* Type of security instrument.
|
|
2885
2886
|
* @type {string}
|
|
@@ -2944,7 +2945,7 @@ type FutureInstrumentKindEnum = 'future';
|
|
|
2944
2945
|
* @interface FutureOptionInstrument
|
|
2945
2946
|
*/
|
|
2946
2947
|
interface FutureOptionInstrument {
|
|
2947
|
-
[key: string]:
|
|
2948
|
+
[key: string]: unknown;
|
|
2948
2949
|
/**
|
|
2949
2950
|
* Type of security instrument.
|
|
2950
2951
|
* @type {string}
|
|
@@ -3046,7 +3047,7 @@ type UnderlyingOptionInstrument = {
|
|
|
3046
3047
|
* @interface OptionInstrument
|
|
3047
3048
|
*/
|
|
3048
3049
|
interface OptionInstrument {
|
|
3049
|
-
[key: string]:
|
|
3050
|
+
[key: string]: unknown;
|
|
3050
3051
|
/**
|
|
3051
3052
|
* Type of security instrument.
|
|
3052
3053
|
* @type {string}
|
|
@@ -3124,7 +3125,7 @@ type UnderlyingTokenizedAssetInstrument = {
|
|
|
3124
3125
|
* @interface TokenizedAssetInstrument
|
|
3125
3126
|
*/
|
|
3126
3127
|
interface TokenizedAssetInstrument {
|
|
3127
|
-
[key: string]:
|
|
3128
|
+
[key: string]: unknown;
|
|
3128
3129
|
/**
|
|
3129
3130
|
* Type of security instrument.
|
|
3130
3131
|
* @type {string}
|
|
@@ -3199,7 +3200,7 @@ type Instrument = {
|
|
|
3199
3200
|
* @interface AccountPosition
|
|
3200
3201
|
*/
|
|
3201
3202
|
interface AccountPosition {
|
|
3202
|
-
[key: string]:
|
|
3203
|
+
[key: string]: unknown;
|
|
3203
3204
|
/**
|
|
3204
3205
|
*
|
|
3205
3206
|
* @type {Instrument}
|
|
@@ -3251,7 +3252,7 @@ interface AccountPosition {
|
|
|
3251
3252
|
* @interface AccountSimple
|
|
3252
3253
|
*/
|
|
3253
3254
|
interface AccountSimple {
|
|
3254
|
-
[key: string]:
|
|
3255
|
+
[key: string]: unknown;
|
|
3255
3256
|
/**
|
|
3256
3257
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
3257
3258
|
* @type {string}
|
|
@@ -3291,7 +3292,7 @@ interface AccountSimple {
|
|
|
3291
3292
|
* @interface SymbolNullable
|
|
3292
3293
|
*/
|
|
3293
3294
|
interface SymbolNullable {
|
|
3294
|
-
[key: string]:
|
|
3295
|
+
[key: string]: unknown;
|
|
3295
3296
|
/**
|
|
3296
3297
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
3297
3298
|
* @type {string}
|
|
@@ -3355,7 +3356,7 @@ interface SymbolNullable {
|
|
|
3355
3356
|
* @interface AccountUniversalActivity
|
|
3356
3357
|
*/
|
|
3357
3358
|
interface AccountUniversalActivity {
|
|
3358
|
-
[key: string]:
|
|
3359
|
+
[key: string]: unknown;
|
|
3359
3360
|
/**
|
|
3360
3361
|
* 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
3362
|
* @type {string}
|
|
@@ -3467,7 +3468,7 @@ interface AccountUniversalActivity {
|
|
|
3467
3468
|
* @interface AccountValueHistoryItem
|
|
3468
3469
|
*/
|
|
3469
3470
|
interface AccountValueHistoryItem {
|
|
3470
|
-
[key: string]:
|
|
3471
|
+
[key: string]: unknown;
|
|
3471
3472
|
/**
|
|
3472
3473
|
* The date of the estimated account value
|
|
3473
3474
|
* @type {string}
|
|
@@ -3489,7 +3490,7 @@ interface AccountValueHistoryItem {
|
|
|
3489
3490
|
* @interface AccountValueHistoryResponse
|
|
3490
3491
|
*/
|
|
3491
3492
|
interface AccountValueHistoryResponse {
|
|
3492
|
-
[key: string]:
|
|
3493
|
+
[key: string]: unknown;
|
|
3493
3494
|
/**
|
|
3494
3495
|
* 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
3496
|
* @type {Array<AccountValueHistoryItem>}
|
|
@@ -3527,7 +3528,7 @@ type ActionStrictWithOptions = 'BUY' | 'SELL' | 'BUY_TO_OPEN' | 'BUY_TO_CLOSE' |
|
|
|
3527
3528
|
* @interface AllAccountPositionsResponseDataFreshness
|
|
3528
3529
|
*/
|
|
3529
3530
|
interface AllAccountPositionsResponseDataFreshness {
|
|
3530
|
-
[key: string]:
|
|
3531
|
+
[key: string]: unknown;
|
|
3531
3532
|
/**
|
|
3532
3533
|
* The time the returned positions data was fetched from the brokerage.
|
|
3533
3534
|
* @type {string}
|
|
@@ -3543,7 +3544,7 @@ interface AllAccountPositionsResponseDataFreshness {
|
|
|
3543
3544
|
* @interface AllAccountPositionsResponse
|
|
3544
3545
|
*/
|
|
3545
3546
|
interface AllAccountPositionsResponse {
|
|
3546
|
-
[key: string]:
|
|
3547
|
+
[key: string]: unknown;
|
|
3547
3548
|
/**
|
|
3548
3549
|
* Positions returned for the request.
|
|
3549
3550
|
* @type {Array<AccountPosition>}
|
|
@@ -3565,7 +3566,7 @@ interface AllAccountPositionsResponse {
|
|
|
3565
3566
|
* @interface DepositAccountNetValue
|
|
3566
3567
|
*/
|
|
3567
3568
|
interface DepositAccountNetValue {
|
|
3568
|
-
[key: string]:
|
|
3569
|
+
[key: string]: unknown;
|
|
3569
3570
|
/**
|
|
3570
3571
|
*
|
|
3571
3572
|
* @type {number}
|
|
@@ -3587,7 +3588,7 @@ interface DepositAccountNetValue {
|
|
|
3587
3588
|
* @interface DepositAccountSyncStatus
|
|
3588
3589
|
*/
|
|
3589
3590
|
interface DepositAccountSyncStatus {
|
|
3590
|
-
[key: string]:
|
|
3591
|
+
[key: string]: unknown;
|
|
3591
3592
|
/**
|
|
3592
3593
|
*
|
|
3593
3594
|
* @type {TransactionsStatus}
|
|
@@ -3609,7 +3610,7 @@ interface DepositAccountSyncStatus {
|
|
|
3609
3610
|
* @interface DepositAccount
|
|
3610
3611
|
*/
|
|
3611
3612
|
interface DepositAccount {
|
|
3612
|
-
[key: string]:
|
|
3613
|
+
[key: string]: unknown;
|
|
3613
3614
|
/**
|
|
3614
3615
|
* Discriminator for the account kind.
|
|
3615
3616
|
* @type {string}
|
|
@@ -3686,7 +3687,7 @@ type DepositAccountKindEnum = 'deposit';
|
|
|
3686
3687
|
* @interface ConnectionAccountSyncStatus
|
|
3687
3688
|
*/
|
|
3688
3689
|
interface ConnectionAccountSyncStatus {
|
|
3689
|
-
[key: string]:
|
|
3690
|
+
[key: string]: unknown;
|
|
3690
3691
|
/**
|
|
3691
3692
|
*
|
|
3692
3693
|
* @type {TransactionsStatus}
|
|
@@ -3720,7 +3721,7 @@ interface ConnectionAccountSyncStatus {
|
|
|
3720
3721
|
* @interface InvestmentAccountNetValue
|
|
3721
3722
|
*/
|
|
3722
3723
|
interface InvestmentAccountNetValue {
|
|
3723
|
-
[key: string]:
|
|
3724
|
+
[key: string]: unknown;
|
|
3724
3725
|
/**
|
|
3725
3726
|
*
|
|
3726
3727
|
* @type {number}
|
|
@@ -3742,7 +3743,7 @@ interface InvestmentAccountNetValue {
|
|
|
3742
3743
|
* @interface InvestmentAccount
|
|
3743
3744
|
*/
|
|
3744
3745
|
interface InvestmentAccount {
|
|
3745
|
-
[key: string]:
|
|
3746
|
+
[key: string]: unknown;
|
|
3746
3747
|
/**
|
|
3747
3748
|
* Discriminator for the account kind.
|
|
3748
3749
|
* @type {string}
|
|
@@ -3810,7 +3811,7 @@ interface InvestmentAccount {
|
|
|
3810
3811
|
*/
|
|
3811
3812
|
'raw_type'?: string | null;
|
|
3812
3813
|
/**
|
|
3813
|
-
* Whether the
|
|
3814
|
+
* Whether the account is a cash or margin account, normalized across institutions. - `cash`: The account cannot borrow on margin. Includes registered, retirement and employer plan accounts that can\'t use margin (for example TFSA, RRSP, 401(k) or ISA). - `margin`: A margin account, including portfolio margin accounts. Some institutions also report retirement accounts with limited margin (for example, trading before funds settle) as margin accounts. - `unknown`: SnapTrade doesn\'t have enough information to tell, or the distinction doesn\'t apply to the account (for example crypto accounts). Coverage is limited for Fidelity because its API doesn\'t report it for every account; Fidelity accounts default to `unknown` where it can\'t be determined.
|
|
3814
3815
|
* @type {string}
|
|
3815
3816
|
* @memberof InvestmentAccount
|
|
3816
3817
|
*/
|
|
@@ -3838,7 +3839,7 @@ type InvestmentAccountCashOrMarginEnum = 'cash' | 'margin' | 'unknown';
|
|
|
3838
3839
|
* @interface LineOfCreditAccountAvailableCredit
|
|
3839
3840
|
*/
|
|
3840
3841
|
interface LineOfCreditAccountAvailableCredit {
|
|
3841
|
-
[key: string]:
|
|
3842
|
+
[key: string]: unknown;
|
|
3842
3843
|
/**
|
|
3843
3844
|
*
|
|
3844
3845
|
* @type {number}
|
|
@@ -3860,7 +3861,7 @@ interface LineOfCreditAccountAvailableCredit {
|
|
|
3860
3861
|
* @interface LineOfCreditAccountMinimumPaymentAmount
|
|
3861
3862
|
*/
|
|
3862
3863
|
interface LineOfCreditAccountMinimumPaymentAmount {
|
|
3863
|
-
[key: string]:
|
|
3864
|
+
[key: string]: unknown;
|
|
3864
3865
|
/**
|
|
3865
3866
|
*
|
|
3866
3867
|
* @type {number}
|
|
@@ -3882,7 +3883,7 @@ interface LineOfCreditAccountMinimumPaymentAmount {
|
|
|
3882
3883
|
* @interface LineOfCreditAccountNetValue
|
|
3883
3884
|
*/
|
|
3884
3885
|
interface LineOfCreditAccountNetValue {
|
|
3885
|
-
[key: string]:
|
|
3886
|
+
[key: string]: unknown;
|
|
3886
3887
|
/**
|
|
3887
3888
|
*
|
|
3888
3889
|
* @type {number}
|
|
@@ -3904,7 +3905,7 @@ interface LineOfCreditAccountNetValue {
|
|
|
3904
3905
|
* @interface LineOfCreditAccountSyncStatus
|
|
3905
3906
|
*/
|
|
3906
3907
|
interface LineOfCreditAccountSyncStatus {
|
|
3907
|
-
[key: string]:
|
|
3908
|
+
[key: string]: unknown;
|
|
3908
3909
|
/**
|
|
3909
3910
|
*
|
|
3910
3911
|
* @type {TransactionsStatus}
|
|
@@ -3926,7 +3927,7 @@ interface LineOfCreditAccountSyncStatus {
|
|
|
3926
3927
|
* @interface LineOfCreditAccount
|
|
3927
3928
|
*/
|
|
3928
3929
|
interface LineOfCreditAccount {
|
|
3929
|
-
[key: string]:
|
|
3930
|
+
[key: string]: unknown;
|
|
3930
3931
|
/**
|
|
3931
3932
|
* Discriminator for the account kind.
|
|
3932
3933
|
* @type {string}
|
|
@@ -4035,7 +4036,7 @@ type ConnectionAccount = {
|
|
|
4035
4036
|
* @interface AllUserAccountsResponse
|
|
4036
4037
|
*/
|
|
4037
4038
|
interface AllUserAccountsResponse {
|
|
4038
|
-
[key: string]:
|
|
4039
|
+
[key: string]: unknown;
|
|
4039
4040
|
/**
|
|
4040
4041
|
* Accounts returned for the request.
|
|
4041
4042
|
* @type {Array<ConnectionAccount>}
|
|
@@ -4051,7 +4052,7 @@ interface AllUserAccountsResponse {
|
|
|
4051
4052
|
* @interface EncryptedResponseEncryptedMessageData
|
|
4052
4053
|
*/
|
|
4053
4054
|
interface EncryptedResponseEncryptedMessageData {
|
|
4054
|
-
[key: string]:
|
|
4055
|
+
[key: string]: unknown;
|
|
4055
4056
|
/**
|
|
4056
4057
|
*
|
|
4057
4058
|
* @type {string}
|
|
@@ -4128,7 +4129,7 @@ type AuthenticationLoginSnapTradeUser200Response = EncryptedResponse | LoginRedi
|
|
|
4128
4129
|
* @interface BrokerageAuthorizationDisabledConfirmation
|
|
4129
4130
|
*/
|
|
4130
4131
|
interface BrokerageAuthorizationDisabledConfirmation {
|
|
4131
|
-
[key: string]:
|
|
4132
|
+
[key: string]: unknown;
|
|
4132
4133
|
/**
|
|
4133
4134
|
* Connection disabled confirmation
|
|
4134
4135
|
* @type {string}
|
|
@@ -4144,7 +4145,7 @@ interface BrokerageAuthorizationDisabledConfirmation {
|
|
|
4144
4145
|
* @interface BrokerageAuthorizationRefreshConfirmation
|
|
4145
4146
|
*/
|
|
4146
4147
|
interface BrokerageAuthorizationRefreshConfirmation {
|
|
4147
|
-
[key: string]:
|
|
4148
|
+
[key: string]: unknown;
|
|
4148
4149
|
/**
|
|
4149
4150
|
* Refresh confirmation details
|
|
4150
4151
|
* @type {string}
|
|
@@ -4160,7 +4161,7 @@ interface BrokerageAuthorizationRefreshConfirmation {
|
|
|
4160
4161
|
* @interface BrokerageAuthorizationTransactionsSyncConfirmation
|
|
4161
4162
|
*/
|
|
4162
4163
|
interface BrokerageAuthorizationTransactionsSyncConfirmation {
|
|
4163
|
-
[key: string]:
|
|
4164
|
+
[key: string]: unknown;
|
|
4164
4165
|
/**
|
|
4165
4166
|
* Transactions sync confirmation details
|
|
4166
4167
|
* @type {string}
|
|
@@ -4176,7 +4177,7 @@ interface BrokerageAuthorizationTransactionsSyncConfirmation {
|
|
|
4176
4177
|
* @interface BrokerageAuthorizationTypeReadOnlyBrokerage
|
|
4177
4178
|
*/
|
|
4178
4179
|
interface BrokerageAuthorizationTypeReadOnlyBrokerage {
|
|
4179
|
-
[key: string]:
|
|
4180
|
+
[key: string]: unknown;
|
|
4180
4181
|
/**
|
|
4181
4182
|
*
|
|
4182
4183
|
* @type {string}
|
|
@@ -4204,7 +4205,7 @@ interface BrokerageAuthorizationTypeReadOnlyBrokerage {
|
|
|
4204
4205
|
* @interface BrokerageAuthorizationTypeReadOnly
|
|
4205
4206
|
*/
|
|
4206
4207
|
interface BrokerageAuthorizationTypeReadOnly {
|
|
4207
|
-
[key: string]:
|
|
4208
|
+
[key: string]: unknown;
|
|
4208
4209
|
/**
|
|
4209
4210
|
*
|
|
4210
4211
|
* @type {string}
|
|
@@ -4240,7 +4241,7 @@ type BrokerageAuthorizationTypeReadOnlyAuthTypeEnum = 'OAUTH' | 'SCRAPE' | 'UNOF
|
|
|
4240
4241
|
* @interface BrokerageInstrument
|
|
4241
4242
|
*/
|
|
4242
4243
|
interface BrokerageInstrument {
|
|
4243
|
-
[key: string]:
|
|
4244
|
+
[key: string]: unknown;
|
|
4244
4245
|
/**
|
|
4245
4246
|
* The instrument\'s trading symbol / ticker.
|
|
4246
4247
|
* @type {string}
|
|
@@ -4280,7 +4281,7 @@ interface BrokerageInstrument {
|
|
|
4280
4281
|
* @interface BrokerageInstrumentsResponse
|
|
4281
4282
|
*/
|
|
4282
4283
|
interface BrokerageInstrumentsResponse {
|
|
4283
|
-
[key: string]:
|
|
4284
|
+
[key: string]: unknown;
|
|
4284
4285
|
/**
|
|
4285
4286
|
*
|
|
4286
4287
|
* @type {Array<BrokerageInstrument>}
|
|
@@ -4296,7 +4297,7 @@ interface BrokerageInstrumentsResponse {
|
|
|
4296
4297
|
* @interface CancelOrderResponse
|
|
4297
4298
|
*/
|
|
4298
4299
|
interface CancelOrderResponse {
|
|
4299
|
-
[key: string]:
|
|
4300
|
+
[key: string]: unknown;
|
|
4300
4301
|
/**
|
|
4301
4302
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
4302
4303
|
* @type {string}
|
|
@@ -4305,11 +4306,11 @@ interface CancelOrderResponse {
|
|
|
4305
4306
|
'brokerage_order_id': string;
|
|
4306
4307
|
/**
|
|
4307
4308
|
* The raw response from the brokerage.
|
|
4308
|
-
* @type {{ [key: string]:
|
|
4309
|
+
* @type {{ [key: string]: unknown; }}
|
|
4309
4310
|
* @memberof CancelOrderResponse
|
|
4310
4311
|
*/
|
|
4311
4312
|
'raw_response'?: {
|
|
4312
|
-
[key: string]:
|
|
4313
|
+
[key: string]: unknown;
|
|
4313
4314
|
} | null;
|
|
4314
4315
|
}
|
|
4315
4316
|
//#endregion
|
|
@@ -4320,7 +4321,7 @@ interface CancelOrderResponse {
|
|
|
4320
4321
|
* @interface ChildBrokerageOrderIDs
|
|
4321
4322
|
*/
|
|
4322
4323
|
interface ChildBrokerageOrderIDs {
|
|
4323
|
-
[key: string]:
|
|
4324
|
+
[key: string]: unknown;
|
|
4324
4325
|
/**
|
|
4325
4326
|
* The brokerage order ID for the take profit leg of the bracket order
|
|
4326
4327
|
* @type {string}
|
|
@@ -4358,7 +4359,7 @@ type TimeInForceStrict = 'FOK' | 'Day' | 'GTC' | 'IOC';
|
|
|
4358
4359
|
* @interface TradingInstrument
|
|
4359
4360
|
*/
|
|
4360
4361
|
interface TradingInstrument {
|
|
4361
|
-
[key: string]:
|
|
4362
|
+
[key: string]: unknown;
|
|
4362
4363
|
/**
|
|
4363
4364
|
* 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
4365
|
* @type {string}
|
|
@@ -4381,7 +4382,7 @@ type TradingInstrumentTypeEnum = 'EQUITY' | 'OPTION' | 'CRYPTOCURRENCY' | 'CRYPT
|
|
|
4381
4382
|
* @interface ComplexOrderLeg
|
|
4382
4383
|
*/
|
|
4383
4384
|
interface ComplexOrderLeg {
|
|
4384
|
-
[key: string]:
|
|
4385
|
+
[key: string]: unknown;
|
|
4385
4386
|
/**
|
|
4386
4387
|
* The role of this leg within the complex order.
|
|
4387
4388
|
* @type {string}
|
|
@@ -4440,7 +4441,7 @@ type ComplexOrderLegOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
|
4440
4441
|
* @interface ComplexOrderResponse
|
|
4441
4442
|
*/
|
|
4442
4443
|
interface ComplexOrderResponse {
|
|
4443
|
-
[key: string]:
|
|
4444
|
+
[key: string]: unknown;
|
|
4444
4445
|
/**
|
|
4445
4446
|
* The complex order type that was placed.
|
|
4446
4447
|
* @type {string}
|
|
@@ -4463,7 +4464,7 @@ type ComplexOrderResponseTypeEnum = 'OCO' | 'OTO' | 'OTOCO';
|
|
|
4463
4464
|
* @interface ConnectionAccountsResponse
|
|
4464
4465
|
*/
|
|
4465
4466
|
interface ConnectionAccountsResponse {
|
|
4466
|
-
[key: string]:
|
|
4467
|
+
[key: string]: unknown;
|
|
4467
4468
|
/**
|
|
4468
4469
|
* Accounts returned for the request.
|
|
4469
4470
|
* @type {Array<ConnectionAccount>}
|
|
@@ -4479,7 +4480,7 @@ interface ConnectionAccountsResponse {
|
|
|
4479
4480
|
* @interface CryptoTradingInstrument
|
|
4480
4481
|
*/
|
|
4481
4482
|
interface CryptoTradingInstrument {
|
|
4482
|
-
[key: string]:
|
|
4483
|
+
[key: string]: unknown;
|
|
4483
4484
|
/**
|
|
4484
4485
|
* The instrument\'s trading ticker symbol
|
|
4485
4486
|
* @type {string}
|
|
@@ -4567,7 +4568,7 @@ type CryptoOrderFormTimeInForceEnum = 'GTC' | 'FOK' | 'IOC' | 'GTD';
|
|
|
4567
4568
|
* @interface CryptoOrderPreviewEstimatedFee
|
|
4568
4569
|
*/
|
|
4569
4570
|
interface CryptoOrderPreviewEstimatedFee {
|
|
4570
|
-
[key: string]:
|
|
4571
|
+
[key: string]: unknown;
|
|
4571
4572
|
/**
|
|
4572
4573
|
* Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes.
|
|
4573
4574
|
* @type {string}
|
|
@@ -4589,7 +4590,7 @@ interface CryptoOrderPreviewEstimatedFee {
|
|
|
4589
4590
|
* @interface CryptoOrderPreview
|
|
4590
4591
|
*/
|
|
4591
4592
|
interface CryptoOrderPreview {
|
|
4592
|
-
[key: string]:
|
|
4593
|
+
[key: string]: unknown;
|
|
4593
4594
|
/**
|
|
4594
4595
|
*
|
|
4595
4596
|
* @type {CryptoOrderPreviewEstimatedFee}
|
|
@@ -4605,7 +4606,7 @@ interface CryptoOrderPreview {
|
|
|
4605
4606
|
* @interface CryptocurrencyPair
|
|
4606
4607
|
*/
|
|
4607
4608
|
interface CryptocurrencyPair {
|
|
4608
|
-
[key: string]:
|
|
4609
|
+
[key: string]: unknown;
|
|
4609
4610
|
/**
|
|
4610
4611
|
* Cryptocurrency pair instrument symbol
|
|
4611
4612
|
* @type {string}
|
|
@@ -4639,7 +4640,7 @@ interface CryptocurrencyPair {
|
|
|
4639
4640
|
* @interface CryptocurrencyPairQuote
|
|
4640
4641
|
*/
|
|
4641
4642
|
interface CryptocurrencyPairQuote {
|
|
4642
|
-
[key: string]:
|
|
4643
|
+
[key: string]: unknown;
|
|
4643
4644
|
/**
|
|
4644
4645
|
* The highest price a buyer is willing to pay.
|
|
4645
4646
|
* @type {string}
|
|
@@ -4673,7 +4674,7 @@ interface CryptocurrencyPairQuote {
|
|
|
4673
4674
|
* @interface DeleteConnectionConfirmation
|
|
4674
4675
|
*/
|
|
4675
4676
|
interface DeleteConnectionConfirmation {
|
|
4676
|
-
[key: string]:
|
|
4677
|
+
[key: string]: unknown;
|
|
4677
4678
|
/**
|
|
4678
4679
|
* Connection queued for deletion; please wait for webhook for confirmation.
|
|
4679
4680
|
* @type {string}
|
|
@@ -4695,7 +4696,7 @@ interface DeleteConnectionConfirmation {
|
|
|
4695
4696
|
* @interface DeleteUserResponse
|
|
4696
4697
|
*/
|
|
4697
4698
|
interface DeleteUserResponse {
|
|
4698
|
-
[key: string]:
|
|
4699
|
+
[key: string]: unknown;
|
|
4699
4700
|
/**
|
|
4700
4701
|
* This is always `deleted` when a user is queued for deletion.
|
|
4701
4702
|
* @type {string}
|
|
@@ -4723,7 +4724,7 @@ interface DeleteUserResponse {
|
|
|
4723
4724
|
* @interface DividendAtDate
|
|
4724
4725
|
*/
|
|
4725
4726
|
interface DividendAtDate {
|
|
4726
|
-
[key: string]:
|
|
4727
|
+
[key: string]: unknown;
|
|
4727
4728
|
/**
|
|
4728
4729
|
* The ticker of the symbol that the dividend came from
|
|
4729
4730
|
* @type {string}
|
|
@@ -4751,7 +4752,7 @@ interface DividendAtDate {
|
|
|
4751
4752
|
* @interface Exchange
|
|
4752
4753
|
*/
|
|
4753
4754
|
interface Exchange {
|
|
4754
|
-
[key: string]:
|
|
4755
|
+
[key: string]: unknown;
|
|
4755
4756
|
/**
|
|
4756
4757
|
* Unique ID for the exchange in SnapTrade.
|
|
4757
4758
|
* @type {string}
|
|
@@ -4809,7 +4810,7 @@ interface Exchange {
|
|
|
4809
4810
|
* @interface ExchangeRatePairs
|
|
4810
4811
|
*/
|
|
4811
4812
|
interface ExchangeRatePairs {
|
|
4812
|
-
[key: string]:
|
|
4813
|
+
[key: string]: unknown;
|
|
4813
4814
|
/**
|
|
4814
4815
|
*
|
|
4815
4816
|
* @type {Currency}
|
|
@@ -4837,7 +4838,7 @@ interface ExchangeRatePairs {
|
|
|
4837
4838
|
* @interface FigiInstrument
|
|
4838
4839
|
*/
|
|
4839
4840
|
interface FigiInstrument {
|
|
4840
|
-
[key: string]:
|
|
4841
|
+
[key: string]: unknown;
|
|
4841
4842
|
/**
|
|
4842
4843
|
* 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
4844
|
* @type {string}
|
|
@@ -4859,7 +4860,7 @@ interface FigiInstrument {
|
|
|
4859
4860
|
* @interface InstitutionConnectionNullable
|
|
4860
4861
|
*/
|
|
4861
4862
|
interface InstitutionConnectionNullable {
|
|
4862
|
-
[key: string]:
|
|
4863
|
+
[key: string]: unknown;
|
|
4863
4864
|
/**
|
|
4864
4865
|
* 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
4866
|
* @type {Array<string>}
|
|
@@ -4883,7 +4884,7 @@ type InstitutionConnectionNullableScopesEnum = 'READ' | 'TRADE';
|
|
|
4883
4884
|
* @interface Institution
|
|
4884
4885
|
*/
|
|
4885
4886
|
interface Institution {
|
|
4886
|
-
[key: string]:
|
|
4887
|
+
[key: string]: unknown;
|
|
4887
4888
|
/**
|
|
4888
4889
|
* 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
4890
|
* @type {string}
|
|
@@ -4961,7 +4962,7 @@ type InstitutionRegionsEnum = 'US' | 'CA' | 'EUROPE' | 'AU' | 'IN';
|
|
|
4961
4962
|
* @interface InstitutionConnection
|
|
4962
4963
|
*/
|
|
4963
4964
|
interface InstitutionConnection {
|
|
4964
|
-
[key: string]:
|
|
4965
|
+
[key: string]: unknown;
|
|
4965
4966
|
/**
|
|
4966
4967
|
* 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
4968
|
* @type {Array<string>}
|
|
@@ -4985,7 +4986,7 @@ type InstitutionConnectionScopesEnum = 'READ' | 'TRADE';
|
|
|
4985
4986
|
* @interface ManualTradeSymbol
|
|
4986
4987
|
*/
|
|
4987
4988
|
interface ManualTradeSymbol {
|
|
4988
|
-
[key: string]:
|
|
4989
|
+
[key: string]: unknown;
|
|
4989
4990
|
/**
|
|
4990
4991
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
4991
4992
|
* @type {string}
|
|
@@ -5035,7 +5036,7 @@ interface ManualTradeSymbol {
|
|
|
5035
5036
|
* @interface ManualTrade
|
|
5036
5037
|
*/
|
|
5037
5038
|
interface ManualTrade {
|
|
5038
|
-
[key: string]:
|
|
5039
|
+
[key: string]: unknown;
|
|
5039
5040
|
/**
|
|
5040
5041
|
* Unique identifier for the submitted order through SnapTrade.
|
|
5041
5042
|
* @type {string}
|
|
@@ -5093,7 +5094,7 @@ interface ManualTrade {
|
|
|
5093
5094
|
* @interface ManualTradeBalance
|
|
5094
5095
|
*/
|
|
5095
5096
|
interface ManualTradeBalance {
|
|
5096
|
-
[key: string]:
|
|
5097
|
+
[key: string]: unknown;
|
|
5097
5098
|
/**
|
|
5098
5099
|
*
|
|
5099
5100
|
* @type {AccountSimple}
|
|
@@ -5121,7 +5122,7 @@ interface ManualTradeBalance {
|
|
|
5121
5122
|
* @interface ManualTradeImpact
|
|
5122
5123
|
*/
|
|
5123
5124
|
interface ManualTradeImpact {
|
|
5124
|
-
[key: string]:
|
|
5125
|
+
[key: string]: unknown;
|
|
5125
5126
|
/**
|
|
5126
5127
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
5127
5128
|
* @type {string}
|
|
@@ -5161,7 +5162,7 @@ interface ManualTradeImpact {
|
|
|
5161
5162
|
* @interface ManualTradeAndImpact
|
|
5162
5163
|
*/
|
|
5163
5164
|
interface ManualTradeAndImpact {
|
|
5164
|
-
[key: string]:
|
|
5165
|
+
[key: string]: unknown;
|
|
5165
5166
|
/**
|
|
5166
5167
|
*
|
|
5167
5168
|
* @type {ManualTrade}
|
|
@@ -5260,7 +5261,7 @@ interface ManualTradeForm {
|
|
|
5260
5261
|
* @interface StopLoss
|
|
5261
5262
|
*/
|
|
5262
5263
|
interface StopLoss {
|
|
5263
|
-
[key: string]:
|
|
5264
|
+
[key: string]: unknown;
|
|
5264
5265
|
/**
|
|
5265
5266
|
*
|
|
5266
5267
|
* @type {string}
|
|
@@ -5282,7 +5283,7 @@ interface StopLoss {
|
|
|
5282
5283
|
* @interface TakeProfit
|
|
5283
5284
|
*/
|
|
5284
5285
|
interface TakeProfit {
|
|
5285
|
-
[key: string]:
|
|
5286
|
+
[key: string]: unknown;
|
|
5286
5287
|
/**
|
|
5287
5288
|
*
|
|
5288
5289
|
* @type {string}
|
|
@@ -5298,7 +5299,7 @@ interface TakeProfit {
|
|
|
5298
5299
|
* @interface ManualTradeFormBracket
|
|
5299
5300
|
*/
|
|
5300
5301
|
interface ManualTradeFormBracket {
|
|
5301
|
-
[key: string]:
|
|
5302
|
+
[key: string]: unknown;
|
|
5302
5303
|
/**
|
|
5303
5304
|
* 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
5305
|
* @type {ActionStrictWithOptions}
|
|
@@ -5566,7 +5567,7 @@ type MlegInstrumentType = 'OPTION' | 'EQUITY';
|
|
|
5566
5567
|
* @interface MlegTradingInstrument
|
|
5567
5568
|
*/
|
|
5568
5569
|
interface MlegTradingInstrument {
|
|
5569
|
-
[key: string]:
|
|
5570
|
+
[key: string]: unknown;
|
|
5570
5571
|
/**
|
|
5571
5572
|
* 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
5573
|
* @type {string}
|
|
@@ -5588,7 +5589,7 @@ interface MlegTradingInstrument {
|
|
|
5588
5589
|
* @interface MlegLeg
|
|
5589
5590
|
*/
|
|
5590
5591
|
interface MlegLeg {
|
|
5591
|
-
[key: string]:
|
|
5592
|
+
[key: string]: unknown;
|
|
5592
5593
|
/**
|
|
5593
5594
|
*
|
|
5594
5595
|
* @type {MlegTradingInstrument}
|
|
@@ -5616,7 +5617,7 @@ interface MlegLeg {
|
|
|
5616
5617
|
* @interface MlegOrderResponse
|
|
5617
5618
|
*/
|
|
5618
5619
|
interface MlegOrderResponse {
|
|
5619
|
-
[key: string]:
|
|
5620
|
+
[key: string]: unknown;
|
|
5620
5621
|
/**
|
|
5621
5622
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
5622
5623
|
* @type {string}
|
|
@@ -5707,19 +5708,19 @@ interface MlegTradeForm {
|
|
|
5707
5708
|
* @interface Model400FailedRequestResponse
|
|
5708
5709
|
*/
|
|
5709
5710
|
interface Model400FailedRequestResponse {
|
|
5710
|
-
[key: string]:
|
|
5711
|
+
[key: string]: unknown;
|
|
5711
5712
|
/**
|
|
5712
5713
|
*
|
|
5713
|
-
* @type {
|
|
5714
|
+
* @type {string}
|
|
5714
5715
|
* @memberof Model400FailedRequestResponse
|
|
5715
5716
|
*/
|
|
5716
|
-
'default_detail'?:
|
|
5717
|
+
'default_detail'?: string;
|
|
5717
5718
|
/**
|
|
5718
5719
|
*
|
|
5719
|
-
* @type {
|
|
5720
|
+
* @type {string}
|
|
5720
5721
|
* @memberof Model400FailedRequestResponse
|
|
5721
5722
|
*/
|
|
5722
|
-
'default_code'?:
|
|
5723
|
+
'default_code'?: string;
|
|
5723
5724
|
}
|
|
5724
5725
|
//#endregion
|
|
5725
5726
|
//#region models/model401-failed-request-response.d.ts
|
|
@@ -5729,19 +5730,19 @@ interface Model400FailedRequestResponse {
|
|
|
5729
5730
|
* @interface Model401FailedRequestResponse
|
|
5730
5731
|
*/
|
|
5731
5732
|
interface Model401FailedRequestResponse {
|
|
5732
|
-
[key: string]:
|
|
5733
|
+
[key: string]: unknown;
|
|
5733
5734
|
/**
|
|
5734
5735
|
*
|
|
5735
|
-
* @type {
|
|
5736
|
+
* @type {string}
|
|
5736
5737
|
* @memberof Model401FailedRequestResponse
|
|
5737
5738
|
*/
|
|
5738
|
-
'default_detail'?:
|
|
5739
|
+
'default_detail'?: string;
|
|
5739
5740
|
/**
|
|
5740
5741
|
*
|
|
5741
|
-
* @type {
|
|
5742
|
+
* @type {string}
|
|
5742
5743
|
* @memberof Model401FailedRequestResponse
|
|
5743
5744
|
*/
|
|
5744
|
-
'default_code'?:
|
|
5745
|
+
'default_code'?: string;
|
|
5745
5746
|
}
|
|
5746
5747
|
//#endregion
|
|
5747
5748
|
//#region models/model402-brokerage-auth-already-disabled-exception.d.ts
|
|
@@ -5751,19 +5752,19 @@ interface Model401FailedRequestResponse {
|
|
|
5751
5752
|
* @interface Model402BrokerageAuthAlreadyDisabledException
|
|
5752
5753
|
*/
|
|
5753
5754
|
interface Model402BrokerageAuthAlreadyDisabledException {
|
|
5754
|
-
[key: string]:
|
|
5755
|
+
[key: string]: unknown;
|
|
5755
5756
|
/**
|
|
5756
5757
|
*
|
|
5757
|
-
* @type {
|
|
5758
|
+
* @type {string}
|
|
5758
5759
|
* @memberof Model402BrokerageAuthAlreadyDisabledException
|
|
5759
5760
|
*/
|
|
5760
|
-
'detail'?:
|
|
5761
|
+
'detail'?: string;
|
|
5761
5762
|
/**
|
|
5762
5763
|
*
|
|
5763
|
-
* @type {
|
|
5764
|
+
* @type {string}
|
|
5764
5765
|
* @memberof Model402BrokerageAuthAlreadyDisabledException
|
|
5765
5766
|
*/
|
|
5766
|
-
'code'?:
|
|
5767
|
+
'code'?: string;
|
|
5767
5768
|
}
|
|
5768
5769
|
//#endregion
|
|
5769
5770
|
//#region models/model402-brokerage-auth-disabled-response.d.ts
|
|
@@ -5773,19 +5774,19 @@ interface Model402BrokerageAuthAlreadyDisabledException {
|
|
|
5773
5774
|
* @interface Model402BrokerageAuthDisabledResponse
|
|
5774
5775
|
*/
|
|
5775
5776
|
interface Model402BrokerageAuthDisabledResponse {
|
|
5776
|
-
[key: string]:
|
|
5777
|
+
[key: string]: unknown;
|
|
5777
5778
|
/**
|
|
5778
5779
|
*
|
|
5779
|
-
* @type {
|
|
5780
|
+
* @type {string}
|
|
5780
5781
|
* @memberof Model402BrokerageAuthDisabledResponse
|
|
5781
5782
|
*/
|
|
5782
|
-
'detail'?:
|
|
5783
|
+
'detail'?: string;
|
|
5783
5784
|
/**
|
|
5784
5785
|
*
|
|
5785
|
-
* @type {
|
|
5786
|
+
* @type {string}
|
|
5786
5787
|
* @memberof Model402BrokerageAuthDisabledResponse
|
|
5787
5788
|
*/
|
|
5788
|
-
'code'?:
|
|
5789
|
+
'code'?: string;
|
|
5789
5790
|
}
|
|
5790
5791
|
//#endregion
|
|
5791
5792
|
//#region models/model403-failed-request-response.d.ts
|
|
@@ -5795,19 +5796,19 @@ interface Model402BrokerageAuthDisabledResponse {
|
|
|
5795
5796
|
* @interface Model403FailedRequestResponse
|
|
5796
5797
|
*/
|
|
5797
5798
|
interface Model403FailedRequestResponse {
|
|
5798
|
-
[key: string]:
|
|
5799
|
+
[key: string]: unknown;
|
|
5799
5800
|
/**
|
|
5800
5801
|
*
|
|
5801
|
-
* @type {
|
|
5802
|
+
* @type {string}
|
|
5802
5803
|
* @memberof Model403FailedRequestResponse
|
|
5803
5804
|
*/
|
|
5804
|
-
'default_detail'?:
|
|
5805
|
+
'default_detail'?: string;
|
|
5805
5806
|
/**
|
|
5806
5807
|
*
|
|
5807
|
-
* @type {
|
|
5808
|
+
* @type {string}
|
|
5808
5809
|
* @memberof Model403FailedRequestResponse
|
|
5809
5810
|
*/
|
|
5810
|
-
'default_code'?:
|
|
5811
|
+
'default_code'?: string;
|
|
5811
5812
|
}
|
|
5812
5813
|
//#endregion
|
|
5813
5814
|
//#region models/model403-feature-not-enabled-response.d.ts
|
|
@@ -5817,19 +5818,19 @@ interface Model403FailedRequestResponse {
|
|
|
5817
5818
|
* @interface Model403FeatureNotEnabledResponse
|
|
5818
5819
|
*/
|
|
5819
5820
|
interface Model403FeatureNotEnabledResponse {
|
|
5820
|
-
[key: string]:
|
|
5821
|
+
[key: string]: unknown;
|
|
5821
5822
|
/**
|
|
5822
5823
|
*
|
|
5823
|
-
* @type {
|
|
5824
|
+
* @type {string}
|
|
5824
5825
|
* @memberof Model403FeatureNotEnabledResponse
|
|
5825
5826
|
*/
|
|
5826
|
-
'detail'?:
|
|
5827
|
+
'detail'?: string;
|
|
5827
5828
|
/**
|
|
5828
5829
|
*
|
|
5829
|
-
* @type {
|
|
5830
|
+
* @type {string}
|
|
5830
5831
|
* @memberof Model403FeatureNotEnabledResponse
|
|
5831
5832
|
*/
|
|
5832
|
-
'default_code'?:
|
|
5833
|
+
'default_code'?: string;
|
|
5833
5834
|
}
|
|
5834
5835
|
//#endregion
|
|
5835
5836
|
//#region models/model404-failed-request-response.d.ts
|
|
@@ -5839,19 +5840,19 @@ interface Model403FeatureNotEnabledResponse {
|
|
|
5839
5840
|
* @interface Model404FailedRequestResponse
|
|
5840
5841
|
*/
|
|
5841
5842
|
interface Model404FailedRequestResponse {
|
|
5842
|
-
[key: string]:
|
|
5843
|
+
[key: string]: unknown;
|
|
5843
5844
|
/**
|
|
5844
5845
|
*
|
|
5845
|
-
* @type {
|
|
5846
|
+
* @type {string}
|
|
5846
5847
|
* @memberof Model404FailedRequestResponse
|
|
5847
5848
|
*/
|
|
5848
|
-
'default_detail'?:
|
|
5849
|
+
'default_detail'?: string;
|
|
5849
5850
|
/**
|
|
5850
5851
|
*
|
|
5851
|
-
* @type {
|
|
5852
|
+
* @type {string}
|
|
5852
5853
|
* @memberof Model404FailedRequestResponse
|
|
5853
5854
|
*/
|
|
5854
|
-
'default_code'?:
|
|
5855
|
+
'default_code'?: string;
|
|
5855
5856
|
}
|
|
5856
5857
|
//#endregion
|
|
5857
5858
|
//#region models/model425-failed-request-response.d.ts
|
|
@@ -5861,19 +5862,19 @@ interface Model404FailedRequestResponse {
|
|
|
5861
5862
|
* @interface Model425FailedRequestResponse
|
|
5862
5863
|
*/
|
|
5863
5864
|
interface Model425FailedRequestResponse {
|
|
5864
|
-
[key: string]:
|
|
5865
|
+
[key: string]: unknown;
|
|
5865
5866
|
/**
|
|
5866
5867
|
*
|
|
5867
|
-
* @type {
|
|
5868
|
+
* @type {string}
|
|
5868
5869
|
* @memberof Model425FailedRequestResponse
|
|
5869
5870
|
*/
|
|
5870
|
-
'detail'?:
|
|
5871
|
+
'detail'?: string;
|
|
5871
5872
|
/**
|
|
5872
5873
|
*
|
|
5873
|
-
* @type {
|
|
5874
|
+
* @type {string}
|
|
5874
5875
|
* @memberof Model425FailedRequestResponse
|
|
5875
5876
|
*/
|
|
5876
|
-
'code'?:
|
|
5877
|
+
'code'?: string;
|
|
5877
5878
|
}
|
|
5878
5879
|
//#endregion
|
|
5879
5880
|
//#region models/model429-too-many-requests-response.d.ts
|
|
@@ -5883,25 +5884,25 @@ interface Model425FailedRequestResponse {
|
|
|
5883
5884
|
* @interface Model429TooManyRequestsResponse
|
|
5884
5885
|
*/
|
|
5885
5886
|
interface Model429TooManyRequestsResponse {
|
|
5886
|
-
[key: string]:
|
|
5887
|
+
[key: string]: unknown;
|
|
5887
5888
|
/**
|
|
5888
5889
|
*
|
|
5889
|
-
* @type {
|
|
5890
|
+
* @type {string}
|
|
5890
5891
|
* @memberof Model429TooManyRequestsResponse
|
|
5891
5892
|
*/
|
|
5892
|
-
'detail'?:
|
|
5893
|
+
'detail'?: string;
|
|
5893
5894
|
/**
|
|
5894
5895
|
*
|
|
5895
|
-
* @type {
|
|
5896
|
+
* @type {number}
|
|
5896
5897
|
* @memberof Model429TooManyRequestsResponse
|
|
5897
5898
|
*/
|
|
5898
|
-
'status_code'?:
|
|
5899
|
+
'status_code'?: number;
|
|
5899
5900
|
/**
|
|
5900
5901
|
*
|
|
5901
|
-
* @type {
|
|
5902
|
+
* @type {string}
|
|
5902
5903
|
* @memberof Model429TooManyRequestsResponse
|
|
5903
5904
|
*/
|
|
5904
|
-
'code'?:
|
|
5905
|
+
'code'?: string;
|
|
5905
5906
|
}
|
|
5906
5907
|
//#endregion
|
|
5907
5908
|
//#region models/model500-unexpected-exception-response.d.ts
|
|
@@ -5911,25 +5912,25 @@ interface Model429TooManyRequestsResponse {
|
|
|
5911
5912
|
* @interface Model500UnexpectedExceptionResponse
|
|
5912
5913
|
*/
|
|
5913
5914
|
interface Model500UnexpectedExceptionResponse {
|
|
5914
|
-
[key: string]:
|
|
5915
|
+
[key: string]: unknown;
|
|
5915
5916
|
/**
|
|
5916
5917
|
*
|
|
5917
|
-
* @type {
|
|
5918
|
+
* @type {string}
|
|
5918
5919
|
* @memberof Model500UnexpectedExceptionResponse
|
|
5919
5920
|
*/
|
|
5920
|
-
'detail'?:
|
|
5921
|
+
'detail'?: string;
|
|
5921
5922
|
/**
|
|
5922
5923
|
*
|
|
5923
|
-
* @type {
|
|
5924
|
+
* @type {number}
|
|
5924
5925
|
* @memberof Model500UnexpectedExceptionResponse
|
|
5925
5926
|
*/
|
|
5926
|
-
'status_code'?:
|
|
5927
|
+
'status_code'?: number;
|
|
5927
5928
|
/**
|
|
5928
5929
|
*
|
|
5929
|
-
* @type {
|
|
5930
|
+
* @type {string}
|
|
5930
5931
|
* @memberof Model500UnexpectedExceptionResponse
|
|
5931
5932
|
*/
|
|
5932
|
-
'code'?:
|
|
5933
|
+
'code'?: string;
|
|
5933
5934
|
}
|
|
5934
5935
|
//#endregion
|
|
5935
5936
|
//#region models/model501-not-implemented-response.d.ts
|
|
@@ -5939,13 +5940,13 @@ interface Model500UnexpectedExceptionResponse {
|
|
|
5939
5940
|
* @interface Model501NotImplementedResponse
|
|
5940
5941
|
*/
|
|
5941
5942
|
interface Model501NotImplementedResponse {
|
|
5942
|
-
[key: string]:
|
|
5943
|
+
[key: string]: unknown;
|
|
5943
5944
|
/**
|
|
5944
5945
|
*
|
|
5945
|
-
* @type {
|
|
5946
|
+
* @type {string}
|
|
5946
5947
|
* @memberof Model501NotImplementedResponse
|
|
5947
5948
|
*/
|
|
5948
|
-
'error'?:
|
|
5949
|
+
'error'?: string;
|
|
5949
5950
|
}
|
|
5950
5951
|
//#endregion
|
|
5951
5952
|
//#region models/model503-brokerage-request-response.d.ts
|
|
@@ -5955,25 +5956,25 @@ interface Model501NotImplementedResponse {
|
|
|
5955
5956
|
* @interface Model503BrokerageRequestResponse
|
|
5956
5957
|
*/
|
|
5957
5958
|
interface Model503BrokerageRequestResponse {
|
|
5958
|
-
[key: string]:
|
|
5959
|
+
[key: string]: unknown;
|
|
5959
5960
|
/**
|
|
5960
5961
|
*
|
|
5961
|
-
* @type {
|
|
5962
|
+
* @type {string}
|
|
5962
5963
|
* @memberof Model503BrokerageRequestResponse
|
|
5963
5964
|
*/
|
|
5964
|
-
'detail'?:
|
|
5965
|
+
'detail'?: string;
|
|
5965
5966
|
/**
|
|
5966
5967
|
*
|
|
5967
|
-
* @type {
|
|
5968
|
+
* @type {number}
|
|
5968
5969
|
* @memberof Model503BrokerageRequestResponse
|
|
5969
5970
|
*/
|
|
5970
|
-
'status_code'?:
|
|
5971
|
+
'status_code'?: number;
|
|
5971
5972
|
/**
|
|
5972
5973
|
*
|
|
5973
|
-
* @type {
|
|
5974
|
+
* @type {string}
|
|
5974
5975
|
* @memberof Model503BrokerageRequestResponse
|
|
5975
5976
|
*/
|
|
5976
|
-
'code'?:
|
|
5977
|
+
'code'?: string;
|
|
5977
5978
|
}
|
|
5978
5979
|
//#endregion
|
|
5979
5980
|
//#region models/monthly-dividends.d.ts
|
|
@@ -5983,7 +5984,7 @@ interface Model503BrokerageRequestResponse {
|
|
|
5983
5984
|
* @interface MonthlyDividends
|
|
5984
5985
|
*/
|
|
5985
5986
|
interface MonthlyDividends {
|
|
5986
|
-
[key: string]:
|
|
5987
|
+
[key: string]: unknown;
|
|
5987
5988
|
/**
|
|
5988
5989
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
5989
5990
|
* @type {string}
|
|
@@ -6005,7 +6006,7 @@ interface MonthlyDividends {
|
|
|
6005
6006
|
* @interface NetContributions
|
|
6006
6007
|
*/
|
|
6007
6008
|
interface NetContributions {
|
|
6008
|
-
[key: string]:
|
|
6009
|
+
[key: string]: unknown;
|
|
6009
6010
|
/**
|
|
6010
6011
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
6011
6012
|
* @type {string}
|
|
@@ -6033,7 +6034,7 @@ interface NetContributions {
|
|
|
6033
6034
|
* @interface NetDividend
|
|
6034
6035
|
*/
|
|
6035
6036
|
interface NetDividend {
|
|
6036
|
-
[key: string]:
|
|
6037
|
+
[key: string]: unknown;
|
|
6037
6038
|
/**
|
|
6038
6039
|
*
|
|
6039
6040
|
* @type {UniversalSymbol}
|
|
@@ -6069,7 +6070,7 @@ type NotionalValue = number | string;
|
|
|
6069
6070
|
* @interface OAuthWebhookBase
|
|
6070
6071
|
*/
|
|
6071
6072
|
interface OAuthWebhookBase {
|
|
6072
|
-
[key: string]:
|
|
6073
|
+
[key: string]: unknown;
|
|
6073
6074
|
/**
|
|
6074
6075
|
*
|
|
6075
6076
|
* @type {string}
|
|
@@ -6132,11 +6133,11 @@ interface OAuthWebhookBase {
|
|
|
6132
6133
|
'connectionAttemptedResult'?: string;
|
|
6133
6134
|
/**
|
|
6134
6135
|
*
|
|
6135
|
-
* @type {{ [key: string]:
|
|
6136
|
+
* @type {{ [key: string]: unknown; }}
|
|
6136
6137
|
* @memberof OAuthWebhookBase
|
|
6137
6138
|
*/
|
|
6138
6139
|
'details'?: {
|
|
6139
|
-
[key: string]:
|
|
6140
|
+
[key: string]: unknown;
|
|
6140
6141
|
};
|
|
6141
6142
|
}
|
|
6142
6143
|
type OAuthWebhookBaseSchemaVersionEnum = 'oauth_v1';
|
|
@@ -6148,7 +6149,7 @@ type OAuthWebhookBaseSchemaVersionEnum = 'oauth_v1';
|
|
|
6148
6149
|
* @interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
|
|
6149
6150
|
*/
|
|
6150
6151
|
interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
|
|
6151
|
-
[key: string]:
|
|
6152
|
+
[key: string]: unknown;
|
|
6152
6153
|
/**
|
|
6153
6154
|
*
|
|
6154
6155
|
* @type {number}
|
|
@@ -6176,7 +6177,7 @@ interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
|
|
|
6176
6177
|
* @interface OptionChainInnerChainPerRootInner
|
|
6177
6178
|
*/
|
|
6178
6179
|
interface OptionChainInnerChainPerRootInner {
|
|
6179
|
-
[key: string]:
|
|
6180
|
+
[key: string]: unknown;
|
|
6180
6181
|
/**
|
|
6181
6182
|
*
|
|
6182
6183
|
* @type {string}
|
|
@@ -6204,7 +6205,7 @@ interface OptionChainInnerChainPerRootInner {
|
|
|
6204
6205
|
* @interface OptionChainInner
|
|
6205
6206
|
*/
|
|
6206
6207
|
interface OptionChainInner {
|
|
6207
|
-
[key: string]:
|
|
6208
|
+
[key: string]: unknown;
|
|
6208
6209
|
/**
|
|
6209
6210
|
*
|
|
6210
6211
|
* @type {string}
|
|
@@ -6244,7 +6245,7 @@ interface OptionChainInner {
|
|
|
6244
6245
|
* @interface OptionImpact
|
|
6245
6246
|
*/
|
|
6246
6247
|
interface OptionImpact {
|
|
6247
|
-
[key: string]:
|
|
6248
|
+
[key: string]: unknown;
|
|
6248
6249
|
/**
|
|
6249
6250
|
* Estimated cash change for the order, before fees.
|
|
6250
6251
|
* @type {string}
|
|
@@ -6273,7 +6274,7 @@ type OptionImpactCashChangeDirectionEnum = 'CREDIT' | 'DEBIT' | 'EVEN' | 'UNKNOW
|
|
|
6273
6274
|
* @interface OptionLeg
|
|
6274
6275
|
*/
|
|
6275
6276
|
interface OptionLeg {
|
|
6276
|
-
[key: string]:
|
|
6277
|
+
[key: string]: unknown;
|
|
6277
6278
|
/**
|
|
6278
6279
|
*
|
|
6279
6280
|
* @type {string}
|
|
@@ -6302,7 +6303,7 @@ type OptionLegActionEnum = 'BUY_TO_OPEN' | 'BUY_TO_CLOSE' | 'SELL_TO_OPEN' | 'SE
|
|
|
6302
6303
|
* @interface OptionQuoteGreeks
|
|
6303
6304
|
*/
|
|
6304
6305
|
interface OptionQuoteGreeks {
|
|
6305
|
-
[key: string]:
|
|
6306
|
+
[key: string]: unknown;
|
|
6306
6307
|
/**
|
|
6307
6308
|
* Delta represents the rate of change between the option\'s price and a $1 change in the underlying asset\'s price.
|
|
6308
6309
|
* @type {number}
|
|
@@ -6336,7 +6337,7 @@ interface OptionQuoteGreeks {
|
|
|
6336
6337
|
* @interface OptionQuote
|
|
6337
6338
|
*/
|
|
6338
6339
|
interface OptionQuote {
|
|
6339
|
-
[key: string]:
|
|
6340
|
+
[key: string]: unknown;
|
|
6340
6341
|
/**
|
|
6341
6342
|
* The OCC-formatted option symbol.
|
|
6342
6343
|
* @type {string}
|
|
@@ -6376,6 +6377,7 @@ interface OptionQuote {
|
|
|
6376
6377
|
* @interface OptionStrategyLegsInner
|
|
6377
6378
|
*/
|
|
6378
6379
|
interface OptionStrategyLegsInner {
|
|
6380
|
+
[key: string]: unknown;
|
|
6379
6381
|
/**
|
|
6380
6382
|
*
|
|
6381
6383
|
* @type {string}
|
|
@@ -6409,7 +6411,7 @@ interface OptionStrategyLegsInner {
|
|
|
6409
6411
|
* @interface OptionStrategy
|
|
6410
6412
|
*/
|
|
6411
6413
|
interface OptionStrategy {
|
|
6412
|
-
[key: string]:
|
|
6414
|
+
[key: string]: unknown;
|
|
6413
6415
|
/**
|
|
6414
6416
|
*
|
|
6415
6417
|
* @type {string}
|
|
@@ -6449,7 +6451,7 @@ interface OptionStrategy {
|
|
|
6449
6451
|
* @interface OrderUpdatedResponse
|
|
6450
6452
|
*/
|
|
6451
6453
|
interface OrderUpdatedResponse {
|
|
6452
|
-
[key: string]:
|
|
6454
|
+
[key: string]: unknown;
|
|
6453
6455
|
/**
|
|
6454
6456
|
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
6455
6457
|
* @type {string}
|
|
@@ -6471,7 +6473,7 @@ interface OrderUpdatedResponse {
|
|
|
6471
6473
|
* @interface PaginationDetails
|
|
6472
6474
|
*/
|
|
6473
6475
|
interface PaginationDetails {
|
|
6474
|
-
[key: string]:
|
|
6476
|
+
[key: string]: unknown;
|
|
6475
6477
|
/**
|
|
6476
6478
|
* The starting point of the paginated results.
|
|
6477
6479
|
* @type {number}
|
|
@@ -6499,7 +6501,7 @@ interface PaginationDetails {
|
|
|
6499
6501
|
* @interface PaginatedUniversalActivity
|
|
6500
6502
|
*/
|
|
6501
6503
|
interface PaginatedUniversalActivity {
|
|
6502
|
-
[key: string]:
|
|
6504
|
+
[key: string]: unknown;
|
|
6503
6505
|
/**
|
|
6504
6506
|
*
|
|
6505
6507
|
* @type {Array<AccountUniversalActivity>}
|
|
@@ -6521,7 +6523,7 @@ interface PaginatedUniversalActivity {
|
|
|
6521
6523
|
* @interface PartnerData
|
|
6522
6524
|
*/
|
|
6523
6525
|
interface PartnerData {
|
|
6524
|
-
[key: string]:
|
|
6526
|
+
[key: string]: unknown;
|
|
6525
6527
|
/**
|
|
6526
6528
|
* A short, unique identifier for your company or product.
|
|
6527
6529
|
* @type {string}
|
|
@@ -6604,7 +6606,7 @@ interface PartnerData {
|
|
|
6604
6606
|
* @interface PastValue
|
|
6605
6607
|
*/
|
|
6606
6608
|
interface PastValue {
|
|
6607
|
-
[key: string]:
|
|
6609
|
+
[key: string]: unknown;
|
|
6608
6610
|
/**
|
|
6609
6611
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
6610
6612
|
* @type {string}
|
|
@@ -6632,7 +6634,7 @@ interface PastValue {
|
|
|
6632
6634
|
* @interface SubPeriodReturnRate
|
|
6633
6635
|
*/
|
|
6634
6636
|
interface SubPeriodReturnRate {
|
|
6635
|
-
[key: string]:
|
|
6637
|
+
[key: string]: unknown;
|
|
6636
6638
|
/**
|
|
6637
6639
|
* Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
|
|
6638
6640
|
* @type {string}
|
|
@@ -6660,7 +6662,7 @@ interface SubPeriodReturnRate {
|
|
|
6660
6662
|
* @interface PerformanceCustom
|
|
6661
6663
|
*/
|
|
6662
6664
|
interface PerformanceCustom {
|
|
6663
|
-
[key: string]:
|
|
6665
|
+
[key: string]: unknown;
|
|
6664
6666
|
/**
|
|
6665
6667
|
*
|
|
6666
6668
|
* @type {Array<PastValue>}
|
|
@@ -6784,7 +6786,7 @@ interface PerformanceCustom {
|
|
|
6784
6786
|
* @interface RateOfReturnObject
|
|
6785
6787
|
*/
|
|
6786
6788
|
interface RateOfReturnObject {
|
|
6787
|
-
[key: string]:
|
|
6789
|
+
[key: string]: unknown;
|
|
6788
6790
|
/**
|
|
6789
6791
|
* The timeframe this return percent is reflecting
|
|
6790
6792
|
* @type {string}
|
|
@@ -6813,7 +6815,7 @@ type RateOfReturnObjectTimeframeEnum = 'ALL' | '1Y' | 'YTD' | '1M' | '1W' | '1D'
|
|
|
6813
6815
|
* @interface RateOfReturnResponse
|
|
6814
6816
|
*/
|
|
6815
6817
|
interface RateOfReturnResponse {
|
|
6816
|
-
[key: string]:
|
|
6818
|
+
[key: string]: unknown;
|
|
6817
6819
|
/**
|
|
6818
6820
|
* List of return percentages
|
|
6819
6821
|
* @type {Array<RateOfReturnObject>}
|
|
@@ -6829,7 +6831,7 @@ interface RateOfReturnResponse {
|
|
|
6829
6831
|
* @interface RecentOrdersResponse
|
|
6830
6832
|
*/
|
|
6831
6833
|
interface RecentOrdersResponse {
|
|
6832
|
-
[key: string]:
|
|
6834
|
+
[key: string]: unknown;
|
|
6833
6835
|
/**
|
|
6834
6836
|
* List of orders executed in the last 24 hours
|
|
6835
6837
|
* @type {Array<AccountOrderRecord>}
|
|
@@ -6845,7 +6847,7 @@ interface RecentOrdersResponse {
|
|
|
6845
6847
|
* @interface SessionEvent
|
|
6846
6848
|
*/
|
|
6847
6849
|
interface SessionEvent {
|
|
6848
|
-
[key: string]:
|
|
6850
|
+
[key: string]: unknown;
|
|
6849
6851
|
/**
|
|
6850
6852
|
*
|
|
6851
6853
|
* @type {string}
|
|
@@ -6898,7 +6900,7 @@ type SessionEventSessionEventTypeEnum = 'OAUTH_REDIRECT' | 'DISCLAIMER_ACCEPTED'
|
|
|
6898
6900
|
* @interface SimpleOrderForm
|
|
6899
6901
|
*/
|
|
6900
6902
|
interface SimpleOrderForm {
|
|
6901
|
-
[key: string]:
|
|
6903
|
+
[key: string]: unknown;
|
|
6902
6904
|
/**
|
|
6903
6905
|
*
|
|
6904
6906
|
* @type {TradingInstrument}
|
|
@@ -6964,7 +6966,7 @@ type SimpleOrderFormTimeInForceEnum = 'GTC' | 'FOK' | 'IOC' | 'GTD';
|
|
|
6964
6966
|
* @interface SimpleTradeInstrument
|
|
6965
6967
|
*/
|
|
6966
6968
|
interface SimpleTradeInstrument {
|
|
6967
|
-
[key: string]:
|
|
6969
|
+
[key: string]: unknown;
|
|
6968
6970
|
/**
|
|
6969
6971
|
*
|
|
6970
6972
|
* @type {string}
|
|
@@ -6987,7 +6989,7 @@ type SimpleTradeInstrumentKindEnum = 'equity' | 'option' | 'future' | 'future_op
|
|
|
6987
6989
|
* @interface SimpleTradeLeg
|
|
6988
6990
|
*/
|
|
6989
6991
|
interface SimpleTradeLeg {
|
|
6990
|
-
[key: string]:
|
|
6992
|
+
[key: string]: unknown;
|
|
6991
6993
|
/**
|
|
6992
6994
|
*
|
|
6993
6995
|
* @type {SimpleTradeInstrument}
|
|
@@ -7089,7 +7091,7 @@ type SimpleTradeFormTradingSessionEnum = 'regular' | 'extended';
|
|
|
7089
7091
|
* @interface SimpleTradeResponse
|
|
7090
7092
|
*/
|
|
7091
7093
|
interface SimpleTradeResponse {
|
|
7092
|
-
[key: string]:
|
|
7094
|
+
[key: string]: unknown;
|
|
7093
7095
|
/**
|
|
7094
7096
|
* The brokerage-assigned ID of the submitted order.
|
|
7095
7097
|
* @type {string}
|
|
@@ -7185,7 +7187,7 @@ interface SnapTradeRegisterUserRequestBody {
|
|
|
7185
7187
|
* @interface Status
|
|
7186
7188
|
*/
|
|
7187
7189
|
interface Status {
|
|
7188
|
-
[key: string]:
|
|
7190
|
+
[key: string]: unknown;
|
|
7189
7191
|
/**
|
|
7190
7192
|
*
|
|
7191
7193
|
* @type {number}
|
|
@@ -7213,7 +7215,7 @@ interface Status {
|
|
|
7213
7215
|
* @interface StrategyOrderRecord
|
|
7214
7216
|
*/
|
|
7215
7217
|
interface StrategyOrderRecord {
|
|
7216
|
-
[key: string]:
|
|
7218
|
+
[key: string]: unknown;
|
|
7217
7219
|
/**
|
|
7218
7220
|
*
|
|
7219
7221
|
* @type {OptionStrategy}
|
|
@@ -7290,7 +7292,7 @@ type StrategyOrderRecordStatusEnum = 'PENDING' | 'ACCEPTED' | 'FAILED' | 'REJECT
|
|
|
7290
7292
|
* @interface StrategyQuotesGreek
|
|
7291
7293
|
*/
|
|
7292
7294
|
interface StrategyQuotesGreek {
|
|
7293
|
-
[key: string]:
|
|
7295
|
+
[key: string]: unknown;
|
|
7294
7296
|
/**
|
|
7295
7297
|
*
|
|
7296
7298
|
* @type {number}
|
|
@@ -7330,7 +7332,7 @@ interface StrategyQuotesGreek {
|
|
|
7330
7332
|
* @interface StrategyQuotes
|
|
7331
7333
|
*/
|
|
7332
7334
|
interface StrategyQuotes {
|
|
7333
|
-
[key: string]:
|
|
7335
|
+
[key: string]: unknown;
|
|
7334
7336
|
/**
|
|
7335
7337
|
*
|
|
7336
7338
|
* @type {OptionStrategy}
|
|
@@ -7376,7 +7378,7 @@ interface StrategyQuotes {
|
|
|
7376
7378
|
* @interface Symbol
|
|
7377
7379
|
*/
|
|
7378
7380
|
interface Symbol {
|
|
7379
|
-
[key: string]:
|
|
7381
|
+
[key: string]: unknown;
|
|
7380
7382
|
/**
|
|
7381
7383
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
7382
7384
|
* @type {string}
|
|
@@ -7455,6 +7457,7 @@ interface SymbolQuery {
|
|
|
7455
7457
|
* @interface SymbolsQuotesInner
|
|
7456
7458
|
*/
|
|
7457
7459
|
interface SymbolsQuotesInner {
|
|
7460
|
+
[key: string]: unknown;
|
|
7458
7461
|
/**
|
|
7459
7462
|
*
|
|
7460
7463
|
* @type {UniversalSymbol}
|
|
@@ -7536,7 +7539,7 @@ interface TradeDetectionCancelSubscriptionRequest {
|
|
|
7536
7539
|
* @interface TradeDetectionCancelSubscriptionResponse
|
|
7537
7540
|
*/
|
|
7538
7541
|
interface TradeDetectionCancelSubscriptionResponse {
|
|
7539
|
-
[key: string]:
|
|
7542
|
+
[key: string]: unknown;
|
|
7540
7543
|
/**
|
|
7541
7544
|
*
|
|
7542
7545
|
* @type {boolean}
|
|
@@ -7552,7 +7555,7 @@ interface TradeDetectionCancelSubscriptionResponse {
|
|
|
7552
7555
|
* @interface TradeDetectionSubscription
|
|
7553
7556
|
*/
|
|
7554
7557
|
interface TradeDetectionSubscription {
|
|
7555
|
-
[key: string]:
|
|
7558
|
+
[key: string]: unknown;
|
|
7556
7559
|
/**
|
|
7557
7560
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
7558
7561
|
* @type {string}
|
|
@@ -7580,7 +7583,7 @@ interface TradeDetectionSubscription {
|
|
|
7580
7583
|
* @interface TradingGetUserAccountOptionQuotes410Response
|
|
7581
7584
|
*/
|
|
7582
7585
|
interface TradingGetUserAccountOptionQuotes410Response {
|
|
7583
|
-
[key: string]:
|
|
7586
|
+
[key: string]: unknown;
|
|
7584
7587
|
/**
|
|
7585
7588
|
*
|
|
7586
7589
|
* @type {string}
|
|
@@ -7596,7 +7599,7 @@ interface TradingGetUserAccountOptionQuotes410Response {
|
|
|
7596
7599
|
* @interface TradingSearchCryptocurrencyPairInstruments200Response
|
|
7597
7600
|
*/
|
|
7598
7601
|
interface TradingSearchCryptocurrencyPairInstruments200Response {
|
|
7599
|
-
[key: string]:
|
|
7602
|
+
[key: string]: unknown;
|
|
7600
7603
|
/**
|
|
7601
7604
|
*
|
|
7602
7605
|
* @type {Array<CryptocurrencyPair>}
|
|
@@ -7612,7 +7615,7 @@ interface TradingSearchCryptocurrencyPairInstruments200Response {
|
|
|
7612
7615
|
* @interface TrailingStop
|
|
7613
7616
|
*/
|
|
7614
7617
|
interface TrailingStop {
|
|
7615
|
-
[key: string]:
|
|
7618
|
+
[key: string]: unknown;
|
|
7616
7619
|
/**
|
|
7617
7620
|
* The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`.
|
|
7618
7621
|
* @type {string}
|
|
@@ -7635,7 +7638,7 @@ type TrailingStopTypeEnum = 'DOLLAR' | 'PERCENT';
|
|
|
7635
7638
|
* @interface USExchange
|
|
7636
7639
|
*/
|
|
7637
7640
|
interface USExchange {
|
|
7638
|
-
[key: string]:
|
|
7641
|
+
[key: string]: unknown;
|
|
7639
7642
|
/**
|
|
7640
7643
|
*
|
|
7641
7644
|
* @type {string}
|
|
@@ -7699,7 +7702,7 @@ interface USExchange {
|
|
|
7699
7702
|
* @interface UniversalActivity
|
|
7700
7703
|
*/
|
|
7701
7704
|
interface UniversalActivity {
|
|
7702
|
-
[key: string]:
|
|
7705
|
+
[key: string]: unknown;
|
|
7703
7706
|
/**
|
|
7704
7707
|
* 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
7708
|
* @type {string}
|
|
@@ -8016,7 +8019,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8016
8019
|
* @param {*} [options] Override http request option.
|
|
8017
8020
|
* @throws {RequiredError}
|
|
8018
8021
|
*/
|
|
8019
|
-
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8022
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PaginatedUniversalActivity, unknown>>>;
|
|
8020
8023
|
/**
|
|
8021
8024
|
* 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
8025
|
* @summary List historical account total value
|
|
@@ -8024,7 +8027,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8024
8027
|
* @param {*} [options] Override http request option.
|
|
8025
8028
|
* @throws {RequiredError}
|
|
8026
8029
|
*/
|
|
8027
|
-
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8030
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountValueHistoryResponse, unknown>>>;
|
|
8028
8031
|
/**
|
|
8029
8032
|
* 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
8033
|
* @summary Get account details
|
|
@@ -8032,7 +8035,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8032
8035
|
* @param {*} [options] Override http request option.
|
|
8033
8036
|
* @throws {RequiredError}
|
|
8034
8037
|
*/
|
|
8035
|
-
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8038
|
+
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ConnectionAccount, unknown>>>;
|
|
8036
8039
|
/**
|
|
8037
8040
|
* 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
8041
|
* @summary List all account positions
|
|
@@ -8040,7 +8043,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8040
8043
|
* @param {*} [options] Override http request option.
|
|
8041
8044
|
* @throws {RequiredError}
|
|
8042
8045
|
*/
|
|
8043
|
-
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8046
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AllAccountPositionsResponse, unknown>>>;
|
|
8044
8047
|
/**
|
|
8045
8048
|
* 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
8049
|
* @summary List account balances
|
|
@@ -8048,7 +8051,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8048
8051
|
* @param {*} [options] Override http request option.
|
|
8049
8052
|
* @throws {RequiredError}
|
|
8050
8053
|
*/
|
|
8051
|
-
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8054
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Balance>, unknown>>>;
|
|
8052
8055
|
/**
|
|
8053
8056
|
* **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
8057
|
* @summary Get account detail
|
|
@@ -8057,7 +8060,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8057
8060
|
* @deprecated
|
|
8058
8061
|
* @throws {RequiredError}
|
|
8059
8062
|
*/
|
|
8060
|
-
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8063
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Account, unknown>>>;
|
|
8061
8064
|
/**
|
|
8062
8065
|
* 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
8066
|
* @summary Get account order detail
|
|
@@ -8065,7 +8068,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8065
8068
|
* @param {*} [options] Override http request option.
|
|
8066
8069
|
* @throws {RequiredError}
|
|
8067
8070
|
*/
|
|
8068
|
-
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8071
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
8069
8072
|
/**
|
|
8070
8073
|
* 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
8074
|
* @summary List account orders
|
|
@@ -8073,7 +8076,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8073
8076
|
* @param {*} [options] Override http request option.
|
|
8074
8077
|
* @throws {RequiredError}
|
|
8075
8078
|
*/
|
|
8076
|
-
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8079
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AccountOrderRecord>, unknown>>>;
|
|
8077
8080
|
/**
|
|
8078
8081
|
* 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
8082
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8081,7 +8084,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8081
8084
|
* @param {*} [options] Override http request option.
|
|
8082
8085
|
* @throws {RequiredError}
|
|
8083
8086
|
*/
|
|
8084
|
-
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8087
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RecentOrdersResponse, unknown>>>;
|
|
8085
8088
|
/**
|
|
8086
8089
|
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8087
8090
|
* @summary List account rate of returns
|
|
@@ -8089,7 +8092,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8089
8092
|
* @param {*} [options] Override http request option.
|
|
8090
8093
|
* @throws {RequiredError}
|
|
8091
8094
|
*/
|
|
8092
|
-
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8095
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RateOfReturnResponse, unknown>>>;
|
|
8093
8096
|
/**
|
|
8094
8097
|
* **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
8098
|
* @summary List account holdings
|
|
@@ -8098,7 +8101,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8098
8101
|
* @deprecated
|
|
8099
8102
|
* @throws {RequiredError}
|
|
8100
8103
|
*/
|
|
8101
|
-
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8104
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountHoldingsAccount, unknown>>>;
|
|
8102
8105
|
/**
|
|
8103
8106
|
* 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
8107
|
* @summary List all user accounts
|
|
@@ -8106,7 +8109,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8106
8109
|
* @param {*} [options] Override http request option.
|
|
8107
8110
|
* @throws {RequiredError}
|
|
8108
8111
|
*/
|
|
8109
|
-
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8112
|
+
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AllUserAccountsResponse, unknown>>>;
|
|
8110
8113
|
/**
|
|
8111
8114
|
* **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
8115
|
* @summary List user accounts
|
|
@@ -8115,7 +8118,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8115
8118
|
* @deprecated
|
|
8116
8119
|
* @throws {RequiredError}
|
|
8117
8120
|
*/
|
|
8118
|
-
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8121
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Account>, unknown>>>;
|
|
8119
8122
|
/**
|
|
8120
8123
|
* Updates various properties of a specified account.
|
|
8121
8124
|
* @summary Update details of an investment account
|
|
@@ -8123,7 +8126,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
8123
8126
|
* @param {*} [options] Override http request option.
|
|
8124
8127
|
* @throws {RequiredError}
|
|
8125
8128
|
*/
|
|
8126
|
-
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8129
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Account>, unknown>>>;
|
|
8127
8130
|
};
|
|
8128
8131
|
/**
|
|
8129
8132
|
* AccountInformationApi - factory interface
|
|
@@ -8137,7 +8140,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8137
8140
|
* @param {*} [options] Override http request option.
|
|
8138
8141
|
* @throws {RequiredError}
|
|
8139
8142
|
*/
|
|
8140
|
-
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>):
|
|
8143
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<AxiosResponse<PaginatedUniversalActivity, unknown>>;
|
|
8141
8144
|
/**
|
|
8142
8145
|
* 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
8146
|
* @summary List historical account total value
|
|
@@ -8145,7 +8148,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8145
8148
|
* @param {*} [options] Override http request option.
|
|
8146
8149
|
* @throws {RequiredError}
|
|
8147
8150
|
*/
|
|
8148
|
-
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>):
|
|
8151
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<AxiosResponse<AccountValueHistoryResponse, unknown>>;
|
|
8149
8152
|
/**
|
|
8150
8153
|
* 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
8154
|
* @summary Get account details
|
|
@@ -8153,7 +8156,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8153
8156
|
* @param {*} [options] Override http request option.
|
|
8154
8157
|
* @throws {RequiredError}
|
|
8155
8158
|
*/
|
|
8156
|
-
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>):
|
|
8159
|
+
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccount, unknown>>;
|
|
8157
8160
|
/**
|
|
8158
8161
|
* 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
8162
|
* @summary List all account positions
|
|
@@ -8161,7 +8164,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8161
8164
|
* @param {*} [options] Override http request option.
|
|
8162
8165
|
* @throws {RequiredError}
|
|
8163
8166
|
*/
|
|
8164
|
-
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>):
|
|
8167
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<AxiosResponse<AllAccountPositionsResponse, unknown>>;
|
|
8165
8168
|
/**
|
|
8166
8169
|
* 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
8170
|
* @summary List account balances
|
|
@@ -8169,7 +8172,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8169
8172
|
* @param {*} [options] Override http request option.
|
|
8170
8173
|
* @throws {RequiredError}
|
|
8171
8174
|
*/
|
|
8172
|
-
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>):
|
|
8175
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<AxiosResponse<Array<Balance>, unknown>>;
|
|
8173
8176
|
/**
|
|
8174
8177
|
* **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
8178
|
* @summary Get account detail
|
|
@@ -8178,7 +8181,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8178
8181
|
* @deprecated
|
|
8179
8182
|
* @throws {RequiredError}
|
|
8180
8183
|
*/
|
|
8181
|
-
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>):
|
|
8184
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<AxiosResponse<Account, unknown>>;
|
|
8182
8185
|
/**
|
|
8183
8186
|
* 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
8187
|
* @summary Get account order detail
|
|
@@ -8186,7 +8189,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8186
8189
|
* @param {*} [options] Override http request option.
|
|
8187
8190
|
* @throws {RequiredError}
|
|
8188
8191
|
*/
|
|
8189
|
-
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>):
|
|
8192
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
8190
8193
|
/**
|
|
8191
8194
|
* 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
8195
|
* @summary List account orders
|
|
@@ -8194,7 +8197,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8194
8197
|
* @param {*} [options] Override http request option.
|
|
8195
8198
|
* @throws {RequiredError}
|
|
8196
8199
|
*/
|
|
8197
|
-
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>):
|
|
8200
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<AxiosResponse<Array<AccountOrderRecord>, unknown>>;
|
|
8198
8201
|
/**
|
|
8199
8202
|
* 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
8203
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8202,7 +8205,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8202
8205
|
* @param {*} [options] Override http request option.
|
|
8203
8206
|
* @throws {RequiredError}
|
|
8204
8207
|
*/
|
|
8205
|
-
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>):
|
|
8208
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<AxiosResponse<RecentOrdersResponse, unknown>>;
|
|
8206
8209
|
/**
|
|
8207
8210
|
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8208
8211
|
* @summary List account rate of returns
|
|
@@ -8210,7 +8213,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8210
8213
|
* @param {*} [options] Override http request option.
|
|
8211
8214
|
* @throws {RequiredError}
|
|
8212
8215
|
*/
|
|
8213
|
-
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>):
|
|
8216
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown>>;
|
|
8214
8217
|
/**
|
|
8215
8218
|
* **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
8219
|
* @summary List account holdings
|
|
@@ -8219,7 +8222,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8219
8222
|
* @deprecated
|
|
8220
8223
|
* @throws {RequiredError}
|
|
8221
8224
|
*/
|
|
8222
|
-
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>):
|
|
8225
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<AxiosResponse<AccountHoldingsAccount, unknown>>;
|
|
8223
8226
|
/**
|
|
8224
8227
|
* 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
8228
|
* @summary List all user accounts
|
|
@@ -8227,7 +8230,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8227
8230
|
* @param {*} [options] Override http request option.
|
|
8228
8231
|
* @throws {RequiredError}
|
|
8229
8232
|
*/
|
|
8230
|
-
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>):
|
|
8233
|
+
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<AxiosResponse<AllUserAccountsResponse, unknown>>;
|
|
8231
8234
|
/**
|
|
8232
8235
|
* **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
8236
|
* @summary List user accounts
|
|
@@ -8236,7 +8239,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8236
8239
|
* @deprecated
|
|
8237
8240
|
* @throws {RequiredError}
|
|
8238
8241
|
*/
|
|
8239
|
-
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>):
|
|
8242
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<AxiosResponse<Array<Account>, unknown>>;
|
|
8240
8243
|
/**
|
|
8241
8244
|
* Updates various properties of a specified account.
|
|
8242
8245
|
* @summary Update details of an investment account
|
|
@@ -8244,7 +8247,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8244
8247
|
* @param {*} [options] Override http request option.
|
|
8245
8248
|
* @throws {RequiredError}
|
|
8246
8249
|
*/
|
|
8247
|
-
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>):
|
|
8250
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<AxiosResponse<Array<Account>, unknown>>;
|
|
8248
8251
|
};
|
|
8249
8252
|
/**
|
|
8250
8253
|
* Request parameters for getAccountActivities operation in AccountInformationApi.
|
|
@@ -8679,7 +8682,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8679
8682
|
* @throws {RequiredError}
|
|
8680
8683
|
* @memberof AccountInformationApiGenerated
|
|
8681
8684
|
*/
|
|
8682
|
-
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<
|
|
8685
|
+
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<AxiosResponse<PaginatedUniversalActivity, unknown, {}, any>>;
|
|
8683
8686
|
/**
|
|
8684
8687
|
* 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
8688
|
* @summary List historical account total value
|
|
@@ -8688,7 +8691,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8688
8691
|
* @throws {RequiredError}
|
|
8689
8692
|
* @memberof AccountInformationApiGenerated
|
|
8690
8693
|
*/
|
|
8691
|
-
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<
|
|
8694
|
+
getAccountBalanceHistory(...args: AccountInformationApiGetAccountBalanceHistoryArgs<TAuth>): Promise<AxiosResponse<AccountValueHistoryResponse, unknown, {}, any>>;
|
|
8692
8695
|
/**
|
|
8693
8696
|
* 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
8697
|
* @summary Get account details
|
|
@@ -8697,7 +8700,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8697
8700
|
* @throws {RequiredError}
|
|
8698
8701
|
* @memberof AccountInformationApiGenerated
|
|
8699
8702
|
*/
|
|
8700
|
-
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<
|
|
8703
|
+
getAccountDetails(...args: AccountInformationApiGetAccountDetailsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccount, unknown, {}, any>>;
|
|
8701
8704
|
/**
|
|
8702
8705
|
* 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
8706
|
* @summary List all account positions
|
|
@@ -8706,7 +8709,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8706
8709
|
* @throws {RequiredError}
|
|
8707
8710
|
* @memberof AccountInformationApiGenerated
|
|
8708
8711
|
*/
|
|
8709
|
-
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<
|
|
8712
|
+
getAllAccountPositions(...args: AccountInformationApiGetAllAccountPositionsArgs<TAuth>): Promise<AxiosResponse<AllAccountPositionsResponse, unknown, {}, any>>;
|
|
8710
8713
|
/**
|
|
8711
8714
|
* 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
8715
|
* @summary List account balances
|
|
@@ -8715,7 +8718,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8715
8718
|
* @throws {RequiredError}
|
|
8716
8719
|
* @memberof AccountInformationApiGenerated
|
|
8717
8720
|
*/
|
|
8718
|
-
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<
|
|
8721
|
+
getUserAccountBalance(...args: AccountInformationApiGetUserAccountBalanceArgs<TAuth>): Promise<AxiosResponse<Balance[], unknown, {}, any>>;
|
|
8719
8722
|
/**
|
|
8720
8723
|
* **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
8724
|
* @summary Get account detail
|
|
@@ -8725,7 +8728,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8725
8728
|
* @throws {RequiredError}
|
|
8726
8729
|
* @memberof AccountInformationApiGenerated
|
|
8727
8730
|
*/
|
|
8728
|
-
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<
|
|
8731
|
+
getUserAccountDetails(...args: AccountInformationApiGetUserAccountDetailsArgs<TAuth>): Promise<AxiosResponse<Account, unknown, {}, any>>;
|
|
8729
8732
|
/**
|
|
8730
8733
|
* 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
8734
|
* @summary Get account order detail
|
|
@@ -8734,7 +8737,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8734
8737
|
* @throws {RequiredError}
|
|
8735
8738
|
* @memberof AccountInformationApiGenerated
|
|
8736
8739
|
*/
|
|
8737
|
-
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<
|
|
8740
|
+
getUserAccountOrderDetail(...args: AccountInformationApiGetUserAccountOrderDetailArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
8738
8741
|
/**
|
|
8739
8742
|
* 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
8743
|
* @summary List account orders
|
|
@@ -8743,7 +8746,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8743
8746
|
* @throws {RequiredError}
|
|
8744
8747
|
* @memberof AccountInformationApiGenerated
|
|
8745
8748
|
*/
|
|
8746
|
-
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<
|
|
8749
|
+
getUserAccountOrders(...args: AccountInformationApiGetUserAccountOrdersArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord[], unknown, {}, any>>;
|
|
8747
8750
|
/**
|
|
8748
8751
|
* 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
8752
|
* @summary List account recent orders (last 24 hours only)
|
|
@@ -8752,7 +8755,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8752
8755
|
* @throws {RequiredError}
|
|
8753
8756
|
* @memberof AccountInformationApiGenerated
|
|
8754
8757
|
*/
|
|
8755
|
-
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<
|
|
8758
|
+
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<AxiosResponse<RecentOrdersResponse, unknown, {}, any>>;
|
|
8756
8759
|
/**
|
|
8757
8760
|
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8758
8761
|
* @summary List account rate of returns
|
|
@@ -8761,7 +8764,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8761
8764
|
* @throws {RequiredError}
|
|
8762
8765
|
* @memberof AccountInformationApiGenerated
|
|
8763
8766
|
*/
|
|
8764
|
-
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<
|
|
8767
|
+
getUserAccountReturnRates(...args: AccountInformationApiGetUserAccountReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown, {}, any>>;
|
|
8765
8768
|
/**
|
|
8766
8769
|
* **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
8770
|
* @summary List account holdings
|
|
@@ -8771,7 +8774,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8771
8774
|
* @throws {RequiredError}
|
|
8772
8775
|
* @memberof AccountInformationApiGenerated
|
|
8773
8776
|
*/
|
|
8774
|
-
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<
|
|
8777
|
+
getUserHoldings(...args: AccountInformationApiGetUserHoldingsArgs<TAuth>): Promise<AxiosResponse<AccountHoldingsAccount, unknown, {}, any>>;
|
|
8775
8778
|
/**
|
|
8776
8779
|
* 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
8780
|
* @summary List all user accounts
|
|
@@ -8780,7 +8783,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8780
8783
|
* @throws {RequiredError}
|
|
8781
8784
|
* @memberof AccountInformationApiGenerated
|
|
8782
8785
|
*/
|
|
8783
|
-
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<
|
|
8786
|
+
listAllUserAccounts(...args: AccountInformationApiListAllUserAccountsArgs<TAuth>): Promise<AxiosResponse<AllUserAccountsResponse, unknown, {}, any>>;
|
|
8784
8787
|
/**
|
|
8785
8788
|
* **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
8789
|
* @summary List user accounts
|
|
@@ -8790,7 +8793,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8790
8793
|
* @throws {RequiredError}
|
|
8791
8794
|
* @memberof AccountInformationApiGenerated
|
|
8792
8795
|
*/
|
|
8793
|
-
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<
|
|
8796
|
+
listUserAccounts(...args: AccountInformationApiListUserAccountsArgs<TAuth>): Promise<AxiosResponse<Account[], unknown, {}, any>>;
|
|
8794
8797
|
/**
|
|
8795
8798
|
* Updates various properties of a specified account.
|
|
8796
8799
|
* @summary Update details of an investment account
|
|
@@ -8799,7 +8802,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8799
8802
|
* @throws {RequiredError}
|
|
8800
8803
|
* @memberof AccountInformationApiGenerated
|
|
8801
8804
|
*/
|
|
8802
|
-
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<
|
|
8805
|
+
updateUserAccount(...args: AccountInformationApiUpdateUserAccountArgs<TAuth>): Promise<AxiosResponse<Account[], unknown, {}, any>>;
|
|
8803
8806
|
}
|
|
8804
8807
|
//#endregion
|
|
8805
8808
|
//#region api/account-information-api.d.ts
|
|
@@ -8830,7 +8833,7 @@ declare const ApiStatusApiFp: <TAuth extends AuthMode>(configuration?: Configura
|
|
|
8830
8833
|
* @param {*} [options] Override http request option.
|
|
8831
8834
|
* @throws {RequiredError}
|
|
8832
8835
|
*/
|
|
8833
|
-
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8836
|
+
check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Status, unknown>>>;
|
|
8834
8837
|
};
|
|
8835
8838
|
/**
|
|
8836
8839
|
* ApiStatusApi - factory interface
|
|
@@ -8843,7 +8846,7 @@ declare const ApiStatusApiFactory: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8843
8846
|
* @param {*} [options] Override http request option.
|
|
8844
8847
|
* @throws {RequiredError}
|
|
8845
8848
|
*/
|
|
8846
|
-
check(options?: AxiosRequestConfig):
|
|
8849
|
+
check(options?: AxiosRequestConfig): Promise<AxiosResponse<Status, unknown>>;
|
|
8847
8850
|
};
|
|
8848
8851
|
/**
|
|
8849
8852
|
* ApiStatusApiGenerated - object-oriented interface
|
|
@@ -8859,7 +8862,7 @@ declare class ApiStatusApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAut
|
|
|
8859
8862
|
* @throws {RequiredError}
|
|
8860
8863
|
* @memberof ApiStatusApiGenerated
|
|
8861
8864
|
*/
|
|
8862
|
-
check(options?: AxiosRequestConfig): Promise<
|
|
8865
|
+
check(options?: AxiosRequestConfig): Promise<AxiosResponse<Status, unknown, {}, any>>;
|
|
8863
8866
|
}
|
|
8864
8867
|
//#endregion
|
|
8865
8868
|
//#region api/api-status-api.d.ts
|
|
@@ -8925,14 +8928,14 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8925
8928
|
* @param {*} [options] Override http request option.
|
|
8926
8929
|
* @throws {RequiredError}
|
|
8927
8930
|
*/
|
|
8928
|
-
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8931
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeleteUserResponse, unknown>>>;
|
|
8929
8932
|
/**
|
|
8930
8933
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8931
8934
|
* @summary List all users
|
|
8932
8935
|
* @param {*} [options] Override http request option.
|
|
8933
8936
|
* @throws {RequiredError}
|
|
8934
8937
|
*/
|
|
8935
|
-
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8938
|
+
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<string>, unknown>>>;
|
|
8936
8939
|
/**
|
|
8937
8940
|
* 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
8941
|
* @summary Generate Connection Portal URL
|
|
@@ -8940,7 +8943,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8940
8943
|
* @param {*} [options] Override http request option.
|
|
8941
8944
|
* @throws {RequiredError}
|
|
8942
8945
|
*/
|
|
8943
|
-
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8946
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AuthenticationLoginSnapTradeUser200Response, unknown>>>;
|
|
8944
8947
|
/**
|
|
8945
8948
|
* 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
8949
|
* @summary Register user
|
|
@@ -8948,7 +8951,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8948
8951
|
* @param {*} [options] Override http request option.
|
|
8949
8952
|
* @throws {RequiredError}
|
|
8950
8953
|
*/
|
|
8951
|
-
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8954
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserIDandSecret, unknown>>>;
|
|
8952
8955
|
/**
|
|
8953
8956
|
* 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
8957
|
* @summary Rotate user secret
|
|
@@ -8956,7 +8959,7 @@ declare const AuthenticationApiFp: <TAuth extends AuthMode>(configuration?: Conf
|
|
|
8956
8959
|
* @param {*} [options] Override http request option.
|
|
8957
8960
|
* @throws {RequiredError}
|
|
8958
8961
|
*/
|
|
8959
|
-
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
8962
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserIDandSecret, unknown>>>;
|
|
8960
8963
|
};
|
|
8961
8964
|
/**
|
|
8962
8965
|
* AuthenticationApi - factory interface
|
|
@@ -8970,14 +8973,14 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8970
8973
|
* @param {*} [options] Override http request option.
|
|
8971
8974
|
* @throws {RequiredError}
|
|
8972
8975
|
*/
|
|
8973
|
-
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>):
|
|
8976
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<DeleteUserResponse, unknown>>;
|
|
8974
8977
|
/**
|
|
8975
8978
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
8976
8979
|
* @summary List all users
|
|
8977
8980
|
* @param {*} [options] Override http request option.
|
|
8978
8981
|
* @throws {RequiredError}
|
|
8979
8982
|
*/
|
|
8980
|
-
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
8983
|
+
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<string>, unknown>>;
|
|
8981
8984
|
/**
|
|
8982
8985
|
* 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
8986
|
* @summary Generate Connection Portal URL
|
|
@@ -8985,7 +8988,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8985
8988
|
* @param {*} [options] Override http request option.
|
|
8986
8989
|
* @throws {RequiredError}
|
|
8987
8990
|
*/
|
|
8988
|
-
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>):
|
|
8991
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<AuthenticationLoginSnapTradeUser200Response, unknown>>;
|
|
8989
8992
|
/**
|
|
8990
8993
|
* 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
8994
|
* @summary Register user
|
|
@@ -8993,7 +8996,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
8993
8996
|
* @param {*} [options] Override http request option.
|
|
8994
8997
|
* @throws {RequiredError}
|
|
8995
8998
|
*/
|
|
8996
|
-
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>):
|
|
8999
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown>>;
|
|
8997
9000
|
/**
|
|
8998
9001
|
* 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
9002
|
* @summary Rotate user secret
|
|
@@ -9001,7 +9004,7 @@ declare const AuthenticationApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
9001
9004
|
* @param {*} [options] Override http request option.
|
|
9002
9005
|
* @throws {RequiredError}
|
|
9003
9006
|
*/
|
|
9004
|
-
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>):
|
|
9007
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown>>;
|
|
9005
9008
|
};
|
|
9006
9009
|
/**
|
|
9007
9010
|
* Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
|
|
@@ -9076,7 +9079,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9076
9079
|
* @throws {RequiredError}
|
|
9077
9080
|
* @memberof AuthenticationApiGenerated
|
|
9078
9081
|
*/
|
|
9079
|
-
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<
|
|
9082
|
+
deleteSnapTradeUser(...args: AuthenticationApiDeleteSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<DeleteUserResponse, unknown, {}, any>>;
|
|
9080
9083
|
/**
|
|
9081
9084
|
* Returns a list of all registered user IDs. Please note that the response is not currently paginated.
|
|
9082
9085
|
* @summary List all users
|
|
@@ -9084,7 +9087,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9084
9087
|
* @throws {RequiredError}
|
|
9085
9088
|
* @memberof AuthenticationApiGenerated
|
|
9086
9089
|
*/
|
|
9087
|
-
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
9090
|
+
listSnapTradeUsers(...args: TAuth["mode"] extends "commercialApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<string[], unknown, {}, any>>;
|
|
9088
9091
|
/**
|
|
9089
9092
|
* 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
9093
|
* @summary Generate Connection Portal URL
|
|
@@ -9093,7 +9096,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9093
9096
|
* @throws {RequiredError}
|
|
9094
9097
|
* @memberof AuthenticationApiGenerated
|
|
9095
9098
|
*/
|
|
9096
|
-
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<
|
|
9099
|
+
loginSnapTradeUser(...args: AuthenticationApiLoginSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<AuthenticationLoginSnapTradeUser200Response, unknown, {}, any>>;
|
|
9097
9100
|
/**
|
|
9098
9101
|
* 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
9102
|
* @summary Register user
|
|
@@ -9102,7 +9105,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9102
9105
|
* @throws {RequiredError}
|
|
9103
9106
|
* @memberof AuthenticationApiGenerated
|
|
9104
9107
|
*/
|
|
9105
|
-
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<
|
|
9108
|
+
registerSnapTradeUser(...args: AuthenticationApiRegisterSnapTradeUserArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown, {}, any>>;
|
|
9106
9109
|
/**
|
|
9107
9110
|
* 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
9111
|
* @summary Rotate user secret
|
|
@@ -9111,7 +9114,7 @@ declare class AuthenticationApiGenerated<TAuth extends AuthMode> extends BaseAPI
|
|
|
9111
9114
|
* @throws {RequiredError}
|
|
9112
9115
|
* @memberof AuthenticationApiGenerated
|
|
9113
9116
|
*/
|
|
9114
|
-
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<
|
|
9117
|
+
resetSnapTradeUserSecret(...args: AuthenticationApiResetSnapTradeUserSecretArgs<TAuth>): Promise<AxiosResponse<UserIDandSecret, unknown, {}, any>>;
|
|
9115
9118
|
}
|
|
9116
9119
|
//#endregion
|
|
9117
9120
|
//#region api/authentication-api.d.ts
|
|
@@ -9226,7 +9229,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9226
9229
|
* @param {*} [options] Override http request option.
|
|
9227
9230
|
* @throws {RequiredError}
|
|
9228
9231
|
*/
|
|
9229
|
-
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9232
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeleteConnectionConfirmation, unknown>>>;
|
|
9230
9233
|
/**
|
|
9231
9234
|
* Returns a single connection for the specified ID.
|
|
9232
9235
|
* @summary Get connection detail
|
|
@@ -9234,7 +9237,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9234
9237
|
* @param {*} [options] Override http request option.
|
|
9235
9238
|
* @throws {RequiredError}
|
|
9236
9239
|
*/
|
|
9237
|
-
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9240
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorization, unknown>>>;
|
|
9238
9241
|
/**
|
|
9239
9242
|
* 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
9243
|
* @summary Force disable connection
|
|
@@ -9242,7 +9245,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9242
9245
|
* @param {*} [options] Override http request option.
|
|
9243
9246
|
* @throws {RequiredError}
|
|
9244
9247
|
*/
|
|
9245
|
-
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9248
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorizationDisabledConfirmation, unknown>>>;
|
|
9246
9249
|
/**
|
|
9247
9250
|
* 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
9251
|
* @summary List accounts for a connection
|
|
@@ -9250,7 +9253,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9250
9253
|
* @param {*} [options] Override http request option.
|
|
9251
9254
|
* @throws {RequiredError}
|
|
9252
9255
|
*/
|
|
9253
|
-
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9256
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Account>, unknown>>>;
|
|
9254
9257
|
/**
|
|
9255
9258
|
* 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
9259
|
* @summary List all connections
|
|
@@ -9258,7 +9261,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9258
9261
|
* @param {*} [options] Override http request option.
|
|
9259
9262
|
* @throws {RequiredError}
|
|
9260
9263
|
*/
|
|
9261
|
-
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9264
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<BrokerageAuthorization>, unknown>>>;
|
|
9262
9265
|
/**
|
|
9263
9266
|
* 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
9267
|
* @summary List accounts
|
|
@@ -9266,7 +9269,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9266
9269
|
* @param {*} [options] Override http request option.
|
|
9267
9270
|
* @throws {RequiredError}
|
|
9268
9271
|
*/
|
|
9269
|
-
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9272
|
+
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ConnectionAccountsResponse, unknown>>>;
|
|
9270
9273
|
/**
|
|
9271
9274
|
* 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
9275
|
* @summary Refresh holdings for a connection
|
|
@@ -9274,7 +9277,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9274
9277
|
* @param {*} [options] Override http request option.
|
|
9275
9278
|
* @throws {RequiredError}
|
|
9276
9279
|
*/
|
|
9277
|
-
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9280
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorizationRefreshConfirmation, unknown>>>;
|
|
9278
9281
|
/**
|
|
9279
9282
|
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9280
9283
|
* @summary List connection rate of returns
|
|
@@ -9282,7 +9285,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9282
9285
|
* @param {*} [options] Override http request option.
|
|
9283
9286
|
* @throws {RequiredError}
|
|
9284
9287
|
*/
|
|
9285
|
-
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9288
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<RateOfReturnResponse, unknown>>>;
|
|
9286
9289
|
/**
|
|
9287
9290
|
* 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
9291
|
* @summary Sync transactions for a connection
|
|
@@ -9290,7 +9293,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9290
9293
|
* @param {*} [options] Override http request option.
|
|
9291
9294
|
* @throws {RequiredError}
|
|
9292
9295
|
*/
|
|
9293
|
-
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9296
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, unknown>>>;
|
|
9294
9297
|
};
|
|
9295
9298
|
/**
|
|
9296
9299
|
* ConnectionsApi - factory interface
|
|
@@ -9304,7 +9307,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9304
9307
|
* @param {*} [options] Override http request option.
|
|
9305
9308
|
* @throws {RequiredError}
|
|
9306
9309
|
*/
|
|
9307
|
-
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>):
|
|
9310
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<AxiosResponse<DeleteConnectionConfirmation, unknown>>;
|
|
9308
9311
|
/**
|
|
9309
9312
|
* Returns a single connection for the specified ID.
|
|
9310
9313
|
* @summary Get connection detail
|
|
@@ -9312,7 +9315,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9312
9315
|
* @param {*} [options] Override http request option.
|
|
9313
9316
|
* @throws {RequiredError}
|
|
9314
9317
|
*/
|
|
9315
|
-
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>):
|
|
9318
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorization, unknown>>;
|
|
9316
9319
|
/**
|
|
9317
9320
|
* 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
9321
|
* @summary Force disable connection
|
|
@@ -9320,7 +9323,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9320
9323
|
* @param {*} [options] Override http request option.
|
|
9321
9324
|
* @throws {RequiredError}
|
|
9322
9325
|
*/
|
|
9323
|
-
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>):
|
|
9326
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationDisabledConfirmation, unknown>>;
|
|
9324
9327
|
/**
|
|
9325
9328
|
* 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
9329
|
* @summary List accounts for a connection
|
|
@@ -9328,7 +9331,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9328
9331
|
* @param {*} [options] Override http request option.
|
|
9329
9332
|
* @throws {RequiredError}
|
|
9330
9333
|
*/
|
|
9331
|
-
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>):
|
|
9334
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<AxiosResponse<Array<Account>, unknown>>;
|
|
9332
9335
|
/**
|
|
9333
9336
|
* 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
9337
|
* @summary List all connections
|
|
@@ -9336,7 +9339,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9336
9339
|
* @param {*} [options] Override http request option.
|
|
9337
9340
|
* @throws {RequiredError}
|
|
9338
9341
|
*/
|
|
9339
|
-
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>):
|
|
9342
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<AxiosResponse<Array<BrokerageAuthorization>, unknown>>;
|
|
9340
9343
|
/**
|
|
9341
9344
|
* 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
9345
|
* @summary List accounts
|
|
@@ -9344,7 +9347,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9344
9347
|
* @param {*} [options] Override http request option.
|
|
9345
9348
|
* @throws {RequiredError}
|
|
9346
9349
|
*/
|
|
9347
|
-
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>):
|
|
9350
|
+
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccountsResponse, unknown>>;
|
|
9348
9351
|
/**
|
|
9349
9352
|
* 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
9353
|
* @summary Refresh holdings for a connection
|
|
@@ -9352,7 +9355,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9352
9355
|
* @param {*} [options] Override http request option.
|
|
9353
9356
|
* @throws {RequiredError}
|
|
9354
9357
|
*/
|
|
9355
|
-
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>):
|
|
9358
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationRefreshConfirmation, unknown>>;
|
|
9356
9359
|
/**
|
|
9357
9360
|
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9358
9361
|
* @summary List connection rate of returns
|
|
@@ -9360,7 +9363,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9360
9363
|
* @param {*} [options] Override http request option.
|
|
9361
9364
|
* @throws {RequiredError}
|
|
9362
9365
|
*/
|
|
9363
|
-
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>):
|
|
9366
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown>>;
|
|
9364
9367
|
/**
|
|
9365
9368
|
* 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
9369
|
* @summary Sync transactions for a connection
|
|
@@ -9368,7 +9371,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9368
9371
|
* @param {*} [options] Override http request option.
|
|
9369
9372
|
* @throws {RequiredError}
|
|
9370
9373
|
*/
|
|
9371
|
-
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>):
|
|
9374
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, unknown>>;
|
|
9372
9375
|
};
|
|
9373
9376
|
/**
|
|
9374
9377
|
* Request parameters for deleteConnection operation in ConnectionsApi.
|
|
@@ -9627,7 +9630,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9627
9630
|
* @throws {RequiredError}
|
|
9628
9631
|
* @memberof ConnectionsApiGenerated
|
|
9629
9632
|
*/
|
|
9630
|
-
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<
|
|
9633
|
+
deleteConnection(...args: ConnectionsApiDeleteConnectionArgs<TAuth>): Promise<AxiosResponse<DeleteConnectionConfirmation, unknown, {}, any>>;
|
|
9631
9634
|
/**
|
|
9632
9635
|
* Returns a single connection for the specified ID.
|
|
9633
9636
|
* @summary Get connection detail
|
|
@@ -9636,7 +9639,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9636
9639
|
* @throws {RequiredError}
|
|
9637
9640
|
* @memberof ConnectionsApiGenerated
|
|
9638
9641
|
*/
|
|
9639
|
-
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<
|
|
9642
|
+
detailBrokerageAuthorization(...args: ConnectionsApiDetailBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorization, unknown, {}, any>>;
|
|
9640
9643
|
/**
|
|
9641
9644
|
* 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
9645
|
* @summary Force disable connection
|
|
@@ -9645,7 +9648,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9645
9648
|
* @throws {RequiredError}
|
|
9646
9649
|
* @memberof ConnectionsApiGenerated
|
|
9647
9650
|
*/
|
|
9648
|
-
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<
|
|
9651
|
+
disableBrokerageAuthorization(...args: ConnectionsApiDisableBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationDisabledConfirmation, unknown, {}, any>>;
|
|
9649
9652
|
/**
|
|
9650
9653
|
* 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
9654
|
* @summary List accounts for a connection
|
|
@@ -9654,7 +9657,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9654
9657
|
* @throws {RequiredError}
|
|
9655
9658
|
* @memberof ConnectionsApiGenerated
|
|
9656
9659
|
*/
|
|
9657
|
-
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<
|
|
9660
|
+
listBrokerageAuthorizationAccounts(...args: ConnectionsApiListBrokerageAuthorizationAccountsArgs<TAuth>): Promise<AxiosResponse<Account[], unknown, {}, any>>;
|
|
9658
9661
|
/**
|
|
9659
9662
|
* 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
9663
|
* @summary List all connections
|
|
@@ -9663,7 +9666,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9663
9666
|
* @throws {RequiredError}
|
|
9664
9667
|
* @memberof ConnectionsApiGenerated
|
|
9665
9668
|
*/
|
|
9666
|
-
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<
|
|
9669
|
+
listBrokerageAuthorizations(...args: ConnectionsApiListBrokerageAuthorizationsArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorization[], unknown, {}, any>>;
|
|
9667
9670
|
/**
|
|
9668
9671
|
* 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
9672
|
* @summary List accounts
|
|
@@ -9672,7 +9675,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9672
9675
|
* @throws {RequiredError}
|
|
9673
9676
|
* @memberof ConnectionsApiGenerated
|
|
9674
9677
|
*/
|
|
9675
|
-
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<
|
|
9678
|
+
listConnectionAccounts(...args: ConnectionsApiListConnectionAccountsArgs<TAuth>): Promise<AxiosResponse<ConnectionAccountsResponse, unknown, {}, any>>;
|
|
9676
9679
|
/**
|
|
9677
9680
|
* 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
9681
|
* @summary Refresh holdings for a connection
|
|
@@ -9681,7 +9684,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9681
9684
|
* @throws {RequiredError}
|
|
9682
9685
|
* @memberof ConnectionsApiGenerated
|
|
9683
9686
|
*/
|
|
9684
|
-
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<
|
|
9687
|
+
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationRefreshConfirmation, unknown, {}, any>>;
|
|
9685
9688
|
/**
|
|
9686
9689
|
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9687
9690
|
* @summary List connection rate of returns
|
|
@@ -9690,7 +9693,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9690
9693
|
* @throws {RequiredError}
|
|
9691
9694
|
* @memberof ConnectionsApiGenerated
|
|
9692
9695
|
*/
|
|
9693
|
-
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<
|
|
9696
|
+
returnRates(...args: ConnectionsApiReturnRatesArgs<TAuth>): Promise<AxiosResponse<RateOfReturnResponse, unknown, {}, any>>;
|
|
9694
9697
|
/**
|
|
9695
9698
|
* 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
9699
|
* @summary Sync transactions for a connection
|
|
@@ -9699,7 +9702,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9699
9702
|
* @throws {RequiredError}
|
|
9700
9703
|
* @memberof ConnectionsApiGenerated
|
|
9701
9704
|
*/
|
|
9702
|
-
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<
|
|
9705
|
+
syncBrokerageAuthorizationTransactions(...args: ConnectionsApiSyncBrokerageAuthorizationTransactionsArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, unknown, {}, any>>;
|
|
9703
9706
|
}
|
|
9704
9707
|
//#endregion
|
|
9705
9708
|
//#region api/connections-api.d.ts
|
|
@@ -9794,7 +9797,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9794
9797
|
* @param {*} [options] Override http request option.
|
|
9795
9798
|
* @throws {RequiredError}
|
|
9796
9799
|
*/
|
|
9797
|
-
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9800
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TradeDetectionSubscription, unknown>>>;
|
|
9798
9801
|
/**
|
|
9799
9802
|
* 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
9803
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9802,7 +9805,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9802
9805
|
* @param {*} [options] Override http request option.
|
|
9803
9806
|
* @throws {RequiredError}
|
|
9804
9807
|
*/
|
|
9805
|
-
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9808
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TradeDetectionCancelSubscriptionResponse, unknown>>>;
|
|
9806
9809
|
/**
|
|
9807
9810
|
* 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
9811
|
* @summary Get account order detail (V2)
|
|
@@ -9810,7 +9813,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9810
9813
|
* @param {*} [options] Override http request option.
|
|
9811
9814
|
* @throws {RequiredError}
|
|
9812
9815
|
*/
|
|
9813
|
-
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9816
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecordV2, unknown>>>;
|
|
9814
9817
|
/**
|
|
9815
9818
|
* 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
9819
|
* @summary List account orders v2
|
|
@@ -9818,7 +9821,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9818
9821
|
* @param {*} [options] Override http request option.
|
|
9819
9822
|
* @throws {RequiredError}
|
|
9820
9823
|
*/
|
|
9821
|
-
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9824
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrdersV2Response, unknown>>>;
|
|
9822
9825
|
/**
|
|
9823
9826
|
* 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
9827
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9826,14 +9829,14 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9826
9829
|
* @param {*} [options] Override http request option.
|
|
9827
9830
|
* @throws {RequiredError}
|
|
9828
9831
|
*/
|
|
9829
|
-
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9832
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrdersV2Response, unknown>>>;
|
|
9830
9833
|
/**
|
|
9831
9834
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9832
9835
|
* @summary List active Trade Detection subscriptions
|
|
9833
9836
|
* @param {*} [options] Override http request option.
|
|
9834
9837
|
* @throws {RequiredError}
|
|
9835
9838
|
*/
|
|
9836
|
-
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9839
|
+
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<TradeDetectionSubscription>, unknown>>>;
|
|
9837
9840
|
/**
|
|
9838
9841
|
* **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
9842
|
* @summary Place a simple order (beta)
|
|
@@ -9841,7 +9844,7 @@ declare const ExperimentalEndpointsApiFp: <TAuth extends AuthMode>(configuration
|
|
|
9841
9844
|
* @param {*} [options] Override http request option.
|
|
9842
9845
|
* @throws {RequiredError}
|
|
9843
9846
|
*/
|
|
9844
|
-
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
9847
|
+
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SimpleTradeResponse, unknown>>>;
|
|
9845
9848
|
};
|
|
9846
9849
|
/**
|
|
9847
9850
|
* ExperimentalEndpointsApi - factory interface
|
|
@@ -9855,7 +9858,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9855
9858
|
* @param {*} [options] Override http request option.
|
|
9856
9859
|
* @throws {RequiredError}
|
|
9857
9860
|
*/
|
|
9858
|
-
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>):
|
|
9861
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionSubscription, unknown>>;
|
|
9859
9862
|
/**
|
|
9860
9863
|
* 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
9864
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -9863,7 +9866,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9863
9866
|
* @param {*} [options] Override http request option.
|
|
9864
9867
|
* @throws {RequiredError}
|
|
9865
9868
|
*/
|
|
9866
|
-
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>):
|
|
9869
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionCancelSubscriptionResponse, unknown>>;
|
|
9867
9870
|
/**
|
|
9868
9871
|
* 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
9872
|
* @summary Get account order detail (V2)
|
|
@@ -9871,7 +9874,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9871
9874
|
* @param {*} [options] Override http request option.
|
|
9872
9875
|
* @throws {RequiredError}
|
|
9873
9876
|
*/
|
|
9874
|
-
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>):
|
|
9877
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<AxiosResponse<AccountOrderRecordV2, unknown>>;
|
|
9875
9878
|
/**
|
|
9876
9879
|
* 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
9880
|
* @summary List account orders v2
|
|
@@ -9879,7 +9882,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9879
9882
|
* @param {*} [options] Override http request option.
|
|
9880
9883
|
* @throws {RequiredError}
|
|
9881
9884
|
*/
|
|
9882
|
-
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>):
|
|
9885
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown>>;
|
|
9883
9886
|
/**
|
|
9884
9887
|
* 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
9888
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -9887,14 +9890,14 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9887
9890
|
* @param {*} [options] Override http request option.
|
|
9888
9891
|
* @throws {RequiredError}
|
|
9889
9892
|
*/
|
|
9890
|
-
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>):
|
|
9893
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown>>;
|
|
9891
9894
|
/**
|
|
9892
9895
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
9893
9896
|
* @summary List active Trade Detection subscriptions
|
|
9894
9897
|
* @param {*} [options] Override http request option.
|
|
9895
9898
|
* @throws {RequiredError}
|
|
9896
9899
|
*/
|
|
9897
|
-
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
9900
|
+
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<TradeDetectionSubscription>, unknown>>;
|
|
9898
9901
|
/**
|
|
9899
9902
|
* **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
9903
|
* @summary Place a simple order (beta)
|
|
@@ -9902,7 +9905,7 @@ declare const ExperimentalEndpointsApiFactory: <TAuth extends AuthMode>(configur
|
|
|
9902
9905
|
* @param {*} [options] Override http request option.
|
|
9903
9906
|
* @throws {RequiredError}
|
|
9904
9907
|
*/
|
|
9905
|
-
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>):
|
|
9908
|
+
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<AxiosResponse<SimpleTradeResponse, unknown>>;
|
|
9906
9909
|
};
|
|
9907
9910
|
/**
|
|
9908
9911
|
* Request parameters for addSubscription operation in ExperimentalEndpointsApi.
|
|
@@ -10085,7 +10088,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10085
10088
|
* @throws {RequiredError}
|
|
10086
10089
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10087
10090
|
*/
|
|
10088
|
-
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<
|
|
10091
|
+
addSubscription(...args: ExperimentalEndpointsApiAddSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionSubscription, unknown, {}, any>>;
|
|
10089
10092
|
/**
|
|
10090
10093
|
* 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
10094
|
* @summary Cancel a Trade Detection subscription
|
|
@@ -10094,7 +10097,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10094
10097
|
* @throws {RequiredError}
|
|
10095
10098
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10096
10099
|
*/
|
|
10097
|
-
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<
|
|
10100
|
+
cancelSubscription(...args: ExperimentalEndpointsApiCancelSubscriptionArgs<TAuth>): Promise<AxiosResponse<TradeDetectionCancelSubscriptionResponse, unknown, {}, any>>;
|
|
10098
10101
|
/**
|
|
10099
10102
|
* 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
10103
|
* @summary Get account order detail (V2)
|
|
@@ -10103,7 +10106,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10103
10106
|
* @throws {RequiredError}
|
|
10104
10107
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10105
10108
|
*/
|
|
10106
|
-
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<
|
|
10109
|
+
getUserAccountOrderDetailV2(...args: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Args<TAuth>): Promise<AxiosResponse<AccountOrderRecordV2, unknown, {}, any>>;
|
|
10107
10110
|
/**
|
|
10108
10111
|
* 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
10112
|
* @summary List account orders v2
|
|
@@ -10112,7 +10115,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10112
10115
|
* @throws {RequiredError}
|
|
10113
10116
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10114
10117
|
*/
|
|
10115
|
-
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<
|
|
10118
|
+
getUserAccountOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown, {}, any>>;
|
|
10116
10119
|
/**
|
|
10117
10120
|
* 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
10121
|
* @summary List account recent orders (V2, last 24 hours only)
|
|
@@ -10121,7 +10124,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10121
10124
|
* @throws {RequiredError}
|
|
10122
10125
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10123
10126
|
*/
|
|
10124
|
-
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<
|
|
10127
|
+
getUserAccountRecentOrdersV2(...args: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Args<TAuth>): Promise<AxiosResponse<AccountOrdersV2Response, unknown, {}, any>>;
|
|
10125
10128
|
/**
|
|
10126
10129
|
* Returns active Trade Detection subscriptions for your Client ID. Cancelled subscriptions are not returned.
|
|
10127
10130
|
* @summary List active Trade Detection subscriptions
|
|
@@ -10129,7 +10132,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10129
10132
|
* @throws {RequiredError}
|
|
10130
10133
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10131
10134
|
*/
|
|
10132
|
-
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10135
|
+
listSubscriptions(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<TradeDetectionSubscription[], unknown, {}, any>>;
|
|
10133
10136
|
/**
|
|
10134
10137
|
* **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
10138
|
* @summary Place a simple order (beta)
|
|
@@ -10138,7 +10141,7 @@ declare class ExperimentalEndpointsApiGenerated<TAuth extends AuthMode> extends
|
|
|
10138
10141
|
* @throws {RequiredError}
|
|
10139
10142
|
* @memberof ExperimentalEndpointsApiGenerated
|
|
10140
10143
|
*/
|
|
10141
|
-
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<
|
|
10144
|
+
placeSimpleOrder(...args: ExperimentalEndpointsApiPlaceSimpleOrderArgs<TAuth>): Promise<AxiosResponse<SimpleTradeResponse, unknown, {}, any>>;
|
|
10142
10145
|
}
|
|
10143
10146
|
//#endregion
|
|
10144
10147
|
//#region api/experimental-endpoints-api.d.ts
|
|
@@ -10233,14 +10236,14 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10233
10236
|
* @param {*} [options] Override http request option.
|
|
10234
10237
|
* @throws {RequiredError}
|
|
10235
10238
|
*/
|
|
10236
|
-
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10239
|
+
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PartnerData, unknown>>>;
|
|
10237
10240
|
/**
|
|
10238
10241
|
* Returns a list of all supported Exchanges.
|
|
10239
10242
|
* @summary Get exchanges
|
|
10240
10243
|
* @param {*} [options] Override http request option.
|
|
10241
10244
|
* @throws {RequiredError}
|
|
10242
10245
|
*/
|
|
10243
|
-
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10246
|
+
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Exchange>, unknown>>>;
|
|
10244
10247
|
/**
|
|
10245
10248
|
* 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
10249
|
* @summary Search symbols
|
|
@@ -10248,7 +10251,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10248
10251
|
* @param {*} [options] Override http request option.
|
|
10249
10252
|
* @throws {RequiredError}
|
|
10250
10253
|
*/
|
|
10251
|
-
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10254
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>>;
|
|
10252
10255
|
/**
|
|
10253
10256
|
* 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
10257
|
* @summary Get symbol detail
|
|
@@ -10256,7 +10259,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10256
10259
|
* @param {*} [options] Override http request option.
|
|
10257
10260
|
* @throws {RequiredError}
|
|
10258
10261
|
*/
|
|
10259
|
-
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10262
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UniversalSymbol, unknown>>>;
|
|
10260
10263
|
/**
|
|
10261
10264
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
10262
10265
|
* @summary Get all brokerage authorization types
|
|
@@ -10264,7 +10267,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10264
10267
|
* @param {*} [options] Override http request option.
|
|
10265
10268
|
* @throws {RequiredError}
|
|
10266
10269
|
*/
|
|
10267
|
-
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10270
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<BrokerageAuthorizationTypeReadOnly>, unknown>>>;
|
|
10268
10271
|
/**
|
|
10269
10272
|
* 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
10273
|
* @summary Get brokerage instruments
|
|
@@ -10272,21 +10275,21 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10272
10275
|
* @param {*} [options] Override http request option.
|
|
10273
10276
|
* @throws {RequiredError}
|
|
10274
10277
|
*/
|
|
10275
|
-
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10278
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<BrokerageInstrumentsResponse, unknown>>>;
|
|
10276
10279
|
/**
|
|
10277
10280
|
* Returns a list of all defined Brokerage objects.
|
|
10278
10281
|
* @summary Get brokerages
|
|
10279
10282
|
* @param {*} [options] Override http request option.
|
|
10280
10283
|
* @throws {RequiredError}
|
|
10281
10284
|
*/
|
|
10282
|
-
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10285
|
+
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Brokerage>, unknown>>>;
|
|
10283
10286
|
/**
|
|
10284
10287
|
* 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
10288
|
* @summary List institutions
|
|
10286
10289
|
* @param {*} [options] Override http request option.
|
|
10287
10290
|
* @throws {RequiredError}
|
|
10288
10291
|
*/
|
|
10289
|
-
listInstitutions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10292
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Institution>, unknown>>>;
|
|
10290
10293
|
/**
|
|
10291
10294
|
* 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
10295
|
* @summary Search account symbols
|
|
@@ -10294,7 +10297,7 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
10294
10297
|
* @param {*} [options] Override http request option.
|
|
10295
10298
|
* @throws {RequiredError}
|
|
10296
10299
|
*/
|
|
10297
|
-
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10300
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>>;
|
|
10298
10301
|
};
|
|
10299
10302
|
/**
|
|
10300
10303
|
* ReferenceDataApi - factory interface
|
|
@@ -10307,14 +10310,14 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10307
10310
|
* @param {*} [options] Override http request option.
|
|
10308
10311
|
* @throws {RequiredError}
|
|
10309
10312
|
*/
|
|
10310
|
-
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
10313
|
+
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<PartnerData, unknown>>;
|
|
10311
10314
|
/**
|
|
10312
10315
|
* Returns a list of all supported Exchanges.
|
|
10313
10316
|
* @summary Get exchanges
|
|
10314
10317
|
* @param {*} [options] Override http request option.
|
|
10315
10318
|
* @throws {RequiredError}
|
|
10316
10319
|
*/
|
|
10317
|
-
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
10320
|
+
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<Exchange>, unknown>>;
|
|
10318
10321
|
/**
|
|
10319
10322
|
* 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
10323
|
* @summary Search symbols
|
|
@@ -10322,7 +10325,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10322
10325
|
* @param {*} [options] Override http request option.
|
|
10323
10326
|
* @throws {RequiredError}
|
|
10324
10327
|
*/
|
|
10325
|
-
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>):
|
|
10328
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>;
|
|
10326
10329
|
/**
|
|
10327
10330
|
* 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
10331
|
* @summary Get symbol detail
|
|
@@ -10330,7 +10333,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10330
10333
|
* @param {*} [options] Override http request option.
|
|
10331
10334
|
* @throws {RequiredError}
|
|
10332
10335
|
*/
|
|
10333
|
-
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>):
|
|
10336
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol, unknown>>;
|
|
10334
10337
|
/**
|
|
10335
10338
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
10336
10339
|
* @summary Get all brokerage authorization types
|
|
@@ -10338,7 +10341,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10338
10341
|
* @param {*} [options] Override http request option.
|
|
10339
10342
|
* @throws {RequiredError}
|
|
10340
10343
|
*/
|
|
10341
|
-
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>):
|
|
10344
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<AxiosResponse<Array<BrokerageAuthorizationTypeReadOnly>, unknown>>;
|
|
10342
10345
|
/**
|
|
10343
10346
|
* 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
10347
|
* @summary Get brokerage instruments
|
|
@@ -10346,21 +10349,21 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10346
10349
|
* @param {*} [options] Override http request option.
|
|
10347
10350
|
* @throws {RequiredError}
|
|
10348
10351
|
*/
|
|
10349
|
-
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>):
|
|
10352
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<AxiosResponse<BrokerageInstrumentsResponse, unknown>>;
|
|
10350
10353
|
/**
|
|
10351
10354
|
* Returns a list of all defined Brokerage objects.
|
|
10352
10355
|
* @summary Get brokerages
|
|
10353
10356
|
* @param {*} [options] Override http request option.
|
|
10354
10357
|
* @throws {RequiredError}
|
|
10355
10358
|
*/
|
|
10356
|
-
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]):
|
|
10359
|
+
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Array<Brokerage>, unknown>>;
|
|
10357
10360
|
/**
|
|
10358
10361
|
* 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
10362
|
* @summary List institutions
|
|
10360
10363
|
* @param {*} [options] Override http request option.
|
|
10361
10364
|
* @throws {RequiredError}
|
|
10362
10365
|
*/
|
|
10363
|
-
listInstitutions(options?: AxiosRequestConfig):
|
|
10366
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Institution>, unknown>>;
|
|
10364
10367
|
/**
|
|
10365
10368
|
* 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
10369
|
* @summary Search account symbols
|
|
@@ -10368,7 +10371,7 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10368
10371
|
* @param {*} [options] Override http request option.
|
|
10369
10372
|
* @throws {RequiredError}
|
|
10370
10373
|
*/
|
|
10371
|
-
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>):
|
|
10374
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<AxiosResponse<Array<UniversalSymbol>, unknown>>;
|
|
10372
10375
|
};
|
|
10373
10376
|
/**
|
|
10374
10377
|
* Request parameters for getSymbols operation in ReferenceDataApi.
|
|
@@ -10488,7 +10491,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10488
10491
|
* @throws {RequiredError}
|
|
10489
10492
|
* @memberof ReferenceDataApiGenerated
|
|
10490
10493
|
*/
|
|
10491
|
-
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10494
|
+
getPartnerInfo(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<PartnerData, unknown, {}, any>>;
|
|
10492
10495
|
/**
|
|
10493
10496
|
* Returns a list of all supported Exchanges.
|
|
10494
10497
|
* @summary Get exchanges
|
|
@@ -10496,7 +10499,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10496
10499
|
* @throws {RequiredError}
|
|
10497
10500
|
* @memberof ReferenceDataApiGenerated
|
|
10498
10501
|
*/
|
|
10499
|
-
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10502
|
+
getStockExchanges(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Exchange[], unknown, {}, any>>;
|
|
10500
10503
|
/**
|
|
10501
10504
|
* 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
10505
|
* @summary Search symbols
|
|
@@ -10505,7 +10508,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10505
10508
|
* @throws {RequiredError}
|
|
10506
10509
|
* @memberof ReferenceDataApiGenerated
|
|
10507
10510
|
*/
|
|
10508
|
-
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<
|
|
10511
|
+
getSymbols(...args: ReferenceDataApiGetSymbolsArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol[], unknown, {}, any>>;
|
|
10509
10512
|
/**
|
|
10510
10513
|
* 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
10514
|
* @summary Get symbol detail
|
|
@@ -10514,7 +10517,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10514
10517
|
* @throws {RequiredError}
|
|
10515
10518
|
* @memberof ReferenceDataApiGenerated
|
|
10516
10519
|
*/
|
|
10517
|
-
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<
|
|
10520
|
+
getSymbolsByTicker(...args: ReferenceDataApiGetSymbolsByTickerArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol, unknown, {}, any>>;
|
|
10518
10521
|
/**
|
|
10519
10522
|
* Returns a list of all defined Brokerage authorization Type objects.
|
|
10520
10523
|
* @summary Get all brokerage authorization types
|
|
@@ -10523,7 +10526,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10523
10526
|
* @throws {RequiredError}
|
|
10524
10527
|
* @memberof ReferenceDataApiGenerated
|
|
10525
10528
|
*/
|
|
10526
|
-
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<
|
|
10529
|
+
listAllBrokerageAuthorizationType(...args: ReferenceDataApiListAllBrokerageAuthorizationTypeArgs<TAuth>): Promise<AxiosResponse<BrokerageAuthorizationTypeReadOnly[], unknown, {}, any>>;
|
|
10527
10530
|
/**
|
|
10528
10531
|
* 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
10532
|
* @summary Get brokerage instruments
|
|
@@ -10532,7 +10535,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10532
10535
|
* @throws {RequiredError}
|
|
10533
10536
|
* @memberof ReferenceDataApiGenerated
|
|
10534
10537
|
*/
|
|
10535
|
-
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<
|
|
10538
|
+
listAllBrokerageInstruments(...args: ReferenceDataApiListAllBrokerageInstrumentsArgs<TAuth>): Promise<AxiosResponse<BrokerageInstrumentsResponse, unknown, {}, any>>;
|
|
10536
10539
|
/**
|
|
10537
10540
|
* Returns a list of all defined Brokerage objects.
|
|
10538
10541
|
* @summary Get brokerages
|
|
@@ -10540,7 +10543,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10540
10543
|
* @throws {RequiredError}
|
|
10541
10544
|
* @memberof ReferenceDataApiGenerated
|
|
10542
10545
|
*/
|
|
10543
|
-
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<
|
|
10546
|
+
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<AxiosResponse<Brokerage[], unknown, {}, any>>;
|
|
10544
10547
|
/**
|
|
10545
10548
|
* 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
10549
|
* @summary List institutions
|
|
@@ -10548,7 +10551,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10548
10551
|
* @throws {RequiredError}
|
|
10549
10552
|
* @memberof ReferenceDataApiGenerated
|
|
10550
10553
|
*/
|
|
10551
|
-
listInstitutions(options?: AxiosRequestConfig): Promise<
|
|
10554
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<AxiosResponse<Institution[], unknown, {}, any>>;
|
|
10552
10555
|
/**
|
|
10553
10556
|
* 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
10557
|
* @summary Search account symbols
|
|
@@ -10557,7 +10560,7 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10557
10560
|
* @throws {RequiredError}
|
|
10558
10561
|
* @memberof ReferenceDataApiGenerated
|
|
10559
10562
|
*/
|
|
10560
|
-
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<
|
|
10563
|
+
symbolSearchUserAccount(...args: ReferenceDataApiSymbolSearchUserAccountArgs<TAuth>): Promise<AxiosResponse<UniversalSymbol[], unknown, {}, any>>;
|
|
10561
10564
|
}
|
|
10562
10565
|
//#endregion
|
|
10563
10566
|
//#region api/reference-data-api.d.ts
|
|
@@ -10737,7 +10740,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10737
10740
|
* @param {*} [options] Override http request option.
|
|
10738
10741
|
* @throws {RequiredError}
|
|
10739
10742
|
*/
|
|
10740
|
-
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10743
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CancelOrderResponse, unknown>>>;
|
|
10741
10744
|
/**
|
|
10742
10745
|
* Gets a quote for the specified account.
|
|
10743
10746
|
* @summary Get crypto pair quote
|
|
@@ -10745,7 +10748,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10745
10748
|
* @param {*} [options] Override http request option.
|
|
10746
10749
|
* @throws {RequiredError}
|
|
10747
10750
|
*/
|
|
10748
|
-
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10751
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CryptocurrencyPairQuote, unknown>>>;
|
|
10749
10752
|
/**
|
|
10750
10753
|
* 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
10754
|
* @summary Get option order impact
|
|
@@ -10753,7 +10756,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10753
10756
|
* @param {*} [options] Override http request option.
|
|
10754
10757
|
* @throws {RequiredError}
|
|
10755
10758
|
*/
|
|
10756
|
-
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10759
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OptionImpact, unknown>>>;
|
|
10757
10760
|
/**
|
|
10758
10761
|
* 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
10762
|
* @summary Check equity order impact
|
|
@@ -10761,7 +10764,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10761
10764
|
* @param {*} [options] Override http request option.
|
|
10762
10765
|
* @throws {RequiredError}
|
|
10763
10766
|
*/
|
|
10764
|
-
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10767
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ManualTradeAndImpact, unknown>>>;
|
|
10765
10768
|
/**
|
|
10766
10769
|
* **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
10770
|
* @summary Get option quote
|
|
@@ -10770,7 +10773,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10770
10773
|
* @deprecated
|
|
10771
10774
|
* @throws {RequiredError}
|
|
10772
10775
|
*/
|
|
10773
|
-
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10776
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OptionQuote, unknown>>>;
|
|
10774
10777
|
/**
|
|
10775
10778
|
* 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
10779
|
* @summary Get equity symbol quotes
|
|
@@ -10778,7 +10781,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10778
10781
|
* @param {*} [options] Override http request option.
|
|
10779
10782
|
* @throws {RequiredError}
|
|
10780
10783
|
*/
|
|
10781
|
-
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10784
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<SymbolsQuotesInner>, unknown>>>;
|
|
10782
10785
|
/**
|
|
10783
10786
|
* 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
10787
|
* @summary Place complex order
|
|
@@ -10786,7 +10789,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10786
10789
|
* @param {*} [options] Override http request option.
|
|
10787
10790
|
* @throws {RequiredError}
|
|
10788
10791
|
*/
|
|
10789
|
-
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10792
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ComplexOrderResponse, unknown>>>;
|
|
10790
10793
|
/**
|
|
10791
10794
|
* 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
10795
|
* @summary Place crypto order
|
|
@@ -10794,7 +10797,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10794
10797
|
* @param {*} [options] Override http request option.
|
|
10795
10798
|
* @throws {RequiredError}
|
|
10796
10799
|
*/
|
|
10797
|
-
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10800
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OrderUpdatedResponse, unknown>>>;
|
|
10798
10801
|
/**
|
|
10799
10802
|
* 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
10803
|
* @summary Place equity order
|
|
@@ -10802,7 +10805,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10802
10805
|
* @param {*} [options] Override http request option.
|
|
10803
10806
|
* @throws {RequiredError}
|
|
10804
10807
|
*/
|
|
10805
|
-
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10808
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
10806
10809
|
/**
|
|
10807
10810
|
* 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
10811
|
* @summary Place option order
|
|
@@ -10810,7 +10813,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10810
10813
|
* @param {*} [options] Override http request option.
|
|
10811
10814
|
* @throws {RequiredError}
|
|
10812
10815
|
*/
|
|
10813
|
-
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10816
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<MlegOrderResponse, unknown>>>;
|
|
10814
10817
|
/**
|
|
10815
10818
|
* 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
10819
|
* @summary Place checked equity order
|
|
@@ -10818,7 +10821,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10818
10821
|
* @param {*} [options] Override http request option.
|
|
10819
10822
|
* @throws {RequiredError}
|
|
10820
10823
|
*/
|
|
10821
|
-
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10824
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
10822
10825
|
/**
|
|
10823
10826
|
* Previews an order using the specified account.
|
|
10824
10827
|
* @summary Preview crypto order
|
|
@@ -10826,7 +10829,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10826
10829
|
* @param {*} [options] Override http request option.
|
|
10827
10830
|
* @throws {RequiredError}
|
|
10828
10831
|
*/
|
|
10829
|
-
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10832
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CryptoOrderPreview, unknown>>>;
|
|
10830
10833
|
/**
|
|
10831
10834
|
* 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
10835
|
* @summary Replace order
|
|
@@ -10834,7 +10837,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10834
10837
|
* @param {*} [options] Override http request option.
|
|
10835
10838
|
* @throws {RequiredError}
|
|
10836
10839
|
*/
|
|
10837
|
-
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10840
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccountOrderRecord, unknown>>>;
|
|
10838
10841
|
/**
|
|
10839
10842
|
* 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
10843
|
* @summary Get crypto pairs
|
|
@@ -10842,7 +10845,7 @@ declare const TradingApiFp: <TAuth extends AuthMode>(configuration?: Configurati
|
|
|
10842
10845
|
* @param {*} [options] Override http request option.
|
|
10843
10846
|
* @throws {RequiredError}
|
|
10844
10847
|
*/
|
|
10845
|
-
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) =>
|
|
10848
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, unknown>>>;
|
|
10846
10849
|
};
|
|
10847
10850
|
/**
|
|
10848
10851
|
* TradingApi - factory interface
|
|
@@ -10856,7 +10859,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10856
10859
|
* @param {*} [options] Override http request option.
|
|
10857
10860
|
* @throws {RequiredError}
|
|
10858
10861
|
*/
|
|
10859
|
-
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>):
|
|
10862
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<AxiosResponse<CancelOrderResponse, unknown>>;
|
|
10860
10863
|
/**
|
|
10861
10864
|
* Gets a quote for the specified account.
|
|
10862
10865
|
* @summary Get crypto pair quote
|
|
@@ -10864,7 +10867,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10864
10867
|
* @param {*} [options] Override http request option.
|
|
10865
10868
|
* @throws {RequiredError}
|
|
10866
10869
|
*/
|
|
10867
|
-
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>):
|
|
10870
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<AxiosResponse<CryptocurrencyPairQuote, unknown>>;
|
|
10868
10871
|
/**
|
|
10869
10872
|
* 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
10873
|
* @summary Get option order impact
|
|
@@ -10872,7 +10875,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10872
10875
|
* @param {*} [options] Override http request option.
|
|
10873
10876
|
* @throws {RequiredError}
|
|
10874
10877
|
*/
|
|
10875
|
-
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>):
|
|
10878
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<AxiosResponse<OptionImpact, unknown>>;
|
|
10876
10879
|
/**
|
|
10877
10880
|
* 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
10881
|
* @summary Check equity order impact
|
|
@@ -10880,7 +10883,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10880
10883
|
* @param {*} [options] Override http request option.
|
|
10881
10884
|
* @throws {RequiredError}
|
|
10882
10885
|
*/
|
|
10883
|
-
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>):
|
|
10886
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<AxiosResponse<ManualTradeAndImpact, unknown>>;
|
|
10884
10887
|
/**
|
|
10885
10888
|
* **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
10889
|
* @summary Get option quote
|
|
@@ -10889,7 +10892,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10889
10892
|
* @deprecated
|
|
10890
10893
|
* @throws {RequiredError}
|
|
10891
10894
|
*/
|
|
10892
|
-
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>):
|
|
10895
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<AxiosResponse<OptionQuote, unknown>>;
|
|
10893
10896
|
/**
|
|
10894
10897
|
* 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
10898
|
* @summary Get equity symbol quotes
|
|
@@ -10897,7 +10900,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10897
10900
|
* @param {*} [options] Override http request option.
|
|
10898
10901
|
* @throws {RequiredError}
|
|
10899
10902
|
*/
|
|
10900
|
-
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>):
|
|
10903
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<AxiosResponse<Array<SymbolsQuotesInner>, unknown>>;
|
|
10901
10904
|
/**
|
|
10902
10905
|
* 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
10906
|
* @summary Place complex order
|
|
@@ -10905,7 +10908,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10905
10908
|
* @param {*} [options] Override http request option.
|
|
10906
10909
|
* @throws {RequiredError}
|
|
10907
10910
|
*/
|
|
10908
|
-
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>):
|
|
10911
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<AxiosResponse<ComplexOrderResponse, unknown>>;
|
|
10909
10912
|
/**
|
|
10910
10913
|
* 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
10914
|
* @summary Place crypto order
|
|
@@ -10913,7 +10916,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10913
10916
|
* @param {*} [options] Override http request option.
|
|
10914
10917
|
* @throws {RequiredError}
|
|
10915
10918
|
*/
|
|
10916
|
-
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>):
|
|
10919
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<AxiosResponse<OrderUpdatedResponse, unknown>>;
|
|
10917
10920
|
/**
|
|
10918
10921
|
* 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
10922
|
* @summary Place equity order
|
|
@@ -10921,7 +10924,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10921
10924
|
* @param {*} [options] Override http request option.
|
|
10922
10925
|
* @throws {RequiredError}
|
|
10923
10926
|
*/
|
|
10924
|
-
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>):
|
|
10927
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
10925
10928
|
/**
|
|
10926
10929
|
* 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
10930
|
* @summary Place option order
|
|
@@ -10929,7 +10932,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10929
10932
|
* @param {*} [options] Override http request option.
|
|
10930
10933
|
* @throws {RequiredError}
|
|
10931
10934
|
*/
|
|
10932
|
-
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>):
|
|
10935
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<AxiosResponse<MlegOrderResponse, unknown>>;
|
|
10933
10936
|
/**
|
|
10934
10937
|
* 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
10938
|
* @summary Place checked equity order
|
|
@@ -10937,7 +10940,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10937
10940
|
* @param {*} [options] Override http request option.
|
|
10938
10941
|
* @throws {RequiredError}
|
|
10939
10942
|
*/
|
|
10940
|
-
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>):
|
|
10943
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
10941
10944
|
/**
|
|
10942
10945
|
* Previews an order using the specified account.
|
|
10943
10946
|
* @summary Preview crypto order
|
|
@@ -10945,7 +10948,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10945
10948
|
* @param {*} [options] Override http request option.
|
|
10946
10949
|
* @throws {RequiredError}
|
|
10947
10950
|
*/
|
|
10948
|
-
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>):
|
|
10951
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<AxiosResponse<CryptoOrderPreview, unknown>>;
|
|
10949
10952
|
/**
|
|
10950
10953
|
* 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
10954
|
* @summary Replace order
|
|
@@ -10953,7 +10956,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10953
10956
|
* @param {*} [options] Override http request option.
|
|
10954
10957
|
* @throws {RequiredError}
|
|
10955
10958
|
*/
|
|
10956
|
-
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>):
|
|
10959
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown>>;
|
|
10957
10960
|
/**
|
|
10958
10961
|
* 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
10962
|
* @summary Get crypto pairs
|
|
@@ -10961,7 +10964,7 @@ declare const TradingApiFactory: <TAuth extends AuthMode>(configuration?: Config
|
|
|
10961
10964
|
* @param {*} [options] Override http request option.
|
|
10962
10965
|
* @throws {RequiredError}
|
|
10963
10966
|
*/
|
|
10964
|
-
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>):
|
|
10967
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, unknown>>;
|
|
10965
10968
|
};
|
|
10966
10969
|
/**
|
|
10967
10970
|
* Request parameters for cancelOrder operation in TradingApi.
|
|
@@ -11378,7 +11381,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11378
11381
|
* @throws {RequiredError}
|
|
11379
11382
|
* @memberof TradingApiGenerated
|
|
11380
11383
|
*/
|
|
11381
|
-
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<
|
|
11384
|
+
cancelOrder(...args: TradingApiCancelOrderArgs<TAuth>): Promise<AxiosResponse<CancelOrderResponse, unknown, {}, any>>;
|
|
11382
11385
|
/**
|
|
11383
11386
|
* Gets a quote for the specified account.
|
|
11384
11387
|
* @summary Get crypto pair quote
|
|
@@ -11387,7 +11390,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11387
11390
|
* @throws {RequiredError}
|
|
11388
11391
|
* @memberof TradingApiGenerated
|
|
11389
11392
|
*/
|
|
11390
|
-
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<
|
|
11393
|
+
getCryptocurrencyPairQuote(...args: TradingApiGetCryptocurrencyPairQuoteArgs<TAuth>): Promise<AxiosResponse<CryptocurrencyPairQuote, unknown, {}, any>>;
|
|
11391
11394
|
/**
|
|
11392
11395
|
* 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
11396
|
* @summary Get option order impact
|
|
@@ -11396,7 +11399,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11396
11399
|
* @throws {RequiredError}
|
|
11397
11400
|
* @memberof TradingApiGenerated
|
|
11398
11401
|
*/
|
|
11399
|
-
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<
|
|
11402
|
+
getOptionImpact(...args: TradingApiGetOptionImpactArgs<TAuth>): Promise<AxiosResponse<OptionImpact, unknown, {}, any>>;
|
|
11400
11403
|
/**
|
|
11401
11404
|
* 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
11405
|
* @summary Check equity order impact
|
|
@@ -11405,7 +11408,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11405
11408
|
* @throws {RequiredError}
|
|
11406
11409
|
* @memberof TradingApiGenerated
|
|
11407
11410
|
*/
|
|
11408
|
-
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<
|
|
11411
|
+
getOrderImpact(...args: TradingApiGetOrderImpactArgs<TAuth>): Promise<AxiosResponse<ManualTradeAndImpact, unknown, {}, any>>;
|
|
11409
11412
|
/**
|
|
11410
11413
|
* **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
11414
|
* @summary Get option quote
|
|
@@ -11415,7 +11418,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11415
11418
|
* @throws {RequiredError}
|
|
11416
11419
|
* @memberof TradingApiGenerated
|
|
11417
11420
|
*/
|
|
11418
|
-
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<
|
|
11421
|
+
getUserAccountOptionQuotes(...args: TradingApiGetUserAccountOptionQuotesArgs<TAuth>): Promise<AxiosResponse<OptionQuote, unknown, {}, any>>;
|
|
11419
11422
|
/**
|
|
11420
11423
|
* 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
11424
|
* @summary Get equity symbol quotes
|
|
@@ -11424,7 +11427,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11424
11427
|
* @throws {RequiredError}
|
|
11425
11428
|
* @memberof TradingApiGenerated
|
|
11426
11429
|
*/
|
|
11427
|
-
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<
|
|
11430
|
+
getUserAccountQuotes(...args: TradingApiGetUserAccountQuotesArgs<TAuth>): Promise<AxiosResponse<SymbolsQuotesInner[], unknown, {}, any>>;
|
|
11428
11431
|
/**
|
|
11429
11432
|
* 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
11433
|
* @summary Place complex order
|
|
@@ -11433,7 +11436,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11433
11436
|
* @throws {RequiredError}
|
|
11434
11437
|
* @memberof TradingApiGenerated
|
|
11435
11438
|
*/
|
|
11436
|
-
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<
|
|
11439
|
+
placeComplexOrder(...args: TradingApiPlaceComplexOrderArgs<TAuth>): Promise<AxiosResponse<ComplexOrderResponse, unknown, {}, any>>;
|
|
11437
11440
|
/**
|
|
11438
11441
|
* 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
11442
|
* @summary Place crypto order
|
|
@@ -11442,7 +11445,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11442
11445
|
* @throws {RequiredError}
|
|
11443
11446
|
* @memberof TradingApiGenerated
|
|
11444
11447
|
*/
|
|
11445
|
-
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<
|
|
11448
|
+
placeCryptoOrder(...args: TradingApiPlaceCryptoOrderArgs<TAuth>): Promise<AxiosResponse<OrderUpdatedResponse, unknown, {}, any>>;
|
|
11446
11449
|
/**
|
|
11447
11450
|
* 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
11451
|
* @summary Place equity order
|
|
@@ -11451,7 +11454,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11451
11454
|
* @throws {RequiredError}
|
|
11452
11455
|
* @memberof TradingApiGenerated
|
|
11453
11456
|
*/
|
|
11454
|
-
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<
|
|
11457
|
+
placeForceOrder(...args: TradingApiPlaceForceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
11455
11458
|
/**
|
|
11456
11459
|
* 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
11460
|
* @summary Place option order
|
|
@@ -11460,7 +11463,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11460
11463
|
* @throws {RequiredError}
|
|
11461
11464
|
* @memberof TradingApiGenerated
|
|
11462
11465
|
*/
|
|
11463
|
-
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<
|
|
11466
|
+
placeMlegOrder(...args: TradingApiPlaceMlegOrderArgs<TAuth>): Promise<AxiosResponse<MlegOrderResponse, unknown, {}, any>>;
|
|
11464
11467
|
/**
|
|
11465
11468
|
* 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
11469
|
* @summary Place checked equity order
|
|
@@ -11469,7 +11472,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11469
11472
|
* @throws {RequiredError}
|
|
11470
11473
|
* @memberof TradingApiGenerated
|
|
11471
11474
|
*/
|
|
11472
|
-
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<
|
|
11475
|
+
placeOrder(...args: TradingApiPlaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
11473
11476
|
/**
|
|
11474
11477
|
* Previews an order using the specified account.
|
|
11475
11478
|
* @summary Preview crypto order
|
|
@@ -11478,7 +11481,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11478
11481
|
* @throws {RequiredError}
|
|
11479
11482
|
* @memberof TradingApiGenerated
|
|
11480
11483
|
*/
|
|
11481
|
-
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<
|
|
11484
|
+
previewCryptoOrder(...args: TradingApiPreviewCryptoOrderArgs<TAuth>): Promise<AxiosResponse<CryptoOrderPreview, unknown, {}, any>>;
|
|
11482
11485
|
/**
|
|
11483
11486
|
* 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
11487
|
* @summary Replace order
|
|
@@ -11487,7 +11490,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11487
11490
|
* @throws {RequiredError}
|
|
11488
11491
|
* @memberof TradingApiGenerated
|
|
11489
11492
|
*/
|
|
11490
|
-
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<
|
|
11493
|
+
replaceOrder(...args: TradingApiReplaceOrderArgs<TAuth>): Promise<AxiosResponse<AccountOrderRecord, unknown, {}, any>>;
|
|
11491
11494
|
/**
|
|
11492
11495
|
* 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
11496
|
* @summary Get crypto pairs
|
|
@@ -11496,7 +11499,7 @@ declare class TradingApiGenerated<TAuth extends AuthMode> extends BaseAPI<TAuth>
|
|
|
11496
11499
|
* @throws {RequiredError}
|
|
11497
11500
|
* @memberof TradingApiGenerated
|
|
11498
11501
|
*/
|
|
11499
|
-
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<
|
|
11502
|
+
searchCryptocurrencyPairInstruments(...args: TradingApiSearchCryptocurrencyPairInstrumentsArgs<TAuth>): Promise<AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, unknown, {}, any>>;
|
|
11500
11503
|
}
|
|
11501
11504
|
//#endregion
|
|
11502
11505
|
//#region api/trading-api.d.ts
|
|
@@ -11566,4 +11569,4 @@ declare class SnaptradeError extends Error {
|
|
|
11566
11569
|
declare function readableStreamToString(stream: ReadableStream): Promise<string>;
|
|
11567
11570
|
declare function parseIfJson(input: unknown): object | unknown;
|
|
11568
11571
|
//#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 };
|
|
11572
|
+
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 };
|