snaptrade-typescript-sdk 12.2.11 → 12.2.13
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 +52 -16
- package/dist/browser.umd.js +1 -1
- package/dist/index.cjs +84 -13
- package/dist/index.d.cts +581 -639
- package/dist/index.d.mts +581 -639
- package/dist/index.d.ts +581 -639
- package/dist/index.mjs +84 -13
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -176,7 +176,7 @@ interface HoldingsStatus {
|
|
|
176
176
|
*/
|
|
177
177
|
'initial_sync_completed'?: boolean;
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
179
|
+
* Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
|
|
180
180
|
* @type {string}
|
|
181
181
|
* @memberof HoldingsStatus
|
|
182
182
|
*/
|
|
@@ -203,13 +203,13 @@ interface TransactionsStatus {
|
|
|
203
203
|
*/
|
|
204
204
|
'initial_sync_completed'?: boolean;
|
|
205
205
|
/**
|
|
206
|
-
*
|
|
206
|
+
* Date in YYYY-MM-DD format or null
|
|
207
207
|
* @type {string}
|
|
208
208
|
* @memberof TransactionsStatus
|
|
209
209
|
*/
|
|
210
210
|
'last_successful_sync'?: string | null;
|
|
211
211
|
/**
|
|
212
|
-
*
|
|
212
|
+
* Date in YYYY-MM-DD format or null
|
|
213
213
|
* @type {string}
|
|
214
214
|
* @memberof TransactionsStatus
|
|
215
215
|
*/
|
|
@@ -472,6 +472,28 @@ interface Currency {
|
|
|
472
472
|
'name'?: string;
|
|
473
473
|
}
|
|
474
474
|
//#endregion
|
|
475
|
+
//#region models/figi-instrument-nullable.d.ts
|
|
476
|
+
/**
|
|
477
|
+
* Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.
|
|
478
|
+
* @export
|
|
479
|
+
* @interface FigiInstrumentNullable
|
|
480
|
+
*/
|
|
481
|
+
interface FigiInstrumentNullable {
|
|
482
|
+
[key: string]: any;
|
|
483
|
+
/**
|
|
484
|
+
* 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
|
+
* @type {string}
|
|
486
|
+
* @memberof FigiInstrumentNullable
|
|
487
|
+
*/
|
|
488
|
+
'figi_code'?: string | null;
|
|
489
|
+
/**
|
|
490
|
+
* This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
|
|
491
|
+
* @type {string}
|
|
492
|
+
* @memberof FigiInstrumentNullable
|
|
493
|
+
*/
|
|
494
|
+
'figi_share_class'?: string | null;
|
|
495
|
+
}
|
|
496
|
+
//#endregion
|
|
475
497
|
//#region models/security-type.d.ts
|
|
476
498
|
/**
|
|
477
499
|
* The type of security. For example, \"Common Stock\" or \"ETF\".
|
|
@@ -507,27 +529,6 @@ interface SecurityType {
|
|
|
507
529
|
'is_supported'?: boolean;
|
|
508
530
|
}
|
|
509
531
|
//#endregion
|
|
510
|
-
//#region models/stock-instrument-figi-instrument.d.ts
|
|
511
|
-
/**
|
|
512
|
-
*
|
|
513
|
-
* @export
|
|
514
|
-
* @interface StockInstrumentFigiInstrument
|
|
515
|
-
*/
|
|
516
|
-
interface StockInstrumentFigiInstrument {
|
|
517
|
-
/**
|
|
518
|
-
* 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.
|
|
519
|
-
* @type {string}
|
|
520
|
-
* @memberof StockInstrumentFigiInstrument
|
|
521
|
-
*/
|
|
522
|
-
'figi_code'?: string | null;
|
|
523
|
-
/**
|
|
524
|
-
* This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
|
|
525
|
-
* @type {string}
|
|
526
|
-
* @memberof StockInstrumentFigiInstrument
|
|
527
|
-
*/
|
|
528
|
-
'figi_share_class'?: string | null;
|
|
529
|
-
}
|
|
530
|
-
//#endregion
|
|
531
532
|
//#region models/symbol-currency.d.ts
|
|
532
533
|
/**
|
|
533
534
|
* The currency in which the security is traded.
|
|
@@ -670,10 +671,10 @@ interface UniversalSymbol {
|
|
|
670
671
|
'figi_code'?: string | null;
|
|
671
672
|
/**
|
|
672
673
|
*
|
|
673
|
-
* @type {
|
|
674
|
+
* @type {FigiInstrumentNullable}
|
|
674
675
|
* @memberof UniversalSymbol
|
|
675
676
|
*/
|
|
676
|
-
'figi_instrument'?:
|
|
677
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
677
678
|
/**
|
|
678
679
|
* This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
|
|
679
680
|
* @type {Array<Currency>}
|
|
@@ -844,7 +845,7 @@ interface Position {
|
|
|
844
845
|
*/
|
|
845
846
|
'cash_equivalent'?: boolean | null;
|
|
846
847
|
/**
|
|
847
|
-
* List of tax lots for the given position
|
|
848
|
+
* List of tax lots for the given position. Disabled by default, only available on paid plans, enable this feature in the [Add-on page of the Customer Dashboard](https://dashboard.snaptrade.com/add-ons)
|
|
848
849
|
* @type {Array<TaxLot>}
|
|
849
850
|
* @memberof Position
|
|
850
851
|
*/
|
|
@@ -1217,27 +1218,64 @@ interface AccountHoldings {
|
|
|
1217
1218
|
'total_value'?: SnapTradeHoldingsTotalValue;
|
|
1218
1219
|
}
|
|
1219
1220
|
//#endregion
|
|
1220
|
-
//#region models/account-order-record-
|
|
1221
|
+
//#region models/account-order-record-status.d.ts
|
|
1222
|
+
/**
|
|
1223
|
+
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED
|
|
1224
|
+
* @export
|
|
1225
|
+
* @enum {string}
|
|
1226
|
+
*/
|
|
1227
|
+
type AccountOrderRecordStatus = 'NONE' | 'PENDING' | 'ACCEPTED' | 'FAILED' | 'REJECTED' | 'CANCELED' | 'PARTIAL_CANCELED' | 'CANCEL_PENDING' | 'EXECUTED' | 'PARTIAL' | 'REPLACE_PENDING' | 'REPLACED' | 'STOPPED' | 'SUSPENDED' | 'EXPIRED' | 'QUEUED' | 'TRIGGERED' | 'ACTIVATED' | 'PENDING_RISK_REVIEW' | 'CONTINGENT_ORDER';
|
|
1228
|
+
//#endregion
|
|
1229
|
+
//#region models/child-brokerage-order-ids-nullable.d.ts
|
|
1221
1230
|
/**
|
|
1222
1231
|
*
|
|
1223
1232
|
* @export
|
|
1224
|
-
* @interface
|
|
1233
|
+
* @interface ChildBrokerageOrderIDsNullable
|
|
1225
1234
|
*/
|
|
1226
|
-
interface
|
|
1235
|
+
interface ChildBrokerageOrderIDsNullable {
|
|
1236
|
+
[key: string]: any;
|
|
1227
1237
|
/**
|
|
1228
1238
|
* The brokerage order ID for the take profit leg of the bracket order
|
|
1229
1239
|
* @type {string}
|
|
1230
|
-
* @memberof
|
|
1240
|
+
* @memberof ChildBrokerageOrderIDsNullable
|
|
1231
1241
|
*/
|
|
1232
1242
|
'take_profit_order_id'?: string;
|
|
1233
1243
|
/**
|
|
1234
1244
|
* The brokerage order ID for the stop loss leg of the bracket order
|
|
1235
1245
|
* @type {string}
|
|
1236
|
-
* @memberof
|
|
1246
|
+
* @memberof ChildBrokerageOrderIDsNullable
|
|
1237
1247
|
*/
|
|
1238
1248
|
'stop_loss_order_id'?: string;
|
|
1239
1249
|
}
|
|
1240
1250
|
//#endregion
|
|
1251
|
+
//#region models/currency-nullable.d.ts
|
|
1252
|
+
/**
|
|
1253
|
+
* Describes a currency object.
|
|
1254
|
+
* @export
|
|
1255
|
+
* @interface CurrencyNullable
|
|
1256
|
+
*/
|
|
1257
|
+
interface CurrencyNullable {
|
|
1258
|
+
[key: string]: any;
|
|
1259
|
+
/**
|
|
1260
|
+
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
1261
|
+
* @type {string}
|
|
1262
|
+
* @memberof CurrencyNullable
|
|
1263
|
+
*/
|
|
1264
|
+
'id'?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* The ISO-4217 currency code for the currency.
|
|
1267
|
+
* @type {string}
|
|
1268
|
+
* @memberof CurrencyNullable
|
|
1269
|
+
*/
|
|
1270
|
+
'code'?: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* A human-friendly name of the currency.
|
|
1273
|
+
* @type {string}
|
|
1274
|
+
* @memberof CurrencyNullable
|
|
1275
|
+
*/
|
|
1276
|
+
'name'?: string;
|
|
1277
|
+
}
|
|
1278
|
+
//#endregion
|
|
1241
1279
|
//#region models/underlying-symbol-exchange.d.ts
|
|
1242
1280
|
/**
|
|
1243
1281
|
* The exchange on which the security is listed and traded.
|
|
@@ -1393,10 +1431,10 @@ interface UnderlyingSymbol {
|
|
|
1393
1431
|
'figi_code'?: string | null;
|
|
1394
1432
|
/**
|
|
1395
1433
|
*
|
|
1396
|
-
* @type {
|
|
1434
|
+
* @type {FigiInstrumentNullable}
|
|
1397
1435
|
* @memberof UnderlyingSymbol
|
|
1398
1436
|
*/
|
|
1399
|
-
'figi_instrument'?:
|
|
1437
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
1400
1438
|
/**
|
|
1401
1439
|
* This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
|
|
1402
1440
|
* @type {Array<Currency>}
|
|
@@ -1406,250 +1444,148 @@ interface UnderlyingSymbol {
|
|
|
1406
1444
|
'currencies'?: Array<Currency>;
|
|
1407
1445
|
}
|
|
1408
1446
|
//#endregion
|
|
1409
|
-
//#region models/
|
|
1447
|
+
//#region models/options-symbol-nullable.d.ts
|
|
1410
1448
|
/**
|
|
1411
|
-
*
|
|
1449
|
+
* Uniquely describes an option security + exchange combination across all brokerages.
|
|
1412
1450
|
* @export
|
|
1413
|
-
* @interface
|
|
1451
|
+
* @interface OptionsSymbolNullable
|
|
1414
1452
|
*/
|
|
1415
|
-
interface
|
|
1453
|
+
interface OptionsSymbolNullable {
|
|
1454
|
+
[key: string]: any;
|
|
1416
1455
|
/**
|
|
1417
1456
|
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1418
1457
|
* @type {string}
|
|
1419
|
-
* @memberof
|
|
1458
|
+
* @memberof OptionsSymbolNullable
|
|
1420
1459
|
*/
|
|
1421
1460
|
'id': string;
|
|
1422
1461
|
/**
|
|
1423
1462
|
* The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
|
|
1424
1463
|
* @type {string}
|
|
1425
|
-
* @memberof
|
|
1464
|
+
* @memberof OptionsSymbolNullable
|
|
1426
1465
|
*/
|
|
1427
1466
|
'ticker': string;
|
|
1428
1467
|
/**
|
|
1429
1468
|
* The type of option. Either \"CALL\" or \"PUT\".
|
|
1430
1469
|
* @type {string}
|
|
1431
|
-
* @memberof
|
|
1470
|
+
* @memberof OptionsSymbolNullable
|
|
1432
1471
|
*/
|
|
1433
|
-
'option_type':
|
|
1472
|
+
'option_type': OptionsSymbolNullableOptionTypeEnum;
|
|
1434
1473
|
/**
|
|
1435
1474
|
* The option strike price.
|
|
1436
1475
|
* @type {number}
|
|
1437
|
-
* @memberof
|
|
1476
|
+
* @memberof OptionsSymbolNullable
|
|
1438
1477
|
*/
|
|
1439
1478
|
'strike_price': number;
|
|
1440
1479
|
/**
|
|
1441
1480
|
* The option expiration date.
|
|
1442
1481
|
* @type {string}
|
|
1443
|
-
* @memberof
|
|
1482
|
+
* @memberof OptionsSymbolNullable
|
|
1444
1483
|
*/
|
|
1445
1484
|
'expiration_date': string;
|
|
1446
1485
|
/**
|
|
1447
1486
|
* Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
|
|
1448
1487
|
* @type {boolean}
|
|
1449
|
-
* @memberof
|
|
1488
|
+
* @memberof OptionsSymbolNullable
|
|
1450
1489
|
*/
|
|
1451
1490
|
'is_mini_option'?: boolean;
|
|
1452
1491
|
/**
|
|
1453
1492
|
*
|
|
1454
1493
|
* @type {UnderlyingSymbol}
|
|
1455
|
-
* @memberof
|
|
1494
|
+
* @memberof OptionsSymbolNullable
|
|
1456
1495
|
*/
|
|
1457
1496
|
'underlying_symbol': UnderlyingSymbol;
|
|
1458
1497
|
}
|
|
1459
|
-
type
|
|
1460
|
-
//#endregion
|
|
1461
|
-
//#region models/account-order-record-quote-currency.d.ts
|
|
1462
|
-
/**
|
|
1463
|
-
* Quote currency. This field is only present for cryptocurrency pair orders with a fiat currency as quote.
|
|
1464
|
-
* @export
|
|
1465
|
-
* @interface AccountOrderRecordQuoteCurrency
|
|
1466
|
-
*/
|
|
1467
|
-
interface AccountOrderRecordQuoteCurrency {
|
|
1468
|
-
/**
|
|
1469
|
-
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
1470
|
-
* @type {string}
|
|
1471
|
-
* @memberof AccountOrderRecordQuoteCurrency
|
|
1472
|
-
*/
|
|
1473
|
-
'id'?: string;
|
|
1474
|
-
/**
|
|
1475
|
-
* The ISO-4217 currency code for the currency.
|
|
1476
|
-
* @type {string}
|
|
1477
|
-
* @memberof AccountOrderRecordQuoteCurrency
|
|
1478
|
-
*/
|
|
1479
|
-
'code'?: string;
|
|
1480
|
-
/**
|
|
1481
|
-
* A human-friendly name of the currency.
|
|
1482
|
-
* @type {string}
|
|
1483
|
-
* @memberof AccountOrderRecordQuoteCurrency
|
|
1484
|
-
*/
|
|
1485
|
-
'name'?: string;
|
|
1486
|
-
}
|
|
1498
|
+
type OptionsSymbolNullableOptionTypeEnum = 'CALL' | 'PUT';
|
|
1487
1499
|
//#endregion
|
|
1488
|
-
//#region models/
|
|
1500
|
+
//#region models/trailing-stop-nullable.d.ts
|
|
1489
1501
|
/**
|
|
1490
|
-
*
|
|
1491
|
-
* @export
|
|
1492
|
-
* @interface AccountOrderRecordQuoteUniversalSymbol
|
|
1493
|
-
*/
|
|
1494
|
-
interface AccountOrderRecordQuoteUniversalSymbol {
|
|
1495
|
-
/**
|
|
1496
|
-
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1497
|
-
* @type {string}
|
|
1498
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1499
|
-
*/
|
|
1500
|
-
'id': string;
|
|
1501
|
-
/**
|
|
1502
|
-
* The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. 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, for example `HBND.U.TO`, `FTN.PR.A.TO`, and `ECF.PRA`.
|
|
1503
|
-
* @type {string}
|
|
1504
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1505
|
-
*/
|
|
1506
|
-
'symbol': string;
|
|
1507
|
-
/**
|
|
1508
|
-
* The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
|
|
1509
|
-
* @type {string}
|
|
1510
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1511
|
-
*/
|
|
1512
|
-
'raw_symbol': string;
|
|
1513
|
-
/**
|
|
1514
|
-
* A human-readable description of the security. This is usually the company name or ETF name.
|
|
1515
|
-
* @type {string}
|
|
1516
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1517
|
-
*/
|
|
1518
|
-
'description'?: string | null;
|
|
1519
|
-
/**
|
|
1520
|
-
*
|
|
1521
|
-
* @type {SymbolCurrency}
|
|
1522
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1523
|
-
*/
|
|
1524
|
-
'currency': SymbolCurrency;
|
|
1525
|
-
/**
|
|
1526
|
-
*
|
|
1527
|
-
* @type {SymbolExchange}
|
|
1528
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1529
|
-
*/
|
|
1530
|
-
'exchange'?: SymbolExchange;
|
|
1531
|
-
/**
|
|
1532
|
-
*
|
|
1533
|
-
* @type {SecurityType}
|
|
1534
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1535
|
-
*/
|
|
1536
|
-
'type': SecurityType;
|
|
1537
|
-
/**
|
|
1538
|
-
* 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
|
|
1539
|
-
* @type {string}
|
|
1540
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1541
|
-
*/
|
|
1542
|
-
'figi_code'?: string | null;
|
|
1543
|
-
/**
|
|
1544
|
-
*
|
|
1545
|
-
* @type {StockInstrumentFigiInstrument}
|
|
1546
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1547
|
-
*/
|
|
1548
|
-
'figi_instrument'?: StockInstrumentFigiInstrument | null;
|
|
1549
|
-
/**
|
|
1550
|
-
* This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
|
|
1551
|
-
* @type {Array<Currency>}
|
|
1552
|
-
* @memberof AccountOrderRecordQuoteUniversalSymbol
|
|
1553
|
-
* @deprecated
|
|
1554
|
-
*/
|
|
1555
|
-
'currencies': Array<Currency>;
|
|
1556
|
-
}
|
|
1557
|
-
//#endregion
|
|
1558
|
-
//#region models/account-order-record-status.d.ts
|
|
1559
|
-
/**
|
|
1560
|
-
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED
|
|
1561
|
-
* @export
|
|
1562
|
-
* @enum {string}
|
|
1563
|
-
*/
|
|
1564
|
-
type AccountOrderRecordStatus = 'NONE' | 'PENDING' | 'ACCEPTED' | 'FAILED' | 'REJECTED' | 'CANCELED' | 'PARTIAL_CANCELED' | 'CANCEL_PENDING' | 'EXECUTED' | 'PARTIAL' | 'REPLACE_PENDING' | 'REPLACED' | 'STOPPED' | 'SUSPENDED' | 'EXPIRED' | 'QUEUED' | 'TRIGGERED' | 'ACTIVATED' | 'PENDING_RISK_REVIEW' | 'CONTINGENT_ORDER';
|
|
1565
|
-
//#endregion
|
|
1566
|
-
//#region models/account-order-record-trailing-stop.d.ts
|
|
1567
|
-
/**
|
|
1568
|
-
* For trailing stop orders, contains the trail configuration. Null for all other order types.
|
|
1502
|
+
* Trail configuration for trailing stop orders.
|
|
1569
1503
|
* @export
|
|
1570
|
-
* @interface
|
|
1504
|
+
* @interface TrailingStopNullable
|
|
1571
1505
|
*/
|
|
1572
|
-
interface
|
|
1506
|
+
interface TrailingStopNullable {
|
|
1507
|
+
[key: string]: any;
|
|
1573
1508
|
/**
|
|
1574
1509
|
* The trail amount. Interpreted as dollars if `type` is `DOLLAR`, or a percentage if `type` is `PERCENT`.
|
|
1575
1510
|
* @type {string}
|
|
1576
|
-
* @memberof
|
|
1511
|
+
* @memberof TrailingStopNullable
|
|
1577
1512
|
*/
|
|
1578
1513
|
'amount': string;
|
|
1579
1514
|
/**
|
|
1580
1515
|
* Whether the trail `amount` is a dollar amount (`DOLLAR`) or a percentage (`PERCENT`). For example, if `amount` is \"0.60\" and `type` is `DOLLAR`, the stop price will trail the market price by $0.60. If `amount` is \"5\" and `type` is `PERCENT`, the stop price will trail the market price by 5%.
|
|
1581
1516
|
* @type {string}
|
|
1582
|
-
* @memberof
|
|
1517
|
+
* @memberof TrailingStopNullable
|
|
1583
1518
|
*/
|
|
1584
|
-
'type':
|
|
1519
|
+
'type': TrailingStopNullableTypeEnum;
|
|
1585
1520
|
}
|
|
1586
|
-
type
|
|
1521
|
+
type TrailingStopNullableTypeEnum = 'DOLLAR' | 'PERCENT';
|
|
1587
1522
|
//#endregion
|
|
1588
|
-
//#region models/
|
|
1523
|
+
//#region models/universal-symbol-nullable.d.ts
|
|
1589
1524
|
/**
|
|
1590
|
-
*
|
|
1525
|
+
* Uniquely describes a single security + exchange combination across all brokerages.
|
|
1591
1526
|
* @export
|
|
1592
|
-
* @interface
|
|
1527
|
+
* @interface UniversalSymbolNullable
|
|
1593
1528
|
*/
|
|
1594
|
-
interface
|
|
1529
|
+
interface UniversalSymbolNullable {
|
|
1530
|
+
[key: string]: any;
|
|
1595
1531
|
/**
|
|
1596
1532
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
1597
1533
|
* @type {string}
|
|
1598
|
-
* @memberof
|
|
1534
|
+
* @memberof UniversalSymbolNullable
|
|
1599
1535
|
*/
|
|
1600
1536
|
'id': string;
|
|
1601
1537
|
/**
|
|
1602
1538
|
* The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. 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, for example `HBND.U.TO`, `FTN.PR.A.TO`, and `ECF.PRA`.
|
|
1603
1539
|
* @type {string}
|
|
1604
|
-
* @memberof
|
|
1540
|
+
* @memberof UniversalSymbolNullable
|
|
1605
1541
|
*/
|
|
1606
1542
|
'symbol': string;
|
|
1607
1543
|
/**
|
|
1608
1544
|
* The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
|
|
1609
1545
|
* @type {string}
|
|
1610
|
-
* @memberof
|
|
1546
|
+
* @memberof UniversalSymbolNullable
|
|
1611
1547
|
*/
|
|
1612
1548
|
'raw_symbol': string;
|
|
1613
1549
|
/**
|
|
1614
1550
|
* A human-readable description of the security. This is usually the company name or ETF name.
|
|
1615
1551
|
* @type {string}
|
|
1616
|
-
* @memberof
|
|
1552
|
+
* @memberof UniversalSymbolNullable
|
|
1617
1553
|
*/
|
|
1618
1554
|
'description'?: string | null;
|
|
1619
1555
|
/**
|
|
1620
1556
|
*
|
|
1621
1557
|
* @type {SymbolCurrency}
|
|
1622
|
-
* @memberof
|
|
1558
|
+
* @memberof UniversalSymbolNullable
|
|
1623
1559
|
*/
|
|
1624
1560
|
'currency': SymbolCurrency;
|
|
1625
1561
|
/**
|
|
1626
1562
|
*
|
|
1627
1563
|
* @type {SymbolExchange}
|
|
1628
|
-
* @memberof
|
|
1564
|
+
* @memberof UniversalSymbolNullable
|
|
1629
1565
|
*/
|
|
1630
1566
|
'exchange'?: SymbolExchange;
|
|
1631
1567
|
/**
|
|
1632
1568
|
*
|
|
1633
1569
|
* @type {SecurityType}
|
|
1634
|
-
* @memberof
|
|
1570
|
+
* @memberof UniversalSymbolNullable
|
|
1635
1571
|
*/
|
|
1636
1572
|
'type': SecurityType;
|
|
1637
1573
|
/**
|
|
1638
1574
|
* 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
|
|
1639
1575
|
* @type {string}
|
|
1640
|
-
* @memberof
|
|
1576
|
+
* @memberof UniversalSymbolNullable
|
|
1641
1577
|
*/
|
|
1642
1578
|
'figi_code'?: string | null;
|
|
1643
1579
|
/**
|
|
1644
1580
|
*
|
|
1645
|
-
* @type {
|
|
1646
|
-
* @memberof
|
|
1581
|
+
* @type {FigiInstrumentNullable}
|
|
1582
|
+
* @memberof UniversalSymbolNullable
|
|
1647
1583
|
*/
|
|
1648
|
-
'figi_instrument'?:
|
|
1584
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
1649
1585
|
/**
|
|
1650
1586
|
* This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
|
|
1651
1587
|
* @type {Array<Currency>}
|
|
1652
|
-
* @memberof
|
|
1588
|
+
* @memberof UniversalSymbolNullable
|
|
1653
1589
|
* @deprecated
|
|
1654
1590
|
*/
|
|
1655
1591
|
'currencies': Array<Currency>;
|
|
@@ -1689,28 +1625,28 @@ interface AccountOrderRecord {
|
|
|
1689
1625
|
'status'?: AccountOrderRecordStatus;
|
|
1690
1626
|
/**
|
|
1691
1627
|
*
|
|
1692
|
-
* @type {
|
|
1628
|
+
* @type {UniversalSymbolNullable}
|
|
1693
1629
|
* @memberof AccountOrderRecord
|
|
1694
1630
|
*/
|
|
1695
|
-
'universal_symbol'?:
|
|
1631
|
+
'universal_symbol'?: UniversalSymbolNullable | null;
|
|
1696
1632
|
/**
|
|
1697
1633
|
*
|
|
1698
|
-
* @type {
|
|
1634
|
+
* @type {OptionsSymbolNullable}
|
|
1699
1635
|
* @memberof AccountOrderRecord
|
|
1700
1636
|
*/
|
|
1701
|
-
'option_symbol'?:
|
|
1637
|
+
'option_symbol'?: OptionsSymbolNullable | null;
|
|
1702
1638
|
/**
|
|
1703
1639
|
*
|
|
1704
|
-
* @type {
|
|
1640
|
+
* @type {UniversalSymbolNullable}
|
|
1705
1641
|
* @memberof AccountOrderRecord
|
|
1706
1642
|
*/
|
|
1707
|
-
'quote_universal_symbol'?:
|
|
1643
|
+
'quote_universal_symbol'?: UniversalSymbolNullable | null;
|
|
1708
1644
|
/**
|
|
1709
1645
|
*
|
|
1710
|
-
* @type {
|
|
1646
|
+
* @type {CurrencyNullable}
|
|
1711
1647
|
* @memberof AccountOrderRecord
|
|
1712
1648
|
*/
|
|
1713
|
-
'quote_currency'?:
|
|
1649
|
+
'quote_currency'?: CurrencyNullable | null;
|
|
1714
1650
|
/**
|
|
1715
1651
|
* The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
|
|
1716
1652
|
* @type {string}
|
|
@@ -1761,10 +1697,10 @@ interface AccountOrderRecord {
|
|
|
1761
1697
|
'stop_price'?: string | null;
|
|
1762
1698
|
/**
|
|
1763
1699
|
*
|
|
1764
|
-
* @type {
|
|
1700
|
+
* @type {TrailingStopNullable}
|
|
1765
1701
|
* @memberof AccountOrderRecord
|
|
1766
1702
|
*/
|
|
1767
|
-
'trailing_stop'?:
|
|
1703
|
+
'trailing_stop'?: TrailingStopNullable | null;
|
|
1768
1704
|
/**
|
|
1769
1705
|
* The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage\'s order type value.
|
|
1770
1706
|
* @type {string}
|
|
@@ -1810,10 +1746,10 @@ interface AccountOrderRecord {
|
|
|
1810
1746
|
'symbol'?: string;
|
|
1811
1747
|
/**
|
|
1812
1748
|
*
|
|
1813
|
-
* @type {
|
|
1749
|
+
* @type {ChildBrokerageOrderIDsNullable}
|
|
1814
1750
|
* @memberof AccountOrderRecord
|
|
1815
1751
|
*/
|
|
1816
|
-
'child_brokerage_order_ids'?:
|
|
1752
|
+
'child_brokerage_order_ids'?: ChildBrokerageOrderIDsNullable | null;
|
|
1817
1753
|
}
|
|
1818
1754
|
type AccountOrderRecordOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
1819
1755
|
//#endregion
|
|
@@ -1900,33 +1836,6 @@ interface OptionBrokerageSymbol {
|
|
|
1900
1836
|
'description'?: string;
|
|
1901
1837
|
}
|
|
1902
1838
|
//#endregion
|
|
1903
|
-
//#region models/options-position-currency.d.ts
|
|
1904
|
-
/**
|
|
1905
|
-
* The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
|
|
1906
|
-
* @export
|
|
1907
|
-
* @interface OptionsPositionCurrency
|
|
1908
|
-
*/
|
|
1909
|
-
interface OptionsPositionCurrency {
|
|
1910
|
-
/**
|
|
1911
|
-
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
1912
|
-
* @type {string}
|
|
1913
|
-
* @memberof OptionsPositionCurrency
|
|
1914
|
-
*/
|
|
1915
|
-
'id'?: string;
|
|
1916
|
-
/**
|
|
1917
|
-
* The ISO-4217 currency code for the currency.
|
|
1918
|
-
* @type {string}
|
|
1919
|
-
* @memberof OptionsPositionCurrency
|
|
1920
|
-
*/
|
|
1921
|
-
'code'?: string;
|
|
1922
|
-
/**
|
|
1923
|
-
* A human-friendly name of the currency.
|
|
1924
|
-
* @type {string}
|
|
1925
|
-
* @memberof OptionsPositionCurrency
|
|
1926
|
-
*/
|
|
1927
|
-
'name'?: string;
|
|
1928
|
-
}
|
|
1929
|
-
//#endregion
|
|
1930
1839
|
//#region models/options-position.d.ts
|
|
1931
1840
|
/**
|
|
1932
1841
|
* Describes a single option position in an account.
|
|
@@ -1961,11 +1870,10 @@ interface OptionsPosition {
|
|
|
1961
1870
|
'average_purchase_price'?: number | null;
|
|
1962
1871
|
/**
|
|
1963
1872
|
*
|
|
1964
|
-
* @type {
|
|
1873
|
+
* @type {CurrencyNullable}
|
|
1965
1874
|
* @memberof OptionsPosition
|
|
1966
|
-
* @deprecated
|
|
1967
1875
|
*/
|
|
1968
|
-
'currency'?:
|
|
1876
|
+
'currency'?: CurrencyNullable | null;
|
|
1969
1877
|
}
|
|
1970
1878
|
//#endregion
|
|
1971
1879
|
//#region models/account-holdings-account.d.ts
|
|
@@ -2070,13 +1978,13 @@ interface AccountOrderRecordLegInstrument {
|
|
|
2070
1978
|
'figi_code'?: string | null;
|
|
2071
1979
|
}
|
|
2072
1980
|
//#endregion
|
|
2073
|
-
//#region models/account-order-record-status-v2.d.ts
|
|
1981
|
+
//#region models/account-order-record-status-v2-nullable.d.ts
|
|
2074
1982
|
/**
|
|
2075
1983
|
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
|
|
2076
1984
|
* @export
|
|
2077
1985
|
* @enum {string}
|
|
2078
1986
|
*/
|
|
2079
|
-
type
|
|
1987
|
+
type AccountOrderRecordStatusV2Nullable = 'PENDING' | 'REJECTED' | 'CANCELED' | 'CANCEL_PENDING' | 'PARTIAL_CANCELED' | 'EXECUTED' | 'PARTIALLY_EXECUTED' | 'REPLACED' | 'REPLACE_PENDING' | 'EXPIRED';
|
|
2080
1988
|
//#endregion
|
|
2081
1989
|
//#region models/account-order-record-leg.d.ts
|
|
2082
1990
|
/**
|
|
@@ -2130,19 +2038,189 @@ interface AccountOrderRecordLeg {
|
|
|
2130
2038
|
'filled_quantity'?: string | null;
|
|
2131
2039
|
/**
|
|
2132
2040
|
*
|
|
2133
|
-
* @type {
|
|
2041
|
+
* @type {AccountOrderRecordStatusV2Nullable}
|
|
2134
2042
|
* @memberof AccountOrderRecordLeg
|
|
2135
2043
|
*/
|
|
2136
|
-
'status'?:
|
|
2044
|
+
'status'?: AccountOrderRecordStatusV2Nullable | null;
|
|
2137
2045
|
}
|
|
2138
2046
|
//#endregion
|
|
2139
|
-
//#region models/account-order-record-
|
|
2047
|
+
//#region models/account-order-record-nullable.d.ts
|
|
2048
|
+
/**
|
|
2049
|
+
* Describes a single recent order in an account. Each record here represents a single order leg. For multi-leg orders, there will be multiple records.
|
|
2050
|
+
* @export
|
|
2051
|
+
* @interface AccountOrderRecordNullable
|
|
2052
|
+
*/
|
|
2053
|
+
interface AccountOrderRecordNullable {
|
|
2054
|
+
[key: string]: any;
|
|
2055
|
+
/**
|
|
2056
|
+
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
2057
|
+
* @type {string}
|
|
2058
|
+
* @memberof AccountOrderRecordNullable
|
|
2059
|
+
*/
|
|
2060
|
+
'brokerage_order_id'?: string;
|
|
2061
|
+
/**
|
|
2062
|
+
* The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
|
|
2063
|
+
* @type {string}
|
|
2064
|
+
* @memberof AccountOrderRecordNullable
|
|
2065
|
+
*/
|
|
2066
|
+
'brokerage_group_order_id'?: string | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
|
|
2069
|
+
* @type {string}
|
|
2070
|
+
* @memberof AccountOrderRecordNullable
|
|
2071
|
+
*/
|
|
2072
|
+
'order_role'?: AccountOrderRecordNullableOrderRoleEnum;
|
|
2073
|
+
/**
|
|
2074
|
+
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED
|
|
2075
|
+
* @type {AccountOrderRecordStatus}
|
|
2076
|
+
* @memberof AccountOrderRecordNullable
|
|
2077
|
+
*/
|
|
2078
|
+
'status'?: AccountOrderRecordStatus;
|
|
2079
|
+
/**
|
|
2080
|
+
*
|
|
2081
|
+
* @type {UniversalSymbolNullable}
|
|
2082
|
+
* @memberof AccountOrderRecordNullable
|
|
2083
|
+
*/
|
|
2084
|
+
'universal_symbol'?: UniversalSymbolNullable | null;
|
|
2085
|
+
/**
|
|
2086
|
+
*
|
|
2087
|
+
* @type {OptionsSymbolNullable}
|
|
2088
|
+
* @memberof AccountOrderRecordNullable
|
|
2089
|
+
*/
|
|
2090
|
+
'option_symbol'?: OptionsSymbolNullable | null;
|
|
2091
|
+
/**
|
|
2092
|
+
*
|
|
2093
|
+
* @type {UniversalSymbolNullable}
|
|
2094
|
+
* @memberof AccountOrderRecordNullable
|
|
2095
|
+
*/
|
|
2096
|
+
'quote_universal_symbol'?: UniversalSymbolNullable | null;
|
|
2097
|
+
/**
|
|
2098
|
+
*
|
|
2099
|
+
* @type {CurrencyNullable}
|
|
2100
|
+
* @memberof AccountOrderRecordNullable
|
|
2101
|
+
*/
|
|
2102
|
+
'quote_currency'?: CurrencyNullable | null;
|
|
2103
|
+
/**
|
|
2104
|
+
* The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
|
|
2105
|
+
* @type {string}
|
|
2106
|
+
* @memberof AccountOrderRecordNullable
|
|
2107
|
+
*/
|
|
2108
|
+
'action'?: string;
|
|
2109
|
+
/**
|
|
2110
|
+
* The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
|
|
2111
|
+
* @type {string}
|
|
2112
|
+
* @memberof AccountOrderRecordNullable
|
|
2113
|
+
*/
|
|
2114
|
+
'total_quantity'?: string | null;
|
|
2115
|
+
/**
|
|
2116
|
+
* The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
|
|
2117
|
+
* @type {string}
|
|
2118
|
+
* @memberof AccountOrderRecordNullable
|
|
2119
|
+
*/
|
|
2120
|
+
'open_quantity'?: string | null;
|
|
2121
|
+
/**
|
|
2122
|
+
* The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
|
|
2123
|
+
* @type {string}
|
|
2124
|
+
* @memberof AccountOrderRecordNullable
|
|
2125
|
+
*/
|
|
2126
|
+
'canceled_quantity'?: string | null;
|
|
2127
|
+
/**
|
|
2128
|
+
* The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
|
|
2129
|
+
* @type {string}
|
|
2130
|
+
* @memberof AccountOrderRecordNullable
|
|
2131
|
+
*/
|
|
2132
|
+
'filled_quantity'?: string | null;
|
|
2133
|
+
/**
|
|
2134
|
+
* The price at which the order was executed. For option orders, this represents the price per share.
|
|
2135
|
+
* @type {string}
|
|
2136
|
+
* @memberof AccountOrderRecordNullable
|
|
2137
|
+
*/
|
|
2138
|
+
'execution_price'?: string | null;
|
|
2139
|
+
/**
|
|
2140
|
+
* The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. For option orders, this represents the price per share.
|
|
2141
|
+
* @type {string}
|
|
2142
|
+
* @memberof AccountOrderRecordNullable
|
|
2143
|
+
*/
|
|
2144
|
+
'limit_price'?: string | null;
|
|
2145
|
+
/**
|
|
2146
|
+
* The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. For option orders, this represents the price per share.
|
|
2147
|
+
* @type {string}
|
|
2148
|
+
* @memberof AccountOrderRecordNullable
|
|
2149
|
+
*/
|
|
2150
|
+
'stop_price'?: string | null;
|
|
2151
|
+
/**
|
|
2152
|
+
*
|
|
2153
|
+
* @type {TrailingStopNullable}
|
|
2154
|
+
* @memberof AccountOrderRecordNullable
|
|
2155
|
+
*/
|
|
2156
|
+
'trailing_stop'?: TrailingStopNullable | null;
|
|
2157
|
+
/**
|
|
2158
|
+
* The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage\'s order type value.
|
|
2159
|
+
* @type {string}
|
|
2160
|
+
* @memberof AccountOrderRecordNullable
|
|
2161
|
+
*/
|
|
2162
|
+
'order_type'?: string | null;
|
|
2163
|
+
/**
|
|
2164
|
+
* The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value. - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date. - `MOO` - Market On Open. The order is to be executed at the day\'s opening price. - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
|
|
2165
|
+
* @type {string}
|
|
2166
|
+
* @memberof AccountOrderRecordNullable
|
|
2167
|
+
*/
|
|
2168
|
+
'time_in_force'?: string;
|
|
2169
|
+
/**
|
|
2170
|
+
* The time the order was placed. This is the time the order was submitted to the brokerage.
|
|
2171
|
+
* @type {string}
|
|
2172
|
+
* @memberof AccountOrderRecordNullable
|
|
2173
|
+
*/
|
|
2174
|
+
'time_placed'?: string;
|
|
2175
|
+
/**
|
|
2176
|
+
* The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
|
|
2177
|
+
* @type {string}
|
|
2178
|
+
* @memberof AccountOrderRecordNullable
|
|
2179
|
+
*/
|
|
2180
|
+
'time_updated'?: string | null;
|
|
2181
|
+
/**
|
|
2182
|
+
* The time the order was executed in the brokerage system. This value is not always available from the brokerage.
|
|
2183
|
+
* @type {string}
|
|
2184
|
+
* @memberof AccountOrderRecordNullable
|
|
2185
|
+
*/
|
|
2186
|
+
'time_executed'?: string | null;
|
|
2187
|
+
/**
|
|
2188
|
+
* The time the order expires. This value is not always available from the brokerage.
|
|
2189
|
+
* @type {string}
|
|
2190
|
+
* @memberof AccountOrderRecordNullable
|
|
2191
|
+
*/
|
|
2192
|
+
'expiry_date'?: string | null;
|
|
2193
|
+
/**
|
|
2194
|
+
* A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
|
|
2195
|
+
* @type {string}
|
|
2196
|
+
* @memberof AccountOrderRecordNullable
|
|
2197
|
+
* @deprecated
|
|
2198
|
+
*/
|
|
2199
|
+
'symbol'?: string;
|
|
2200
|
+
/**
|
|
2201
|
+
*
|
|
2202
|
+
* @type {ChildBrokerageOrderIDsNullable}
|
|
2203
|
+
* @memberof AccountOrderRecordNullable
|
|
2204
|
+
*/
|
|
2205
|
+
'child_brokerage_order_ids'?: ChildBrokerageOrderIDsNullable | null;
|
|
2206
|
+
}
|
|
2207
|
+
type AccountOrderRecordNullableOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
2208
|
+
//#endregion
|
|
2209
|
+
//#region models/account-order-record-status-v2.d.ts
|
|
2210
|
+
/**
|
|
2211
|
+
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
|
|
2212
|
+
* @export
|
|
2213
|
+
* @enum {string}
|
|
2214
|
+
*/
|
|
2215
|
+
type AccountOrderRecordStatusV2 = 'PENDING' | 'REJECTED' | 'CANCELED' | 'CANCEL_PENDING' | 'PARTIAL_CANCELED' | 'EXECUTED' | 'PARTIALLY_EXECUTED' | 'REPLACED' | 'REPLACE_PENDING' | 'EXPIRED';
|
|
2216
|
+
//#endregion
|
|
2217
|
+
//#region models/account-order-record-v2-order-role-nullable.d.ts
|
|
2140
2218
|
/**
|
|
2141
2219
|
* The role of an order within a complex order group (OCO, OTO, OTOCO).
|
|
2142
2220
|
* @export
|
|
2143
2221
|
* @enum {string}
|
|
2144
2222
|
*/
|
|
2145
|
-
type
|
|
2223
|
+
type AccountOrderRecordV2OrderRoleNullable = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
2146
2224
|
//#endregion
|
|
2147
2225
|
//#region models/account-order-record-v2.d.ts
|
|
2148
2226
|
/**
|
|
@@ -2165,11 +2243,11 @@ interface AccountOrderRecordV2 {
|
|
|
2165
2243
|
*/
|
|
2166
2244
|
'brokerage_group_order_id'?: string | null;
|
|
2167
2245
|
/**
|
|
2168
|
-
*
|
|
2169
|
-
* @type {
|
|
2246
|
+
*
|
|
2247
|
+
* @type {AccountOrderRecordV2OrderRoleNullable}
|
|
2170
2248
|
* @memberof AccountOrderRecordV2
|
|
2171
2249
|
*/
|
|
2172
|
-
'order_role'?:
|
|
2250
|
+
'order_role'?: AccountOrderRecordV2OrderRoleNullable | null;
|
|
2173
2251
|
/**
|
|
2174
2252
|
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED
|
|
2175
2253
|
* @type {AccountOrderRecordStatus}
|
|
@@ -2232,10 +2310,10 @@ interface AccountOrderRecordV2 {
|
|
|
2232
2310
|
'stop_price'?: string | null;
|
|
2233
2311
|
/**
|
|
2234
2312
|
*
|
|
2235
|
-
* @type {
|
|
2313
|
+
* @type {TrailingStopNullable}
|
|
2236
2314
|
* @memberof AccountOrderRecordV2
|
|
2237
2315
|
*/
|
|
2238
|
-
'trailing_stop'?:
|
|
2316
|
+
'trailing_stop'?: TrailingStopNullable | null;
|
|
2239
2317
|
/**
|
|
2240
2318
|
* List of legs that make up the order.
|
|
2241
2319
|
* @type {Array<AccountOrderRecordLeg>}
|
|
@@ -2245,6 +2323,14 @@ interface AccountOrderRecordV2 {
|
|
|
2245
2323
|
}
|
|
2246
2324
|
type AccountOrderRecordV2PriceEffectEnum = 'CREDIT' | 'DEBIT' | 'EVEN' | 'UNKNOWN';
|
|
2247
2325
|
//#endregion
|
|
2326
|
+
//#region models/account-order-record-v2-order-role.d.ts
|
|
2327
|
+
/**
|
|
2328
|
+
* The role of an order within a complex order group (OCO, OTO, OTOCO).
|
|
2329
|
+
* @export
|
|
2330
|
+
* @enum {string}
|
|
2331
|
+
*/
|
|
2332
|
+
type AccountOrderRecordV2OrderRole = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
2333
|
+
//#endregion
|
|
2248
2334
|
//#region models/account-orders-v2-response.d.ts
|
|
2249
2335
|
/**
|
|
2250
2336
|
* Contains a standardized list of account orders in the V2 format.
|
|
@@ -2313,10 +2399,10 @@ interface AdrInstrument {
|
|
|
2313
2399
|
'exchange'?: string | null;
|
|
2314
2400
|
/**
|
|
2315
2401
|
*
|
|
2316
|
-
* @type {
|
|
2402
|
+
* @type {FigiInstrumentNullable}
|
|
2317
2403
|
* @memberof AdrInstrument
|
|
2318
2404
|
*/
|
|
2319
|
-
'figi_instrument'?:
|
|
2405
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2320
2406
|
}
|
|
2321
2407
|
type AdrInstrumentKindEnum = 'adr';
|
|
2322
2408
|
//#endregion
|
|
@@ -2372,10 +2458,10 @@ interface CefInstrument {
|
|
|
2372
2458
|
'exchange'?: string | null;
|
|
2373
2459
|
/**
|
|
2374
2460
|
*
|
|
2375
|
-
* @type {
|
|
2461
|
+
* @type {FigiInstrumentNullable}
|
|
2376
2462
|
* @memberof CefInstrument
|
|
2377
2463
|
*/
|
|
2378
|
-
'figi_instrument'?:
|
|
2464
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2379
2465
|
}
|
|
2380
2466
|
type CefInstrumentKindEnum = 'cef';
|
|
2381
2467
|
//#endregion
|
|
@@ -2431,10 +2517,10 @@ interface CryptoInstrument {
|
|
|
2431
2517
|
'exchange'?: string | null;
|
|
2432
2518
|
/**
|
|
2433
2519
|
*
|
|
2434
|
-
* @type {
|
|
2520
|
+
* @type {FigiInstrumentNullable}
|
|
2435
2521
|
* @memberof CryptoInstrument
|
|
2436
2522
|
*/
|
|
2437
|
-
'figi_instrument'?:
|
|
2523
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2438
2524
|
}
|
|
2439
2525
|
type CryptoInstrumentKindEnum = 'crypto';
|
|
2440
2526
|
//#endregion
|
|
@@ -2490,10 +2576,10 @@ interface EtfInstrument {
|
|
|
2490
2576
|
'exchange'?: string | null;
|
|
2491
2577
|
/**
|
|
2492
2578
|
*
|
|
2493
|
-
* @type {
|
|
2579
|
+
* @type {FigiInstrumentNullable}
|
|
2494
2580
|
* @memberof EtfInstrument
|
|
2495
2581
|
*/
|
|
2496
|
-
'figi_instrument'?:
|
|
2582
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2497
2583
|
}
|
|
2498
2584
|
type EtfInstrumentKindEnum = 'etf';
|
|
2499
2585
|
//#endregion
|
|
@@ -2549,10 +2635,10 @@ interface MutualFundInstrument {
|
|
|
2549
2635
|
'exchange'?: string | null;
|
|
2550
2636
|
/**
|
|
2551
2637
|
*
|
|
2552
|
-
* @type {
|
|
2638
|
+
* @type {FigiInstrumentNullable}
|
|
2553
2639
|
* @memberof MutualFundInstrument
|
|
2554
2640
|
*/
|
|
2555
|
-
'figi_instrument'?:
|
|
2641
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2556
2642
|
}
|
|
2557
2643
|
type MutualFundInstrumentKindEnum = 'mutualfund';
|
|
2558
2644
|
//#endregion
|
|
@@ -2608,10 +2694,10 @@ interface OtherInstrument {
|
|
|
2608
2694
|
'exchange'?: string | null;
|
|
2609
2695
|
/**
|
|
2610
2696
|
*
|
|
2611
|
-
* @type {
|
|
2697
|
+
* @type {FigiInstrumentNullable}
|
|
2612
2698
|
* @memberof OtherInstrument
|
|
2613
2699
|
*/
|
|
2614
|
-
'figi_instrument'?:
|
|
2700
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2615
2701
|
}
|
|
2616
2702
|
type OtherInstrumentKindEnum = 'bond' | 'other';
|
|
2617
2703
|
//#endregion
|
|
@@ -2667,10 +2753,10 @@ interface StockInstrument {
|
|
|
2667
2753
|
'exchange'?: string | null;
|
|
2668
2754
|
/**
|
|
2669
2755
|
*
|
|
2670
|
-
* @type {
|
|
2756
|
+
* @type {FigiInstrumentNullable}
|
|
2671
2757
|
* @memberof StockInstrument
|
|
2672
2758
|
*/
|
|
2673
|
-
'figi_instrument'?:
|
|
2759
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
2674
2760
|
}
|
|
2675
2761
|
type StockInstrumentKindEnum = 'stock';
|
|
2676
2762
|
//#endregion
|
|
@@ -3140,238 +3226,97 @@ interface AccountSimple {
|
|
|
3140
3226
|
/**
|
|
3141
3227
|
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
3142
3228
|
* @type {string}
|
|
3143
|
-
* @memberof AccountSimple
|
|
3144
|
-
*/
|
|
3145
|
-
'id'?: string;
|
|
3146
|
-
/**
|
|
3147
|
-
* A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
|
|
3148
|
-
* @type {string}
|
|
3149
|
-
* @memberof AccountSimple
|
|
3150
|
-
*/
|
|
3151
|
-
'name'?: string;
|
|
3152
|
-
/**
|
|
3153
|
-
* The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
|
|
3154
|
-
* @type {string}
|
|
3155
|
-
* @memberof AccountSimple
|
|
3156
|
-
*/
|
|
3157
|
-
'number'?: string;
|
|
3158
|
-
/**
|
|
3159
|
-
* A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
|
|
3160
|
-
* @type {string}
|
|
3161
|
-
* @memberof AccountSimple
|
|
3162
|
-
*/
|
|
3163
|
-
'institution_account_id'?: string | null;
|
|
3164
|
-
/**
|
|
3165
|
-
*
|
|
3166
|
-
* @type {AccountSyncStatus}
|
|
3167
|
-
* @memberof AccountSimple
|
|
3168
|
-
*/
|
|
3169
|
-
'sync_status'?: AccountSyncStatus;
|
|
3170
|
-
}
|
|
3171
|
-
//#endregion
|
|
3172
|
-
//#region models/account-universal-activity-currency.d.ts
|
|
3173
|
-
/**
|
|
3174
|
-
* The currency in which the transaction `price`, `amount`, and `fee` are denominated. This is `null` when those values are denominated in `currency_universal_symbol`.
|
|
3175
|
-
* @export
|
|
3176
|
-
* @interface AccountUniversalActivityCurrency
|
|
3177
|
-
*/
|
|
3178
|
-
interface AccountUniversalActivityCurrency {
|
|
3179
|
-
/**
|
|
3180
|
-
* Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
|
|
3181
|
-
* @type {string}
|
|
3182
|
-
* @memberof AccountUniversalActivityCurrency
|
|
3183
|
-
*/
|
|
3184
|
-
'id'?: string;
|
|
3185
|
-
/**
|
|
3186
|
-
* The ISO-4217 currency code for the currency.
|
|
3187
|
-
* @type {string}
|
|
3188
|
-
* @memberof AccountUniversalActivityCurrency
|
|
3189
|
-
*/
|
|
3190
|
-
'code'?: string;
|
|
3191
|
-
/**
|
|
3192
|
-
* A human-friendly name of the currency.
|
|
3193
|
-
* @type {string}
|
|
3194
|
-
* @memberof AccountUniversalActivityCurrency
|
|
3195
|
-
*/
|
|
3196
|
-
'name'?: string;
|
|
3197
|
-
}
|
|
3198
|
-
//#endregion
|
|
3199
|
-
//#region models/account-universal-activity-currency-universal-symbol.d.ts
|
|
3200
|
-
/**
|
|
3201
|
-
* The quote security for the transaction when `price`, `amount`, and `fee` are denominated in a security instead of a fiat currency. This is most common for cryptocurrency trades. The field is `null` when the transaction is denominated in `currency`.
|
|
3202
|
-
* @export
|
|
3203
|
-
* @interface AccountUniversalActivityCurrencyUniversalSymbol
|
|
3204
|
-
*/
|
|
3205
|
-
interface AccountUniversalActivityCurrencyUniversalSymbol {
|
|
3206
|
-
/**
|
|
3207
|
-
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
3208
|
-
* @type {string}
|
|
3209
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3210
|
-
*/
|
|
3211
|
-
'id'?: string;
|
|
3212
|
-
/**
|
|
3213
|
-
* The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. 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, for example `HBND.U.TO`, `FTN.PR.A.TO`, and `ECF.PRA`.
|
|
3214
|
-
* @type {string}
|
|
3215
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3216
|
-
*/
|
|
3217
|
-
'symbol'?: string;
|
|
3218
|
-
/**
|
|
3219
|
-
* The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
|
|
3220
|
-
* @type {string}
|
|
3221
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3222
|
-
*/
|
|
3223
|
-
'raw_symbol'?: string;
|
|
3224
|
-
/**
|
|
3225
|
-
* A human-readable description of the security. This is usually the company name or ETF name.
|
|
3226
|
-
* @type {string}
|
|
3227
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3228
|
-
*/
|
|
3229
|
-
'description'?: string | null;
|
|
3230
|
-
/**
|
|
3231
|
-
*
|
|
3232
|
-
* @type {SymbolCurrency}
|
|
3233
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3234
|
-
*/
|
|
3235
|
-
'currency'?: SymbolCurrency;
|
|
3236
|
-
/**
|
|
3237
|
-
*
|
|
3238
|
-
* @type {SymbolExchange}
|
|
3239
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3240
|
-
*/
|
|
3241
|
-
'exchange'?: SymbolExchange;
|
|
3242
|
-
/**
|
|
3243
|
-
*
|
|
3244
|
-
* @type {SecurityType}
|
|
3245
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3246
|
-
*/
|
|
3247
|
-
'type'?: SecurityType;
|
|
3248
|
-
/**
|
|
3249
|
-
* 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
|
|
3250
|
-
* @type {string}
|
|
3251
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3252
|
-
*/
|
|
3253
|
-
'figi_code'?: string | null;
|
|
3254
|
-
/**
|
|
3255
|
-
*
|
|
3256
|
-
* @type {StockInstrumentFigiInstrument}
|
|
3257
|
-
* @memberof AccountUniversalActivityCurrencyUniversalSymbol
|
|
3258
|
-
*/
|
|
3259
|
-
'figi_instrument'?: StockInstrumentFigiInstrument | null;
|
|
3260
|
-
}
|
|
3261
|
-
//#endregion
|
|
3262
|
-
//#region models/account-universal-activity-option-symbol.d.ts
|
|
3263
|
-
/**
|
|
3264
|
-
* The option security for the transaction. The field is `null` if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage\'s option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to `null`.
|
|
3265
|
-
* @export
|
|
3266
|
-
* @interface AccountUniversalActivityOptionSymbol
|
|
3267
|
-
*/
|
|
3268
|
-
interface AccountUniversalActivityOptionSymbol {
|
|
3269
|
-
/**
|
|
3270
|
-
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
3271
|
-
* @type {string}
|
|
3272
|
-
* @memberof AccountUniversalActivityOptionSymbol
|
|
3273
|
-
*/
|
|
3274
|
-
'id': string;
|
|
3275
|
-
/**
|
|
3276
|
-
* The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
|
|
3277
|
-
* @type {string}
|
|
3278
|
-
* @memberof AccountUniversalActivityOptionSymbol
|
|
3279
|
-
*/
|
|
3280
|
-
'ticker': string;
|
|
3281
|
-
/**
|
|
3282
|
-
* The type of option. Either \"CALL\" or \"PUT\".
|
|
3283
|
-
* @type {string}
|
|
3284
|
-
* @memberof AccountUniversalActivityOptionSymbol
|
|
3229
|
+
* @memberof AccountSimple
|
|
3285
3230
|
*/
|
|
3286
|
-
'
|
|
3231
|
+
'id'?: string;
|
|
3287
3232
|
/**
|
|
3288
|
-
*
|
|
3289
|
-
* @type {
|
|
3290
|
-
* @memberof
|
|
3233
|
+
* A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
|
|
3234
|
+
* @type {string}
|
|
3235
|
+
* @memberof AccountSimple
|
|
3291
3236
|
*/
|
|
3292
|
-
'
|
|
3237
|
+
'name'?: string;
|
|
3293
3238
|
/**
|
|
3294
|
-
* The
|
|
3239
|
+
* The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
|
|
3295
3240
|
* @type {string}
|
|
3296
|
-
* @memberof
|
|
3241
|
+
* @memberof AccountSimple
|
|
3297
3242
|
*/
|
|
3298
|
-
'
|
|
3243
|
+
'number'?: string;
|
|
3299
3244
|
/**
|
|
3300
|
-
*
|
|
3301
|
-
* @type {
|
|
3302
|
-
* @memberof
|
|
3245
|
+
* A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
|
|
3246
|
+
* @type {string}
|
|
3247
|
+
* @memberof AccountSimple
|
|
3303
3248
|
*/
|
|
3304
|
-
'
|
|
3249
|
+
'institution_account_id'?: string | null;
|
|
3305
3250
|
/**
|
|
3306
3251
|
*
|
|
3307
|
-
* @type {
|
|
3308
|
-
* @memberof
|
|
3252
|
+
* @type {AccountSyncStatus}
|
|
3253
|
+
* @memberof AccountSimple
|
|
3309
3254
|
*/
|
|
3310
|
-
'
|
|
3255
|
+
'sync_status'?: AccountSyncStatus;
|
|
3311
3256
|
}
|
|
3312
|
-
type AccountUniversalActivityOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
|
|
3313
3257
|
//#endregion
|
|
3314
|
-
//#region models/
|
|
3258
|
+
//#region models/symbol-nullable.d.ts
|
|
3315
3259
|
/**
|
|
3316
|
-
*
|
|
3260
|
+
* Uniquely describes a single security + exchange combination across all brokerages.
|
|
3317
3261
|
* @export
|
|
3318
|
-
* @interface
|
|
3262
|
+
* @interface SymbolNullable
|
|
3319
3263
|
*/
|
|
3320
|
-
interface
|
|
3264
|
+
interface SymbolNullable {
|
|
3265
|
+
[key: string]: any;
|
|
3321
3266
|
/**
|
|
3322
3267
|
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
3323
3268
|
* @type {string}
|
|
3324
|
-
* @memberof
|
|
3269
|
+
* @memberof SymbolNullable
|
|
3325
3270
|
*/
|
|
3326
3271
|
'id'?: string;
|
|
3327
3272
|
/**
|
|
3328
3273
|
* The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. 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, for example `HBND.U.TO`, `FTN.PR.A.TO`, and `ECF.PRA`.
|
|
3329
3274
|
* @type {string}
|
|
3330
|
-
* @memberof
|
|
3275
|
+
* @memberof SymbolNullable
|
|
3331
3276
|
*/
|
|
3332
3277
|
'symbol'?: string;
|
|
3333
3278
|
/**
|
|
3334
3279
|
* The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
|
|
3335
3280
|
* @type {string}
|
|
3336
|
-
* @memberof
|
|
3281
|
+
* @memberof SymbolNullable
|
|
3337
3282
|
*/
|
|
3338
3283
|
'raw_symbol'?: string;
|
|
3339
3284
|
/**
|
|
3340
3285
|
* A human-readable description of the security. This is usually the company name or ETF name.
|
|
3341
3286
|
* @type {string}
|
|
3342
|
-
* @memberof
|
|
3287
|
+
* @memberof SymbolNullable
|
|
3343
3288
|
*/
|
|
3344
3289
|
'description'?: string | null;
|
|
3345
3290
|
/**
|
|
3346
3291
|
*
|
|
3347
3292
|
* @type {SymbolCurrency}
|
|
3348
|
-
* @memberof
|
|
3293
|
+
* @memberof SymbolNullable
|
|
3349
3294
|
*/
|
|
3350
3295
|
'currency'?: SymbolCurrency;
|
|
3351
3296
|
/**
|
|
3352
3297
|
*
|
|
3353
3298
|
* @type {SymbolExchange}
|
|
3354
|
-
* @memberof
|
|
3299
|
+
* @memberof SymbolNullable
|
|
3355
3300
|
*/
|
|
3356
3301
|
'exchange'?: SymbolExchange;
|
|
3357
3302
|
/**
|
|
3358
3303
|
*
|
|
3359
3304
|
* @type {SecurityType}
|
|
3360
|
-
* @memberof
|
|
3305
|
+
* @memberof SymbolNullable
|
|
3361
3306
|
*/
|
|
3362
3307
|
'type'?: SecurityType;
|
|
3363
3308
|
/**
|
|
3364
3309
|
* 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
|
|
3365
3310
|
* @type {string}
|
|
3366
|
-
* @memberof
|
|
3311
|
+
* @memberof SymbolNullable
|
|
3367
3312
|
*/
|
|
3368
3313
|
'figi_code'?: string | null;
|
|
3369
3314
|
/**
|
|
3370
3315
|
*
|
|
3371
|
-
* @type {
|
|
3372
|
-
* @memberof
|
|
3316
|
+
* @type {FigiInstrumentNullable}
|
|
3317
|
+
* @memberof SymbolNullable
|
|
3373
3318
|
*/
|
|
3374
|
-
'figi_instrument'?:
|
|
3319
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
3375
3320
|
}
|
|
3376
3321
|
//#endregion
|
|
3377
3322
|
//#region models/account-universal-activity.d.ts
|
|
@@ -3390,22 +3335,22 @@ interface AccountUniversalActivity {
|
|
|
3390
3335
|
'id'?: string;
|
|
3391
3336
|
/**
|
|
3392
3337
|
*
|
|
3393
|
-
* @type {
|
|
3338
|
+
* @type {SymbolNullable}
|
|
3394
3339
|
* @memberof AccountUniversalActivity
|
|
3395
3340
|
*/
|
|
3396
|
-
'symbol'?:
|
|
3341
|
+
'symbol'?: SymbolNullable | null;
|
|
3397
3342
|
/**
|
|
3398
3343
|
*
|
|
3399
|
-
* @type {
|
|
3344
|
+
* @type {SymbolNullable}
|
|
3400
3345
|
* @memberof AccountUniversalActivity
|
|
3401
3346
|
*/
|
|
3402
|
-
'currency_universal_symbol'?:
|
|
3347
|
+
'currency_universal_symbol'?: SymbolNullable | null;
|
|
3403
3348
|
/**
|
|
3404
3349
|
*
|
|
3405
|
-
* @type {
|
|
3350
|
+
* @type {OptionsSymbolNullable}
|
|
3406
3351
|
* @memberof AccountUniversalActivity
|
|
3407
3352
|
*/
|
|
3408
|
-
'option_symbol'?:
|
|
3353
|
+
'option_symbol'?: OptionsSymbolNullable | null;
|
|
3409
3354
|
/**
|
|
3410
3355
|
* The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions. For option transactions, this represents the price per share of the option contract.
|
|
3411
3356
|
* @type {number}
|
|
@@ -3426,10 +3371,10 @@ interface AccountUniversalActivity {
|
|
|
3426
3371
|
'amount'?: number | null;
|
|
3427
3372
|
/**
|
|
3428
3373
|
*
|
|
3429
|
-
* @type {
|
|
3374
|
+
* @type {CurrencyNullable}
|
|
3430
3375
|
* @memberof AccountUniversalActivity
|
|
3431
3376
|
*/
|
|
3432
|
-
'currency'?:
|
|
3377
|
+
'currency'?: CurrencyNullable | null;
|
|
3433
3378
|
/**
|
|
3434
3379
|
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `TAX` - A tax related fee. - `OPTIONEXPIRATION` - Option expiration event. - `OPTIONASSIGNMENT` - Option assignment event. - `OPTIONEXERCISE` - Option exercise event. - `TRANSFER` - Transfer of asset(s) from one account to another. - `EXTERNAL_ASSET_TRANSFER_IN` - Incoming transfer of an asset from an external account to this account. - `EXTERNAL_ASSET_TRANSFER_OUT` - Outgoing transfer of an asset from this account to an external account. - `SPLIT` - A stock share split. - `ADJUSTMENT` - A one time adjustment of the account\'s cash balance or shares of an asset
|
|
3435
3380
|
* @type {string}
|
|
@@ -4033,7 +3978,7 @@ interface DepositAccountSyncStatus {
|
|
|
4033
3978
|
*/
|
|
4034
3979
|
'transactions'?: TransactionsStatus;
|
|
4035
3980
|
/**
|
|
4036
|
-
*
|
|
3981
|
+
* Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
|
|
4037
3982
|
* @type {string}
|
|
4038
3983
|
* @memberof DepositAccountSyncStatus
|
|
4039
3984
|
*/
|
|
@@ -4132,19 +4077,19 @@ interface ConnectionAccountSyncStatus {
|
|
|
4132
4077
|
*/
|
|
4133
4078
|
'transactions'?: TransactionsStatus;
|
|
4134
4079
|
/**
|
|
4135
|
-
*
|
|
4080
|
+
* Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
|
|
4136
4081
|
* @type {string}
|
|
4137
4082
|
* @memberof ConnectionAccountSyncStatus
|
|
4138
4083
|
*/
|
|
4139
4084
|
'orders'?: string | null;
|
|
4140
4085
|
/**
|
|
4141
|
-
*
|
|
4086
|
+
* Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
|
|
4142
4087
|
* @type {string}
|
|
4143
4088
|
* @memberof ConnectionAccountSyncStatus
|
|
4144
4089
|
*/
|
|
4145
4090
|
'positions'?: string | null;
|
|
4146
4091
|
/**
|
|
4147
|
-
*
|
|
4092
|
+
* Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
|
|
4148
4093
|
* @type {string}
|
|
4149
4094
|
* @memberof ConnectionAccountSyncStatus
|
|
4150
4095
|
*/
|
|
@@ -4343,7 +4288,7 @@ interface LineOfCreditAccountSyncStatus {
|
|
|
4343
4288
|
*/
|
|
4344
4289
|
'transactions'?: TransactionsStatus;
|
|
4345
4290
|
/**
|
|
4346
|
-
*
|
|
4291
|
+
* Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
|
|
4347
4292
|
* @type {string}
|
|
4348
4293
|
* @memberof LineOfCreditAccountSyncStatus
|
|
4349
4294
|
*/
|
|
@@ -4628,7 +4573,7 @@ interface CryptocurrencyPair {
|
|
|
4628
4573
|
*/
|
|
4629
4574
|
'quote': string;
|
|
4630
4575
|
/**
|
|
4631
|
-
*
|
|
4576
|
+
* The precision or smallest price incremental step available for this cryptocurrency pair
|
|
4632
4577
|
* @type {string}
|
|
4633
4578
|
* @memberof CryptocurrencyPair
|
|
4634
4579
|
*/
|
|
@@ -4855,6 +4800,126 @@ interface FigiInstrument {
|
|
|
4855
4800
|
'figi_share_class'?: string | null;
|
|
4856
4801
|
}
|
|
4857
4802
|
//#endregion
|
|
4803
|
+
//#region models/institution-connection-nullable.d.ts
|
|
4804
|
+
/**
|
|
4805
|
+
* How end users connect to the institution and what the connection allows.
|
|
4806
|
+
* @export
|
|
4807
|
+
* @interface InstitutionConnectionNullable
|
|
4808
|
+
*/
|
|
4809
|
+
interface InstitutionConnectionNullable {
|
|
4810
|
+
[key: string]: any;
|
|
4811
|
+
/**
|
|
4812
|
+
* 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.
|
|
4813
|
+
* @type {Array<string>}
|
|
4814
|
+
* @memberof InstitutionConnectionNullable
|
|
4815
|
+
*/
|
|
4816
|
+
'methods': Array<InstitutionConnectionNullableMethodsEnum>;
|
|
4817
|
+
/**
|
|
4818
|
+
* What a connection can do. `READ` is always present. - `READ`: read accounts, balances, positions and activity. - `TRADE`: place orders.
|
|
4819
|
+
* @type {Array<string>}
|
|
4820
|
+
* @memberof InstitutionConnectionNullable
|
|
4821
|
+
*/
|
|
4822
|
+
'scopes': Array<InstitutionConnectionNullableScopesEnum>;
|
|
4823
|
+
}
|
|
4824
|
+
type InstitutionConnectionNullableMethodsEnum = 'OAUTH' | 'CREDENTIALS' | 'API_KEY';
|
|
4825
|
+
type InstitutionConnectionNullableScopesEnum = 'READ' | 'TRADE';
|
|
4826
|
+
//#endregion
|
|
4827
|
+
//#region models/institution.d.ts
|
|
4828
|
+
/**
|
|
4829
|
+
* An institution in SnapTrade\'s public catalog and what it supports. A `null` field means the information is not documented yet.
|
|
4830
|
+
* @export
|
|
4831
|
+
* @interface Institution
|
|
4832
|
+
*/
|
|
4833
|
+
interface Institution {
|
|
4834
|
+
[key: string]: any;
|
|
4835
|
+
/**
|
|
4836
|
+
* 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`.
|
|
4837
|
+
* @type {string}
|
|
4838
|
+
* @memberof Institution
|
|
4839
|
+
*/
|
|
4840
|
+
'slug': string;
|
|
4841
|
+
/**
|
|
4842
|
+
* Full name of the institution.
|
|
4843
|
+
* @type {string}
|
|
4844
|
+
* @memberof Institution
|
|
4845
|
+
*/
|
|
4846
|
+
'name': string;
|
|
4847
|
+
/**
|
|
4848
|
+
* A display-friendly name of the institution.
|
|
4849
|
+
* @type {string}
|
|
4850
|
+
* @memberof Institution
|
|
4851
|
+
*/
|
|
4852
|
+
'display_name': string;
|
|
4853
|
+
/**
|
|
4854
|
+
* A brief description of the institution.
|
|
4855
|
+
* @type {string}
|
|
4856
|
+
* @memberof Institution
|
|
4857
|
+
*/
|
|
4858
|
+
'description': string | null;
|
|
4859
|
+
/**
|
|
4860
|
+
* URL of the institution\'s website.
|
|
4861
|
+
* @type {string}
|
|
4862
|
+
* @memberof Institution
|
|
4863
|
+
*/
|
|
4864
|
+
'website': string | null;
|
|
4865
|
+
/**
|
|
4866
|
+
* URL of the institution\'s rectangular logo.
|
|
4867
|
+
* @type {string}
|
|
4868
|
+
* @memberof Institution
|
|
4869
|
+
*/
|
|
4870
|
+
'logo_url': string;
|
|
4871
|
+
/**
|
|
4872
|
+
* URL of the institution\'s square logo.
|
|
4873
|
+
* @type {string}
|
|
4874
|
+
* @memberof Institution
|
|
4875
|
+
*/
|
|
4876
|
+
'square_logo_url': string | null;
|
|
4877
|
+
/**
|
|
4878
|
+
* How mature the integration is. - `GENERALLY_AVAILABLE`: fully supported and validated for production use. - `BETA`: production-ready, with ongoing validation and improvements.
|
|
4879
|
+
* @type {string}
|
|
4880
|
+
* @memberof Institution
|
|
4881
|
+
*/
|
|
4882
|
+
'release_stage': InstitutionReleaseStageEnum;
|
|
4883
|
+
/**
|
|
4884
|
+
* Regions where end users can connect to this institution. - `US`: United States - `CA`: Canada - `EUROPE`: Europe, including the United Kingdom - `AU`: Australia - `IN`: India
|
|
4885
|
+
* @type {Array<string>}
|
|
4886
|
+
* @memberof Institution
|
|
4887
|
+
*/
|
|
4888
|
+
'regions': Array<InstitutionRegionsEnum>;
|
|
4889
|
+
/**
|
|
4890
|
+
*
|
|
4891
|
+
* @type {InstitutionConnectionNullable}
|
|
4892
|
+
* @memberof Institution
|
|
4893
|
+
*/
|
|
4894
|
+
'connection': InstitutionConnectionNullable | null;
|
|
4895
|
+
}
|
|
4896
|
+
type InstitutionReleaseStageEnum = 'GENERALLY_AVAILABLE' | 'BETA';
|
|
4897
|
+
type InstitutionRegionsEnum = 'US' | 'CA' | 'EUROPE' | 'AU' | 'IN';
|
|
4898
|
+
//#endregion
|
|
4899
|
+
//#region models/institution-connection.d.ts
|
|
4900
|
+
/**
|
|
4901
|
+
* How end users connect to the institution and what the connection allows.
|
|
4902
|
+
* @export
|
|
4903
|
+
* @interface InstitutionConnection
|
|
4904
|
+
*/
|
|
4905
|
+
interface InstitutionConnection {
|
|
4906
|
+
[key: string]: any;
|
|
4907
|
+
/**
|
|
4908
|
+
* 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.
|
|
4909
|
+
* @type {Array<string>}
|
|
4910
|
+
* @memberof InstitutionConnection
|
|
4911
|
+
*/
|
|
4912
|
+
'methods': Array<InstitutionConnectionMethodsEnum>;
|
|
4913
|
+
/**
|
|
4914
|
+
* What a connection can do. `READ` is always present. - `READ`: read accounts, balances, positions and activity. - `TRADE`: place orders.
|
|
4915
|
+
* @type {Array<string>}
|
|
4916
|
+
* @memberof InstitutionConnection
|
|
4917
|
+
*/
|
|
4918
|
+
'scopes': Array<InstitutionConnectionScopesEnum>;
|
|
4919
|
+
}
|
|
4920
|
+
type InstitutionConnectionMethodsEnum = 'OAUTH' | 'CREDENTIALS' | 'API_KEY';
|
|
4921
|
+
type InstitutionConnectionScopesEnum = 'READ' | 'TRADE';
|
|
4922
|
+
//#endregion
|
|
4858
4923
|
//#region models/manual-trade-symbol.d.ts
|
|
4859
4924
|
/**
|
|
4860
4925
|
* Information about the security for the order.
|
|
@@ -4950,7 +5015,7 @@ interface ManualTrade {
|
|
|
4950
5015
|
*/
|
|
4951
5016
|
'action'?: ActionStrict;
|
|
4952
5017
|
/**
|
|
4953
|
-
*
|
|
5018
|
+
* Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
|
|
4954
5019
|
* @type {number}
|
|
4955
5020
|
* @memberof ManualTrade
|
|
4956
5021
|
*/
|
|
@@ -5059,20 +5124,13 @@ interface ManualTradeAndImpact {
|
|
|
5059
5124
|
'combined_remaining_balance'?: ManualTradeBalance;
|
|
5060
5125
|
}
|
|
5061
5126
|
//#endregion
|
|
5062
|
-
//#region models/notional-value.d.ts
|
|
5127
|
+
//#region models/notional-value-nullable.d.ts
|
|
5063
5128
|
/**
|
|
5064
|
-
* @type
|
|
5129
|
+
* @type NotionalValueNullable
|
|
5065
5130
|
* Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://support.snaptrade.com/brokerages-table?v=e7bbcbf9f272441593f93decde660687) for more information.
|
|
5066
5131
|
* @export
|
|
5067
5132
|
*/
|
|
5068
|
-
type
|
|
5069
|
-
//#endregion
|
|
5070
|
-
//#region models/manual-trade-form-notional-value.d.ts
|
|
5071
|
-
/**
|
|
5072
|
-
* @type ManualTradeFormNotionalValue
|
|
5073
|
-
* @export
|
|
5074
|
-
*/
|
|
5075
|
-
type ManualTradeFormNotionalValue = NotionalValue;
|
|
5133
|
+
type NotionalValueNullable = number | string;
|
|
5076
5134
|
//#endregion
|
|
5077
5135
|
//#region models/manual-trade-form.d.ts
|
|
5078
5136
|
/**
|
|
@@ -5124,17 +5182,17 @@ interface ManualTradeForm {
|
|
|
5124
5182
|
*/
|
|
5125
5183
|
'stop'?: number | null;
|
|
5126
5184
|
/**
|
|
5127
|
-
*
|
|
5185
|
+
* Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
|
|
5128
5186
|
* @type {number}
|
|
5129
5187
|
* @memberof ManualTradeForm
|
|
5130
5188
|
*/
|
|
5131
5189
|
'units'?: number | null;
|
|
5132
5190
|
/**
|
|
5133
5191
|
*
|
|
5134
|
-
* @type {
|
|
5192
|
+
* @type {NotionalValueNullable}
|
|
5135
5193
|
* @memberof ManualTradeForm
|
|
5136
5194
|
*/
|
|
5137
|
-
'notional_value'?:
|
|
5195
|
+
'notional_value'?: NotionalValueNullable | null;
|
|
5138
5196
|
}
|
|
5139
5197
|
//#endregion
|
|
5140
5198
|
//#region models/stop-loss.d.ts
|
|
@@ -5259,7 +5317,7 @@ interface ManualTradeFormComplex {
|
|
|
5259
5317
|
*/
|
|
5260
5318
|
'orders': Array<ComplexOrderLeg>;
|
|
5261
5319
|
/**
|
|
5262
|
-
*
|
|
5320
|
+
* Optional caller-supplied identifier passed through to the brokerage for idempotent order placement. Must be a canonical 36-character UUID. Idempotency enforcement is brokerage-specific - SnapTrade forwards this value to the broker but does not enforce uniqueness server-side. Refer to per-brokerage documentation for behavior on duplicate submission.
|
|
5263
5321
|
* @type {string}
|
|
5264
5322
|
* @memberof ManualTradeFormComplex
|
|
5265
5323
|
*/
|
|
@@ -5303,7 +5361,7 @@ interface ManualTradeFormWithOptions {
|
|
|
5303
5361
|
*/
|
|
5304
5362
|
'action': ActionStrictWithOptions;
|
|
5305
5363
|
/**
|
|
5306
|
-
*
|
|
5364
|
+
* Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
|
|
5307
5365
|
* @type {string}
|
|
5308
5366
|
* @memberof ManualTradeFormWithOptions
|
|
5309
5367
|
*/
|
|
@@ -5351,19 +5409,19 @@ interface ManualTradeFormWithOptions {
|
|
|
5351
5409
|
*/
|
|
5352
5410
|
'stop'?: number | null;
|
|
5353
5411
|
/**
|
|
5354
|
-
*
|
|
5412
|
+
* Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
|
|
5355
5413
|
* @type {number}
|
|
5356
5414
|
* @memberof ManualTradeFormWithOptions
|
|
5357
5415
|
*/
|
|
5358
5416
|
'units'?: number | null;
|
|
5359
5417
|
/**
|
|
5360
5418
|
*
|
|
5361
|
-
* @type {
|
|
5419
|
+
* @type {NotionalValueNullable}
|
|
5362
5420
|
* @memberof ManualTradeFormWithOptions
|
|
5363
5421
|
*/
|
|
5364
|
-
'notional_value'?:
|
|
5422
|
+
'notional_value'?: NotionalValueNullable | null;
|
|
5365
5423
|
/**
|
|
5366
|
-
*
|
|
5424
|
+
* Optional caller-supplied identifier passed through to the brokerage for idempotent order placement. Must be a canonical 36-character UUID. Idempotency enforcement is brokerage-specific - SnapTrade forwards this value to the broker but does not enforce uniqueness server-side. Refer to per-brokerage documentation for behavior on duplicate submission.
|
|
5367
5425
|
* @type {string}
|
|
5368
5426
|
* @memberof ManualTradeFormWithOptions
|
|
5369
5427
|
*/
|
|
@@ -5420,7 +5478,7 @@ interface ManualTradeReplaceForm {
|
|
|
5420
5478
|
*/
|
|
5421
5479
|
'stop'?: number | null;
|
|
5422
5480
|
/**
|
|
5423
|
-
*
|
|
5481
|
+
* Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
|
|
5424
5482
|
* @type {number}
|
|
5425
5483
|
* @memberof ManualTradeReplaceForm
|
|
5426
5484
|
*/
|
|
@@ -5531,6 +5589,14 @@ type MlegOrderTypeStrict = 'MARKET' | 'LIMIT' | 'STOP_LOSS_MARKET' | 'STOP_LOSS_
|
|
|
5531
5589
|
*/
|
|
5532
5590
|
type MlegPriceEffectStrict = 'CREDIT' | 'DEBIT' | 'EVEN';
|
|
5533
5591
|
//#endregion
|
|
5592
|
+
//#region models/mleg-price-effect-strict-nullable.d.ts
|
|
5593
|
+
/**
|
|
5594
|
+
* The desired price_effect for `LIMIT` and `STOP_LOSS_LIMIT` orders. Values are `CREDIT`, `DEBIT`, `EVEN`
|
|
5595
|
+
* @export
|
|
5596
|
+
* @enum {string}
|
|
5597
|
+
*/
|
|
5598
|
+
type MlegPriceEffectStrictNullable = 'CREDIT' | 'DEBIT' | 'EVEN';
|
|
5599
|
+
//#endregion
|
|
5534
5600
|
//#region models/mleg-trade-form.d.ts
|
|
5535
5601
|
/**
|
|
5536
5602
|
* Inputs for placing a multi-leg order with the brokerage.
|
|
@@ -5564,10 +5630,10 @@ interface MlegTradeForm {
|
|
|
5564
5630
|
'stop_price'?: string | null;
|
|
5565
5631
|
/**
|
|
5566
5632
|
*
|
|
5567
|
-
* @type {
|
|
5633
|
+
* @type {MlegPriceEffectStrictNullable}
|
|
5568
5634
|
* @memberof MlegTradeForm
|
|
5569
5635
|
*/
|
|
5570
|
-
'price_effect'?:
|
|
5636
|
+
'price_effect'?: MlegPriceEffectStrictNullable | null;
|
|
5571
5637
|
/**
|
|
5572
5638
|
*
|
|
5573
5639
|
* @type {Array<MlegLeg>}
|
|
@@ -5930,6 +5996,14 @@ interface NetDividend {
|
|
|
5930
5996
|
'currency'?: string;
|
|
5931
5997
|
}
|
|
5932
5998
|
//#endregion
|
|
5999
|
+
//#region models/notional-value.d.ts
|
|
6000
|
+
/**
|
|
6001
|
+
* @type NotionalValue
|
|
6002
|
+
* Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://support.snaptrade.com/brokerages-table?v=e7bbcbf9f272441593f93decde660687) for more information.
|
|
6003
|
+
* @export
|
|
6004
|
+
*/
|
|
6005
|
+
type NotionalValue = number | string;
|
|
6006
|
+
//#endregion
|
|
5933
6007
|
//#region models/oauth-webhook-base.d.ts
|
|
5934
6008
|
/**
|
|
5935
6009
|
* The versioned webhook content sent to an authorized OAuth application.
|
|
@@ -6310,167 +6384,6 @@ interface OptionStrategy {
|
|
|
6310
6384
|
'legs'?: Array<OptionStrategyLegsInner>;
|
|
6311
6385
|
}
|
|
6312
6386
|
//#endregion
|
|
6313
|
-
//#region models/order-updated-response-order.d.ts
|
|
6314
|
-
/**
|
|
6315
|
-
*
|
|
6316
|
-
* @export
|
|
6317
|
-
* @interface OrderUpdatedResponseOrder
|
|
6318
|
-
*/
|
|
6319
|
-
interface OrderUpdatedResponseOrder {
|
|
6320
|
-
/**
|
|
6321
|
-
* Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
6322
|
-
* @type {string}
|
|
6323
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6324
|
-
*/
|
|
6325
|
-
'brokerage_order_id'?: string;
|
|
6326
|
-
/**
|
|
6327
|
-
* The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
|
|
6328
|
-
* @type {string}
|
|
6329
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6330
|
-
*/
|
|
6331
|
-
'brokerage_group_order_id'?: string | null;
|
|
6332
|
-
/**
|
|
6333
|
-
* The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
|
|
6334
|
-
* @type {string}
|
|
6335
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6336
|
-
*/
|
|
6337
|
-
'order_role'?: OrderUpdatedResponseOrderOrderRoleEnum;
|
|
6338
|
-
/**
|
|
6339
|
-
* Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include: - NONE - PENDING - ACCEPTED - FAILED - REJECTED - CANCELED - PARTIAL_CANCELED - CANCEL_PENDING - EXECUTED - PARTIAL - REPLACE_PENDING - REPLACED - EXPIRED - QUEUED - TRIGGERED - ACTIVATED
|
|
6340
|
-
* @type {AccountOrderRecordStatus}
|
|
6341
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6342
|
-
*/
|
|
6343
|
-
'status'?: AccountOrderRecordStatus;
|
|
6344
|
-
/**
|
|
6345
|
-
*
|
|
6346
|
-
* @type {AccountOrderRecordUniversalSymbol}
|
|
6347
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6348
|
-
*/
|
|
6349
|
-
'universal_symbol'?: AccountOrderRecordUniversalSymbol | null;
|
|
6350
|
-
/**
|
|
6351
|
-
*
|
|
6352
|
-
* @type {AccountOrderRecordOptionSymbol}
|
|
6353
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6354
|
-
*/
|
|
6355
|
-
'option_symbol'?: AccountOrderRecordOptionSymbol | null;
|
|
6356
|
-
/**
|
|
6357
|
-
*
|
|
6358
|
-
* @type {AccountOrderRecordQuoteUniversalSymbol}
|
|
6359
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6360
|
-
*/
|
|
6361
|
-
'quote_universal_symbol'?: AccountOrderRecordQuoteUniversalSymbol | null;
|
|
6362
|
-
/**
|
|
6363
|
-
*
|
|
6364
|
-
* @type {AccountOrderRecordQuoteCurrency}
|
|
6365
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6366
|
-
*/
|
|
6367
|
-
'quote_currency'?: AccountOrderRecordQuoteCurrency | null;
|
|
6368
|
-
/**
|
|
6369
|
-
* The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage. - BUY - SELL - BUY_COVER - SELL_SHORT - BUY_OPEN - BUY_CLOSE - SELL_OPEN - SELL_CLOSE
|
|
6370
|
-
* @type {string}
|
|
6371
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6372
|
-
*/
|
|
6373
|
-
'action'?: string;
|
|
6374
|
-
/**
|
|
6375
|
-
* The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
|
|
6376
|
-
* @type {string}
|
|
6377
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6378
|
-
*/
|
|
6379
|
-
'total_quantity'?: string | null;
|
|
6380
|
-
/**
|
|
6381
|
-
* The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
|
|
6382
|
-
* @type {string}
|
|
6383
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6384
|
-
*/
|
|
6385
|
-
'open_quantity'?: string | null;
|
|
6386
|
-
/**
|
|
6387
|
-
* The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
|
|
6388
|
-
* @type {string}
|
|
6389
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6390
|
-
*/
|
|
6391
|
-
'canceled_quantity'?: string | null;
|
|
6392
|
-
/**
|
|
6393
|
-
* The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
|
|
6394
|
-
* @type {string}
|
|
6395
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6396
|
-
*/
|
|
6397
|
-
'filled_quantity'?: string | null;
|
|
6398
|
-
/**
|
|
6399
|
-
* The price at which the order was executed. For option orders, this represents the price per share.
|
|
6400
|
-
* @type {string}
|
|
6401
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6402
|
-
*/
|
|
6403
|
-
'execution_price'?: string | null;
|
|
6404
|
-
/**
|
|
6405
|
-
* The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. For option orders, this represents the price per share.
|
|
6406
|
-
* @type {string}
|
|
6407
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6408
|
-
*/
|
|
6409
|
-
'limit_price'?: string | null;
|
|
6410
|
-
/**
|
|
6411
|
-
* The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. For option orders, this represents the price per share.
|
|
6412
|
-
* @type {string}
|
|
6413
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6414
|
-
*/
|
|
6415
|
-
'stop_price'?: string | null;
|
|
6416
|
-
/**
|
|
6417
|
-
*
|
|
6418
|
-
* @type {AccountOrderRecordTrailingStop}
|
|
6419
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6420
|
-
*/
|
|
6421
|
-
'trailing_stop'?: AccountOrderRecordTrailingStop | null;
|
|
6422
|
-
/**
|
|
6423
|
-
* The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage\'s order type value.
|
|
6424
|
-
* @type {string}
|
|
6425
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6426
|
-
*/
|
|
6427
|
-
'order_type'?: string | null;
|
|
6428
|
-
/**
|
|
6429
|
-
* The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value. - `Day` - Day. The order is valid only for the trading day on which it is placed. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date. - `MOO` - Market On Open. The order is to be executed at the day\'s opening price. - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
|
|
6430
|
-
* @type {string}
|
|
6431
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6432
|
-
*/
|
|
6433
|
-
'time_in_force'?: string;
|
|
6434
|
-
/**
|
|
6435
|
-
* The time the order was placed. This is the time the order was submitted to the brokerage.
|
|
6436
|
-
* @type {string}
|
|
6437
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6438
|
-
*/
|
|
6439
|
-
'time_placed'?: string;
|
|
6440
|
-
/**
|
|
6441
|
-
* The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
|
|
6442
|
-
* @type {string}
|
|
6443
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6444
|
-
*/
|
|
6445
|
-
'time_updated'?: string | null;
|
|
6446
|
-
/**
|
|
6447
|
-
* The time the order was executed in the brokerage system. This value is not always available from the brokerage.
|
|
6448
|
-
* @type {string}
|
|
6449
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6450
|
-
*/
|
|
6451
|
-
'time_executed'?: string | null;
|
|
6452
|
-
/**
|
|
6453
|
-
* The time the order expires. This value is not always available from the brokerage.
|
|
6454
|
-
* @type {string}
|
|
6455
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6456
|
-
*/
|
|
6457
|
-
'expiry_date'?: string | null;
|
|
6458
|
-
/**
|
|
6459
|
-
* A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
|
|
6460
|
-
* @type {string}
|
|
6461
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6462
|
-
* @deprecated
|
|
6463
|
-
*/
|
|
6464
|
-
'symbol'?: string;
|
|
6465
|
-
/**
|
|
6466
|
-
*
|
|
6467
|
-
* @type {AccountOrderRecordChildBrokerageOrderIds}
|
|
6468
|
-
* @memberof OrderUpdatedResponseOrder
|
|
6469
|
-
*/
|
|
6470
|
-
'child_brokerage_order_ids'?: AccountOrderRecordChildBrokerageOrderIds | null;
|
|
6471
|
-
}
|
|
6472
|
-
type OrderUpdatedResponseOrderOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
|
|
6473
|
-
//#endregion
|
|
6474
6387
|
//#region models/order-updated-response.d.ts
|
|
6475
6388
|
/**
|
|
6476
6389
|
*
|
|
@@ -6487,10 +6400,10 @@ interface OrderUpdatedResponse {
|
|
|
6487
6400
|
'brokerage_order_id': string;
|
|
6488
6401
|
/**
|
|
6489
6402
|
*
|
|
6490
|
-
* @type {
|
|
6403
|
+
* @type {AccountOrderRecordNullable}
|
|
6491
6404
|
* @memberof OrderUpdatedResponse
|
|
6492
6405
|
*/
|
|
6493
|
-
'order'?:
|
|
6406
|
+
'order'?: AccountOrderRecordNullable | null;
|
|
6494
6407
|
}
|
|
6495
6408
|
//#endregion
|
|
6496
6409
|
//#region models/pagination-details.d.ts
|
|
@@ -7315,10 +7228,10 @@ interface Symbol {
|
|
|
7315
7228
|
'figi_code'?: string | null;
|
|
7316
7229
|
/**
|
|
7317
7230
|
*
|
|
7318
|
-
* @type {
|
|
7231
|
+
* @type {FigiInstrumentNullable}
|
|
7319
7232
|
* @memberof Symbol
|
|
7320
7233
|
*/
|
|
7321
|
-
'figi_instrument'?:
|
|
7234
|
+
'figi_instrument'?: FigiInstrumentNullable | null;
|
|
7322
7235
|
}
|
|
7323
7236
|
//#endregion
|
|
7324
7237
|
//#region models/symbol-query.d.ts
|
|
@@ -7586,22 +7499,22 @@ interface UniversalActivity {
|
|
|
7586
7499
|
'account'?: AccountSimple;
|
|
7587
7500
|
/**
|
|
7588
7501
|
*
|
|
7589
|
-
* @type {
|
|
7502
|
+
* @type {SymbolNullable}
|
|
7590
7503
|
* @memberof UniversalActivity
|
|
7591
7504
|
*/
|
|
7592
|
-
'symbol'?:
|
|
7505
|
+
'symbol'?: SymbolNullable | null;
|
|
7593
7506
|
/**
|
|
7594
7507
|
*
|
|
7595
|
-
* @type {
|
|
7508
|
+
* @type {SymbolNullable}
|
|
7596
7509
|
* @memberof UniversalActivity
|
|
7597
7510
|
*/
|
|
7598
|
-
'currency_universal_symbol'?:
|
|
7511
|
+
'currency_universal_symbol'?: SymbolNullable | null;
|
|
7599
7512
|
/**
|
|
7600
7513
|
*
|
|
7601
|
-
* @type {
|
|
7514
|
+
* @type {OptionsSymbolNullable}
|
|
7602
7515
|
* @memberof UniversalActivity
|
|
7603
7516
|
*/
|
|
7604
|
-
'option_symbol'?:
|
|
7517
|
+
'option_symbol'?: OptionsSymbolNullable | null;
|
|
7605
7518
|
/**
|
|
7606
7519
|
* The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
|
|
7607
7520
|
* @type {number}
|
|
@@ -7622,10 +7535,10 @@ interface UniversalActivity {
|
|
|
7622
7535
|
'amount'?: number | null;
|
|
7623
7536
|
/**
|
|
7624
7537
|
*
|
|
7625
|
-
* @type {
|
|
7538
|
+
* @type {CurrencyNullable}
|
|
7626
7539
|
* @memberof UniversalActivity
|
|
7627
7540
|
*/
|
|
7628
|
-
'currency'?:
|
|
7541
|
+
'currency'?: CurrencyNullable | null;
|
|
7629
7542
|
/**
|
|
7630
7543
|
* A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `SUBSTITUTE_DIVIDEND` - Payment in lieu of a dividend. - `CONTRIBUTION` - Cash contribution. - `WITHDRAWAL` - Cash withdrawal. - `REI` - Dividend reinvestment. - `INTEREST` - Interest deposited into the account. - `FEE` - Fee withdrawn from the account. - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info. - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info. - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
|
|
7631
7544
|
* @type {string}
|
|
@@ -7740,7 +7653,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7740
7653
|
*/
|
|
7741
7654
|
getAccountActivities: (accountId: string, startDate?: string | Date, endDate?: string | Date, offset?: number, limit?: number, type?: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7742
7655
|
/**
|
|
7743
|
-
* 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
|
|
7656
|
+
* 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)
|
|
7744
7657
|
* @summary List historical account total value
|
|
7745
7658
|
* @param {string} accountId
|
|
7746
7659
|
* @param {string} [userId]
|
|
@@ -7814,7 +7727,7 @@ declare const AccountInformationApiAxiosParamCreator: (configuration?: Configura
|
|
|
7814
7727
|
*/
|
|
7815
7728
|
getUserAccountRecentOrders: (accountId: string, onlyExecuted?: boolean, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7816
7729
|
/**
|
|
7817
|
-
* Returns a list of rate of return percents for a given account.
|
|
7730
|
+
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
7818
7731
|
* @summary List account rate of returns
|
|
7819
7732
|
* @param {string} accountId
|
|
7820
7733
|
* @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
|
|
@@ -7869,7 +7782,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7869
7782
|
*/
|
|
7870
7783
|
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedUniversalActivity>>;
|
|
7871
7784
|
/**
|
|
7872
|
-
* 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
|
|
7785
|
+
* 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)
|
|
7873
7786
|
* @summary List historical account total value
|
|
7874
7787
|
* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
|
|
7875
7788
|
* @param {*} [options] Override http request option.
|
|
@@ -7925,7 +7838,7 @@ declare const AccountInformationApiFp: <TAuth extends AuthMode>(configuration?:
|
|
|
7925
7838
|
*/
|
|
7926
7839
|
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecentOrdersResponse>>;
|
|
7927
7840
|
/**
|
|
7928
|
-
* Returns a list of rate of return percents for a given account.
|
|
7841
|
+
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
7929
7842
|
* @summary List account rate of returns
|
|
7930
7843
|
* @param {AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>} requestParameters Request parameters.
|
|
7931
7844
|
* @param {*} [options] Override http request option.
|
|
@@ -7972,7 +7885,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
7972
7885
|
*/
|
|
7973
7886
|
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): AxiosPromise<PaginatedUniversalActivity>;
|
|
7974
7887
|
/**
|
|
7975
|
-
* 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
|
|
7888
|
+
* 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)
|
|
7976
7889
|
* @summary List historical account total value
|
|
7977
7890
|
* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
|
|
7978
7891
|
* @param {*} [options] Override http request option.
|
|
@@ -8028,7 +7941,7 @@ declare const AccountInformationApiFactory: <TAuth extends AuthMode>(configurati
|
|
|
8028
7941
|
*/
|
|
8029
7942
|
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): AxiosPromise<RecentOrdersResponse>;
|
|
8030
7943
|
/**
|
|
8031
|
-
* Returns a list of rate of return percents for a given account.
|
|
7944
|
+
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8032
7945
|
* @summary List account rate of returns
|
|
8033
7946
|
* @param {AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>} requestParameters Request parameters.
|
|
8034
7947
|
* @param {*} [options] Override http request option.
|
|
@@ -8449,7 +8362,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8449
8362
|
*/
|
|
8450
8363
|
getAccountActivities(...args: AccountInformationApiGetAccountActivitiesArgs<TAuth>): Promise<_$axios.AxiosResponse<PaginatedUniversalActivity, any, {}>>;
|
|
8451
8364
|
/**
|
|
8452
|
-
* 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
|
|
8365
|
+
* 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)
|
|
8453
8366
|
* @summary List historical account total value
|
|
8454
8367
|
* @param {AccountInformationApiGetAccountBalanceHistoryRequest<TAuth>} requestParameters Request parameters.
|
|
8455
8368
|
* @param {*} [options] Override http request option.
|
|
@@ -8512,7 +8425,7 @@ declare class AccountInformationApiGenerated<TAuth extends AuthMode> extends Bas
|
|
|
8512
8425
|
*/
|
|
8513
8426
|
getUserAccountRecentOrders(...args: AccountInformationApiGetUserAccountRecentOrdersArgs<TAuth>): Promise<_$axios.AxiosResponse<RecentOrdersResponse, any, {}>>;
|
|
8514
8427
|
/**
|
|
8515
|
-
* Returns a list of rate of return percents for a given account.
|
|
8428
|
+
* DEPRECATED. Returns a list of rate of return percents for a given account.
|
|
8516
8429
|
* @summary List account rate of returns
|
|
8517
8430
|
* @param {AccountInformationApiGetUserAccountReturnRatesRequest<TAuth>} requestParameters Request parameters.
|
|
8518
8431
|
* @param {*} [options] Override http request option.
|
|
@@ -8941,7 +8854,7 @@ declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration<Au
|
|
|
8941
8854
|
*/
|
|
8942
8855
|
refreshBrokerageAuthorization: (authorizationId: string, userId?: string, userSecret?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8943
8856
|
/**
|
|
8944
|
-
* Returns a list of rate of return percents for a given connection.
|
|
8857
|
+
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
8945
8858
|
* @summary List connection rate of returns
|
|
8946
8859
|
* @param {string} authorizationId
|
|
8947
8860
|
* @param {string} [timeframes] Optional comma separated list of rate-of-return timeframes to return. Supported values are `ALL`, `1Y`, `YTD`, `1M`, `1W`, and `1D`. If omitted, SnapTrade returns all six supported timeframes.
|
|
@@ -9024,7 +8937,7 @@ declare const ConnectionsApiFp: <TAuth extends AuthMode>(configuration?: Configu
|
|
|
9024
8937
|
*/
|
|
9025
8938
|
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationRefreshConfirmation>>;
|
|
9026
8939
|
/**
|
|
9027
|
-
* Returns a list of rate of return percents for a given connection.
|
|
8940
|
+
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9028
8941
|
* @summary List connection rate of returns
|
|
9029
8942
|
* @param {ConnectionsApiReturnRatesRequest<TAuth>} requestParameters Request parameters.
|
|
9030
8943
|
* @param {*} [options] Override http request option.
|
|
@@ -9102,7 +9015,7 @@ declare const ConnectionsApiFactory: <TAuth extends AuthMode>(configuration?: Co
|
|
|
9102
9015
|
*/
|
|
9103
9016
|
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): AxiosPromise<BrokerageAuthorizationRefreshConfirmation>;
|
|
9104
9017
|
/**
|
|
9105
|
-
* Returns a list of rate of return percents for a given connection.
|
|
9018
|
+
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9106
9019
|
* @summary List connection rate of returns
|
|
9107
9020
|
* @param {ConnectionsApiReturnRatesRequest<TAuth>} requestParameters Request parameters.
|
|
9108
9021
|
* @param {*} [options] Override http request option.
|
|
@@ -9431,7 +9344,7 @@ declare class ConnectionsApiGenerated<TAuth extends AuthMode> extends BaseAPI<TA
|
|
|
9431
9344
|
*/
|
|
9432
9345
|
refreshBrokerageAuthorization(...args: ConnectionsApiRefreshBrokerageAuthorizationArgs<TAuth>): Promise<_$axios.AxiosResponse<BrokerageAuthorizationRefreshConfirmation, any, {}>>;
|
|
9433
9346
|
/**
|
|
9434
|
-
* Returns a list of rate of return percents for a given connection.
|
|
9347
|
+
* DEPRECATED. Returns a list of rate of return percents for a given connection.
|
|
9435
9348
|
* @summary List connection rate of returns
|
|
9436
9349
|
* @param {ConnectionsApiReturnRatesRequest<TAuth>} requestParameters Request parameters.
|
|
9437
9350
|
* @param {*} [options] Override http request option.
|
|
@@ -9888,6 +9801,13 @@ declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration<
|
|
|
9888
9801
|
* @throws {RequiredError}
|
|
9889
9802
|
*/
|
|
9890
9803
|
listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9804
|
+
/**
|
|
9805
|
+
* 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.
|
|
9806
|
+
* @summary List institutions
|
|
9807
|
+
* @param {*} [options] Override http request option.
|
|
9808
|
+
* @throws {RequiredError}
|
|
9809
|
+
*/
|
|
9810
|
+
listInstitutions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9891
9811
|
/**
|
|
9892
9812
|
* 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.
|
|
9893
9813
|
* @summary Search account symbols
|
|
@@ -9958,6 +9878,13 @@ declare const ReferenceDataApiFp: <TAuth extends AuthMode>(configuration?: Confi
|
|
|
9958
9878
|
* @throws {RequiredError}
|
|
9959
9879
|
*/
|
|
9960
9880
|
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
|
|
9881
|
+
/**
|
|
9882
|
+
* 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.
|
|
9883
|
+
* @summary List institutions
|
|
9884
|
+
* @param {*} [options] Override http request option.
|
|
9885
|
+
* @throws {RequiredError}
|
|
9886
|
+
*/
|
|
9887
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Institution>>>;
|
|
9961
9888
|
/**
|
|
9962
9889
|
* 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.
|
|
9963
9890
|
* @summary Search account symbols
|
|
@@ -10025,6 +9952,13 @@ declare const ReferenceDataApiFactory: <TAuth extends AuthMode>(configuration?:
|
|
|
10025
9952
|
* @throws {RequiredError}
|
|
10026
9953
|
*/
|
|
10027
9954
|
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): AxiosPromise<Array<Brokerage>>;
|
|
9955
|
+
/**
|
|
9956
|
+
* 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.
|
|
9957
|
+
* @summary List institutions
|
|
9958
|
+
* @param {*} [options] Override http request option.
|
|
9959
|
+
* @throws {RequiredError}
|
|
9960
|
+
*/
|
|
9961
|
+
listInstitutions(options?: AxiosRequestConfig): AxiosPromise<Array<Institution>>;
|
|
10028
9962
|
/**
|
|
10029
9963
|
* 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.
|
|
10030
9964
|
* @summary Search account symbols
|
|
@@ -10205,6 +10139,14 @@ declare class ReferenceDataApiGenerated<TAuth extends AuthMode> extends BaseAPI<
|
|
|
10205
10139
|
* @memberof ReferenceDataApiGenerated
|
|
10206
10140
|
*/
|
|
10207
10141
|
listAllBrokerages(...args: TAuth["mode"] extends "commercialApiKey" | "personalApiKey" ? [options?: AxiosRequestConfig] : [never]): Promise<_$axios.AxiosResponse<Brokerage[], any, {}>>;
|
|
10142
|
+
/**
|
|
10143
|
+
* 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.
|
|
10144
|
+
* @summary List institutions
|
|
10145
|
+
* @param {*} [options] Override http request option.
|
|
10146
|
+
* @throws {RequiredError}
|
|
10147
|
+
* @memberof ReferenceDataApiGenerated
|
|
10148
|
+
*/
|
|
10149
|
+
listInstitutions(options?: AxiosRequestConfig): Promise<_$axios.AxiosResponse<Institution[], any, {}>>;
|
|
10208
10150
|
/**
|
|
10209
10151
|
* 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.
|
|
10210
10152
|
* @summary Search account symbols
|
|
@@ -11222,4 +11164,4 @@ declare class SnaptradeError extends Error {
|
|
|
11222
11164
|
declare function readableStreamToString(stream: ReadableStream): Promise<string>;
|
|
11223
11165
|
declare function parseIfJson(input: unknown): object | unknown;
|
|
11224
11166
|
//#endregion
|
|
11225
|
-
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesArgs, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryArgs, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, 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, AccountInformationApiListUserAccountsArgs, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountArgs, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordChildBrokerageOrderIds, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordOptionSymbol, AccountOrderRecordQuoteCurrency, AccountOrderRecordQuoteUniversalSymbol, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordTrailingStop, AccountOrderRecordUniversalSymbol, AccountOrderRecordV2, AccountOrderRecordV2OrderRole, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountUniversalActivityCurrency, AccountUniversalActivityCurrencyUniversalSymbol, AccountUniversalActivityOptionSymbol, AccountUniversalActivitySymbol, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, ApiKey, ApiStatusApi, ApiStatusApiAxiosParamCreator, ApiStatusApiFactory, ApiStatusApiFp, ApiStatusApiGenerated, type AuthMode, AuthenticationApi, AuthenticationApiAxiosParamCreator, 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, 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, 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, FigiInstrument, FutureInstrument, FutureOptionInstrument, HoldingsStatus, Instrument, InvestmentAccount, InvestmentAccountNetValue, LineOfCreditAccount, LineOfCreditAccountAvailableCredit, LineOfCreditAccountMinimumPaymentAmount, LineOfCreditAccountNetValue, LineOfCreditAccountSyncStatus, LoginRedirectURI, ManualTrade, ManualTradeAndImpact, ManualTradeBalance, ManualTradeForm, ManualTradeFormBracket, ManualTradeFormComplex, ManualTradeFormNotionalValue, ManualTradeFormWithOptions, ManualTradeImpact, ManualTradePlaceTimeInForceStrict, ManualTradeReplaceForm, ManualTradeSymbol, MlegActionStrict, MlegInstrumentType, MlegLeg, MlegOrderResponse, MlegOrderTypeStrict, MlegPriceEffectStrict, MlegTradeForm, MlegTradingInstrument, Model400FailedRequestResponse, Model401FailedRequestResponse, Model402BrokerageAuthAlreadyDisabledException, Model402BrokerageAuthDisabledResponse, Model403FailedRequestResponse, Model403FeatureNotEnabledResponse, Model404FailedRequestResponse, Model425FailedRequestResponse, Model429TooManyRequestsResponse, Model500UnexpectedExceptionResponse, Model501NotImplementedResponse, Model503BrokerageRequestResponse, MonthlyDividends, MutualFundInstrument, NetContributions, NetDividend, NotionalValue, OAuthWebhookBase, OptionBrokerageSymbol, OptionChainInner, OptionChainInnerChainPerRootInner, OptionChainInnerChainPerRootInnerChainPerStrikePriceInner, OptionImpact, OptionInstrument, OptionLeg, OptionQuote, OptionQuoteGreeks, OptionStrategy, OptionStrategyLegsInner, OptionsPosition, OptionsPositionCurrency, OptionsSymbol, OrderTypeStrict, OrderUpdatedResponse, OrderUpdatedResponseOrder, OtherInstrument, PaginatedUniversalActivity, PaginationDetails, PartnerData, PastValue, PerformanceCustom, PersonalApiKeyAuth, Position, PositionCurrency, PositionSymbol, RateOfReturnObject, RateOfReturnResponse, RecentOrdersResponse, ReferenceDataApi, ReferenceDataApiAxiosParamCreator, ReferenceDataApiFactory, ReferenceDataApiFp, ReferenceDataApiGenerated, 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, SnapTradeHoldingsAccount, SnapTradeHoldingsTotalValue, SnapTradeLoginUserRequestBody, SnapTradeRegisterUserRequestBody, Snaptrade, SnaptradeAuth, SnaptradeError, Status, StockInstrument, StockInstrumentFigiInstrument, StopLoss, StrategyOrderRecord, StrategyQuotes, StrategyQuotesGreek, SubPeriodReturnRate, Symbol, SymbolCurrency, SymbolExchange, 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, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UnderlyingTokenizedAssetInstrument, UniversalActivity, UniversalSymbol, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|
|
11167
|
+
export { Account, AccountBalance, AccountBalanceTotal, AccountHoldings, AccountHoldingsAccount, AccountInformationApi, AccountInformationApiAxiosParamCreator, AccountInformationApiFactory, AccountInformationApiFp, AccountInformationApiGenerated, AccountInformationApiGetAccountActivitiesArgs, AccountInformationApiGetAccountActivitiesBaseRequest, AccountInformationApiGetAccountActivitiesRequest, AccountInformationApiGetAccountActivitiesRequestByAuthMode, AccountInformationApiGetAccountActivitiescommercialApiKeyRequest, AccountInformationApiGetAccountActivitiespersonalApiKeyRequest, AccountInformationApiGetAccountBalanceHistoryArgs, AccountInformationApiGetAccountBalanceHistoryBaseRequest, AccountInformationApiGetAccountBalanceHistoryRequest, AccountInformationApiGetAccountBalanceHistoryRequestByAuthMode, AccountInformationApiGetAccountBalanceHistorycommercialApiKeyRequest, AccountInformationApiGetAccountBalanceHistorypersonalApiKeyRequest, 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, AccountInformationApiListUserAccountsArgs, AccountInformationApiListUserAccountsBaseRequest, AccountInformationApiListUserAccountsRequest, AccountInformationApiListUserAccountsRequestByAuthMode, AccountInformationApiListUserAccountscommercialApiKeyRequest, AccountInformationApiListUserAccountspersonalApiKeyRequest, AccountInformationApiUpdateUserAccountArgs, AccountInformationApiUpdateUserAccountBaseRequest, AccountInformationApiUpdateUserAccountRequest, AccountInformationApiUpdateUserAccountRequestByAuthMode, AccountInformationApiUpdateUserAccountcommercialApiKeyRequest, AccountInformationApiUpdateUserAccountpersonalApiKeyRequest, AccountInformationGetUserAccountOrderDetailRequest, AccountOrderRecord, AccountOrderRecordLeg, AccountOrderRecordLegInstrument, AccountOrderRecordNullable, AccountOrderRecordStatus, AccountOrderRecordStatusV2, AccountOrderRecordStatusV2Nullable, AccountOrderRecordV2, AccountOrderRecordV2OrderRole, AccountOrderRecordV2OrderRoleNullable, AccountOrdersV2Response, AccountPosition, AccountSimple, AccountSyncStatus, AccountUniversalActivity, AccountValueHistoryItem, AccountValueHistoryResponse, ActionStrict, ActionStrictWithOptions, AdrInstrument, AllAccountPositionsResponse, AllAccountPositionsResponseDataFreshness, 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, 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, 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, TradingInstrument, TradingSearchCryptocurrencyPairInstruments200Response, TradingSession, TrailingStop, TrailingStopNullable, TransactionsStatus, USExchange, UnderlyingCfdInstrument, UnderlyingOptionInstrument, UnderlyingSymbol, UnderlyingSymbolExchange, UnderlyingSymbolType, UnderlyingTokenizedAssetInstrument, UniversalActivity, UniversalSymbol, UniversalSymbolNullable, UserIDandSecret, ValidatedTradeBody, parseIfJson, readableStreamToString };
|