snaptrade-typescript-sdk 9.0.200 → 10.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -2
- package/dist/chunk-e9Ob2GDo.mjs +26 -0
- package/dist/index.cjs +6594 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1 -0
- package/dist/index.d.mts +10422 -0
- package/dist/index.d.ts +1 -5
- package/dist/index.mjs +6527 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +27 -13
- package/dist/api/account-information-api-generated.d.ts +0 -950
- package/dist/api/account-information-api-generated.js +0 -1372
- package/dist/api/account-information-api.d.ts +0 -4
- package/dist/api/account-information-api.js +0 -22
- package/dist/api/api-status-api-generated.d.ts +0 -59
- package/dist/api/api-status-api-generated.js +0 -133
- package/dist/api/api-status-api.d.ts +0 -4
- package/dist/api/api-status-api.js +0 -22
- package/dist/api/authentication-api-generated.d.ts +0 -241
- package/dist/api/authentication-api-generated.js +0 -482
- package/dist/api/authentication-api.d.ts +0 -4
- package/dist/api/authentication-api.js +0 -22
- package/dist/api/connections-api-generated.d.ts +0 -576
- package/dist/api/connections-api-generated.js +0 -868
- package/dist/api/connections-api.d.ts +0 -4
- package/dist/api/connections-api.js +0 -22
- package/dist/api/options-api-generated.d.ts +0 -90
- package/dist/api/options-api-generated.js +0 -158
- package/dist/api/options-api.d.ts +0 -4
- package/dist/api/options-api.js +0 -22
- package/dist/api/reference-data-api-generated.d.ts +0 -497
- package/dist/api/reference-data-api-generated.js +0 -973
- package/dist/api/reference-data-api.d.ts +0 -4
- package/dist/api/reference-data-api.js +0 -22
- package/dist/api/trading-api-generated.d.ts +0 -1058
- package/dist/api/trading-api-generated.js +0 -1688
- package/dist/api/trading-api.d.ts +0 -4
- package/dist/api/trading-api.js +0 -22
- package/dist/api/transactions-and-reporting-api-generated.d.ts +0 -215
- package/dist/api/transactions-and-reporting-api-generated.js +0 -299
- package/dist/api/transactions-and-reporting-api.d.ts +0 -4
- package/dist/api/transactions-and-reporting-api.js +0 -22
- package/dist/api.d.ts +0 -8
- package/dist/api.js +0 -36
- package/dist/base.d.ts +0 -44
- package/dist/base.js +0 -60
- package/dist/browser.js +0 -2
- package/dist/browser.js.LICENSE.txt +0 -1
- package/dist/client-custom.d.ts +0 -4
- package/dist/client-custom.js +0 -7
- package/dist/client.d.ts +0 -14
- package/dist/client.js +0 -31
- package/dist/common.d.ts +0 -61
- package/dist/common.js +0 -220
- package/dist/configuration.d.ts +0 -98
- package/dist/configuration.js +0 -53
- package/dist/error.d.ts +0 -46
- package/dist/error.js +0 -105
- package/dist/index.js +0 -33
- package/dist/jest.config.d.ts +0 -3
- package/dist/jest.config.js +0 -13
- package/dist/mock.test.d.ts +0 -1
- package/dist/mock.test.js +0 -29
- package/dist/models/account-balance-total.d.ts +0 -19
- package/dist/models/account-balance-total.js +0 -2
- package/dist/models/account-balance.d.ts +0 -14
- package/dist/models/account-balance.js +0 -2
- package/dist/models/account-holdings-account.d.ts +0 -51
- package/dist/models/account-holdings-account.js +0 -2
- package/dist/models/account-holdings.d.ts +0 -37
- package/dist/models/account-holdings.js +0 -2
- package/dist/models/account-information-get-user-account-order-detail-request.d.ts +0 -13
- package/dist/models/account-information-get-user-account-order-detail-request.js +0 -2
- package/dist/models/account-order-record-child-brokerage-order-ids.d.ts +0 -19
- package/dist/models/account-order-record-child-brokerage-order-ids.js +0 -2
- package/dist/models/account-order-record-leg-instrument.d.ts +0 -38
- package/dist/models/account-order-record-leg-instrument.js +0 -2
- package/dist/models/account-order-record-leg.d.ts +0 -58
- package/dist/models/account-order-record-leg.js +0 -2
- package/dist/models/account-order-record-option-symbol.d.ts +0 -52
- package/dist/models/account-order-record-option-symbol.js +0 -2
- package/dist/models/account-order-record-quote-currency.d.ts +0 -25
- package/dist/models/account-order-record-quote-currency.js +0 -2
- package/dist/models/account-order-record-quote-universal-symbol.d.ts +0 -73
- package/dist/models/account-order-record-quote-universal-symbol.js +0 -2
- package/dist/models/account-order-record-status-v2.d.ts +0 -6
- package/dist/models/account-order-record-status-v2.js +0 -2
- package/dist/models/account-order-record-status.d.ts +0 -6
- package/dist/models/account-order-record-status.js +0 -2
- package/dist/models/account-order-record-trailing-stop.d.ts +0 -21
- package/dist/models/account-order-record-trailing-stop.js +0 -2
- package/dist/models/account-order-record-universal-symbol.d.ts +0 -73
- package/dist/models/account-order-record-universal-symbol.js +0 -2
- package/dist/models/account-order-record-v2.d.ts +0 -97
- package/dist/models/account-order-record-v2.js +0 -2
- package/dist/models/account-order-record.d.ts +0 -168
- package/dist/models/account-order-record.js +0 -2
- package/dist/models/account-orders-v2-response.d.ts +0 -15
- package/dist/models/account-orders-v2-response.js +0 -2
- package/dist/models/account-position.d.ts +0 -52
- package/dist/models/account-position.js +0 -2
- package/dist/models/account-simple.d.ts +0 -39
- package/dist/models/account-simple.js +0 -2
- package/dist/models/account-sync-status.d.ts +0 -21
- package/dist/models/account-sync-status.js +0 -2
- package/dist/models/account-universal-activity-currency.d.ts +0 -25
- package/dist/models/account-universal-activity-currency.js +0 -2
- package/dist/models/account-universal-activity-option-symbol.d.ts +0 -52
- package/dist/models/account-universal-activity-option-symbol.js +0 -2
- package/dist/models/account-universal-activity-symbol.d.ts +0 -65
- package/dist/models/account-universal-activity-symbol.js +0 -2
- package/dist/models/account-universal-activity.d.ts +0 -107
- package/dist/models/account-universal-activity.js +0 -2
- package/dist/models/account-value-history-item.d.ts +0 -20
- package/dist/models/account-value-history-item.js +0 -2
- package/dist/models/account-value-history-response.d.ts +0 -21
- package/dist/models/account-value-history-response.js +0 -2
- package/dist/models/account.d.ts +0 -126
- package/dist/models/account.js +0 -2
- package/dist/models/action-strict-with-options.d.ts +0 -6
- package/dist/models/action-strict-with-options.js +0 -2
- package/dist/models/action-strict.d.ts +0 -6
- package/dist/models/action-strict.js +0 -2
- package/dist/models/adr-instrument.d.ts +0 -59
- package/dist/models/adr-instrument.js +0 -2
- package/dist/models/all-account-positions-response.d.ts +0 -15
- package/dist/models/all-account-positions-response.js +0 -2
- package/dist/models/authentication-login-snap-trade-user200-response.d.ts +0 -7
- package/dist/models/authentication-login-snap-trade-user200-response.js +0 -2
- package/dist/models/balance-currency.d.ts +0 -25
- package/dist/models/balance-currency.js +0 -2
- package/dist/models/balance.d.ts +0 -27
- package/dist/models/balance.js +0 -2
- package/dist/models/brokerage-authorization-disabled-confirmation.d.ts +0 -14
- package/dist/models/brokerage-authorization-disabled-confirmation.js +0 -2
- package/dist/models/brokerage-authorization-refresh-confirmation.d.ts +0 -14
- package/dist/models/brokerage-authorization-refresh-confirmation.js +0 -2
- package/dist/models/brokerage-authorization-transactions-sync-confirmation.d.ts +0 -14
- package/dist/models/brokerage-authorization-transactions-sync-confirmation.js +0 -2
- package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +0 -26
- package/dist/models/brokerage-authorization-type-read-only-brokerage.js +0 -2
- package/dist/models/brokerage-authorization-type-read-only.d.ts +0 -36
- package/dist/models/brokerage-authorization-type-read-only.js +0 -2
- package/dist/models/brokerage-authorization.d.ts +0 -73
- package/dist/models/brokerage-authorization.js +0 -2
- package/dist/models/brokerage-instrument.d.ts +0 -38
- package/dist/models/brokerage-instrument.js +0 -2
- package/dist/models/brokerage-instruments-response.d.ts +0 -15
- package/dist/models/brokerage-instruments-response.js +0 -2
- package/dist/models/brokerage-type.d.ts +0 -20
- package/dist/models/brokerage-type.js +0 -2
- package/dist/models/brokerage.d.ts +0 -122
- package/dist/models/brokerage.js +0 -2
- package/dist/models/cancel-order-response.d.ts +0 -22
- package/dist/models/cancel-order-response.js +0 -2
- package/dist/models/cef-instrument.d.ts +0 -59
- package/dist/models/cef-instrument.js +0 -2
- package/dist/models/child-brokerage-order-ids.d.ts +0 -20
- package/dist/models/child-brokerage-order-ids.js +0 -2
- package/dist/models/complex-order-leg.d.ts +0 -62
- package/dist/models/complex-order-leg.js +0 -2
- package/dist/models/complex-order-response.d.ts +0 -22
- package/dist/models/complex-order-response.js +0 -2
- package/dist/models/connections-session-events200-response-inner.d.ts +0 -6
- package/dist/models/connections-session-events200-response-inner.js +0 -2
- package/dist/models/crypto-instrument.d.ts +0 -59
- package/dist/models/crypto-instrument.js +0 -2
- package/dist/models/crypto-order-form.d.ts +0 -66
- package/dist/models/crypto-order-form.js +0 -2
- package/dist/models/crypto-order-preview-estimated-fee.d.ts +0 -20
- package/dist/models/crypto-order-preview-estimated-fee.js +0 -2
- package/dist/models/crypto-order-preview.d.ts +0 -15
- package/dist/models/crypto-order-preview.js +0 -2
- package/dist/models/crypto-trading-instrument.d.ts +0 -22
- package/dist/models/crypto-trading-instrument.js +0 -2
- package/dist/models/cryptocurrency-pair-quote.d.ts +0 -32
- package/dist/models/cryptocurrency-pair-quote.js +0 -2
- package/dist/models/cryptocurrency-pair.d.ts +0 -32
- package/dist/models/cryptocurrency-pair.js +0 -2
- package/dist/models/currency.d.ts +0 -26
- package/dist/models/currency.js +0 -2
- package/dist/models/delete-connection-confirmation.d.ts +0 -20
- package/dist/models/delete-connection-confirmation.js +0 -2
- package/dist/models/delete-user-response.d.ts +0 -26
- package/dist/models/delete-user-response.js +0 -2
- package/dist/models/dividend-at-date.d.ts +0 -26
- package/dist/models/dividend-at-date.js +0 -2
- package/dist/models/encrypted-response-encrypted-message-data.d.ts +0 -26
- package/dist/models/encrypted-response-encrypted-message-data.js +0 -2
- package/dist/models/encrypted-response.d.ts +0 -20
- package/dist/models/encrypted-response.js +0 -2
- package/dist/models/etf-instrument.d.ts +0 -59
- package/dist/models/etf-instrument.js +0 -2
- package/dist/models/exchange-rate-pairs.d.ts +0 -27
- package/dist/models/exchange-rate-pairs.js +0 -2
- package/dist/models/exchange.d.ts +0 -56
- package/dist/models/exchange.js +0 -2
- package/dist/models/figi-instrument.d.ts +0 -20
- package/dist/models/figi-instrument.js +0 -2
- package/dist/models/future-instrument.d.ts +0 -64
- package/dist/models/future-instrument.js +0 -2
- package/dist/models/holdings-status.d.ts +0 -19
- package/dist/models/holdings-status.js +0 -2
- package/dist/models/index.d.ts +0 -173
- package/dist/models/index.js +0 -189
- package/dist/models/instrument.d.ts +0 -33
- package/dist/models/instrument.js +0 -2
- package/dist/models/login-redirect-uri.d.ts +0 -19
- package/dist/models/login-redirect-uri.js +0 -2
- package/dist/models/manual-trade-and-impact.d.ts +0 -29
- package/dist/models/manual-trade-and-impact.js +0 -2
- package/dist/models/manual-trade-balance.d.ts +0 -28
- package/dist/models/manual-trade-balance.js +0 -2
- package/dist/models/manual-trade-form-bracket.d.ts +0 -67
- package/dist/models/manual-trade-form-bracket.js +0 -2
- package/dist/models/manual-trade-form-complex.d.ts +0 -28
- package/dist/models/manual-trade-form-complex.js +0 -2
- package/dist/models/manual-trade-form-notional-value.d.ts +0 -6
- package/dist/models/manual-trade-form-notional-value.js +0 -2
- package/dist/models/manual-trade-form-with-options.d.ts +0 -78
- package/dist/models/manual-trade-form-with-options.js +0 -2
- package/dist/models/manual-trade-form.d.ts +0 -65
- package/dist/models/manual-trade-form.js +0 -2
- package/dist/models/manual-trade-impact.d.ts +0 -38
- package/dist/models/manual-trade-impact.js +0 -2
- package/dist/models/manual-trade-replace-form.d.ts +0 -58
- package/dist/models/manual-trade-replace-form.js +0 -2
- package/dist/models/manual-trade-symbol.d.ts +0 -49
- package/dist/models/manual-trade-symbol.js +0 -2
- package/dist/models/manual-trade.d.ts +0 -60
- package/dist/models/manual-trade.js +0 -2
- package/dist/models/mleg-action-strict.d.ts +0 -6
- package/dist/models/mleg-action-strict.js +0 -2
- package/dist/models/mleg-instrument-type.d.ts +0 -6
- package/dist/models/mleg-instrument-type.js +0 -2
- package/dist/models/mleg-leg.d.ts +0 -28
- package/dist/models/mleg-leg.js +0 -2
- package/dist/models/mleg-order-response.d.ts +0 -21
- package/dist/models/mleg-order-response.js +0 -2
- package/dist/models/mleg-order-type-strict.d.ts +0 -6
- package/dist/models/mleg-order-type-strict.js +0 -2
- package/dist/models/mleg-price-effect-strict.d.ts +0 -6
- package/dist/models/mleg-price-effect-strict.js +0 -2
- package/dist/models/mleg-trade-form.d.ts +0 -47
- package/dist/models/mleg-trade-form.js +0 -2
- package/dist/models/mleg-trading-instrument.d.ts +0 -21
- package/dist/models/mleg-trading-instrument.js +0 -2
- package/dist/models/model400-failed-request-response.d.ts +0 -20
- package/dist/models/model400-failed-request-response.js +0 -2
- package/dist/models/model401-failed-request-response.d.ts +0 -20
- package/dist/models/model401-failed-request-response.js +0 -2
- package/dist/models/model402-brokerage-auth-already-disabled-exception.d.ts +0 -20
- package/dist/models/model402-brokerage-auth-already-disabled-exception.js +0 -2
- package/dist/models/model402-brokerage-auth-disabled-response.d.ts +0 -20
- package/dist/models/model402-brokerage-auth-disabled-response.js +0 -2
- package/dist/models/model403-failed-request-response.d.ts +0 -20
- package/dist/models/model403-failed-request-response.js +0 -2
- package/dist/models/model403-feature-not-enabled-response.d.ts +0 -20
- package/dist/models/model403-feature-not-enabled-response.js +0 -2
- package/dist/models/model404-failed-request-response.d.ts +0 -20
- package/dist/models/model404-failed-request-response.js +0 -2
- package/dist/models/model425-failed-request-response.d.ts +0 -20
- package/dist/models/model425-failed-request-response.js +0 -2
- package/dist/models/model500-unexpected-exception-response.d.ts +0 -26
- package/dist/models/model500-unexpected-exception-response.js +0 -2
- package/dist/models/monthly-dividends.d.ts +0 -21
- package/dist/models/monthly-dividends.js +0 -2
- package/dist/models/mutual-fund-instrument.d.ts +0 -59
- package/dist/models/mutual-fund-instrument.js +0 -2
- package/dist/models/net-contributions.d.ts +0 -26
- package/dist/models/net-contributions.js +0 -2
- package/dist/models/net-dividend.d.ts +0 -27
- package/dist/models/net-dividend.js +0 -2
- package/dist/models/notional-value.d.ts +0 -6
- package/dist/models/notional-value.js +0 -2
- package/dist/models/option-brokerage-symbol.d.ts +0 -29
- package/dist/models/option-brokerage-symbol.js +0 -2
- package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +0 -26
- package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +0 -2
- package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +0 -27
- package/dist/models/option-chain-inner-chain-per-root-inner.js +0 -2
- package/dist/models/option-chain-inner.d.ts +0 -39
- package/dist/models/option-chain-inner.js +0 -2
- package/dist/models/option-impact.d.ts +0 -28
- package/dist/models/option-impact.js +0 -2
- package/dist/models/option-instrument.d.ts +0 -60
- package/dist/models/option-instrument.js +0 -2
- package/dist/models/option-leg.d.ts +0 -28
- package/dist/models/option-leg.js +0 -2
- package/dist/models/option-quote-greeks.d.ts +0 -32
- package/dist/models/option-quote-greeks.js +0 -2
- package/dist/models/option-quote.d.ts +0 -39
- package/dist/models/option-quote.js +0 -2
- package/dist/models/option-strategy-legs-inner.d.ts +0 -31
- package/dist/models/option-strategy-legs-inner.js +0 -2
- package/dist/models/option-strategy.d.ts +0 -40
- package/dist/models/option-strategy.js +0 -2
- package/dist/models/options-position-currency.d.ts +0 -25
- package/dist/models/options-position-currency.js +0 -2
- package/dist/models/options-position.d.ts +0 -41
- package/dist/models/options-position.js +0 -2
- package/dist/models/options-symbol.d.ts +0 -53
- package/dist/models/options-symbol.js +0 -2
- package/dist/models/order-type-strict.d.ts +0 -6
- package/dist/models/order-type-strict.js +0 -2
- package/dist/models/order-updated-response-order.d.ts +0 -167
- package/dist/models/order-updated-response-order.js +0 -2
- package/dist/models/order-updated-response.d.ts +0 -21
- package/dist/models/order-updated-response.js +0 -2
- package/dist/models/other-instrument.d.ts +0 -59
- package/dist/models/other-instrument.js +0 -2
- package/dist/models/paginated-universal-activity.d.ts +0 -22
- package/dist/models/paginated-universal-activity.js +0 -2
- package/dist/models/pagination-details.d.ts +0 -26
- package/dist/models/pagination-details.js +0 -2
- package/dist/models/partner-data.d.ts +0 -82
- package/dist/models/partner-data.js +0 -2
- package/dist/models/past-value.d.ts +0 -26
- package/dist/models/past-value.js +0 -2
- package/dist/models/performance-custom.d.ts +0 -127
- package/dist/models/performance-custom.js +0 -2
- package/dist/models/position-currency.d.ts +0 -25
- package/dist/models/position-currency.js +0 -2
- package/dist/models/position-symbol.d.ts +0 -50
- package/dist/models/position-symbol.js +0 -2
- package/dist/models/position.d.ts +0 -66
- package/dist/models/position.js +0 -2
- package/dist/models/rate-of-return-object.d.ts +0 -28
- package/dist/models/rate-of-return-object.js +0 -2
- package/dist/models/rate-of-return-response.d.ts +0 -15
- package/dist/models/rate-of-return-response.js +0 -2
- package/dist/models/recent-orders-response.d.ts +0 -15
- package/dist/models/recent-orders-response.js +0 -2
- package/dist/models/security-type.d.ts +0 -33
- package/dist/models/security-type.js +0 -2
- package/dist/models/session-event.d.ts +0 -52
- package/dist/models/session-event.js +0 -2
- package/dist/models/simple-order-form.d.ts +0 -67
- package/dist/models/simple-order-form.js +0 -2
- package/dist/models/snap-trade-holdings-account.d.ts +0 -60
- package/dist/models/snap-trade-holdings-account.js +0 -2
- package/dist/models/snap-trade-holdings-total-value.d.ts +0 -20
- package/dist/models/snap-trade-holdings-total-value.js +0 -2
- package/dist/models/snap-trade-login-user-request-body.d.ts +0 -58
- package/dist/models/snap-trade-login-user-request-body.js +0 -2
- package/dist/models/snap-trade-register-user-request-body.d.ts +0 -13
- package/dist/models/snap-trade-register-user-request-body.js +0 -2
- package/dist/models/status.d.ts +0 -26
- package/dist/models/status.js +0 -2
- package/dist/models/stock-instrument-figi-instrument.d.ts +0 -19
- package/dist/models/stock-instrument-figi-instrument.js +0 -2
- package/dist/models/stock-instrument.d.ts +0 -59
- package/dist/models/stock-instrument.js +0 -2
- package/dist/models/stop-loss.d.ts +0 -20
- package/dist/models/stop-loss.js +0 -2
- package/dist/models/strategy-order-record.d.ts +0 -77
- package/dist/models/strategy-order-record.js +0 -2
- package/dist/models/strategy-quotes-greek.d.ts +0 -38
- package/dist/models/strategy-quotes-greek.js +0 -2
- package/dist/models/strategy-quotes.d.ts +0 -46
- package/dist/models/strategy-quotes.js +0 -2
- package/dist/models/sub-period-return-rate.d.ts +0 -26
- package/dist/models/sub-period-return-rate.js +0 -2
- package/dist/models/symbol-currency.d.ts +0 -25
- package/dist/models/symbol-currency.js +0 -2
- package/dist/models/symbol-exchange.d.ts +0 -55
- package/dist/models/symbol-exchange.js +0 -2
- package/dist/models/symbol-query.d.ts +0 -13
- package/dist/models/symbol-query.js +0 -2
- package/dist/models/symbol.d.ts +0 -66
- package/dist/models/symbol.js +0 -2
- package/dist/models/symbols-quotes-inner.d.ts +0 -44
- package/dist/models/symbols-quotes-inner.js +0 -2
- package/dist/models/take-profit.d.ts +0 -14
- package/dist/models/take-profit.js +0 -2
- package/dist/models/tax-lot.d.ts +0 -50
- package/dist/models/tax-lot.js +0 -2
- package/dist/models/time-in-force-strict.d.ts +0 -6
- package/dist/models/time-in-force-strict.js +0 -2
- package/dist/models/trade-detection-cancel-subscription-response.d.ts +0 -14
- package/dist/models/trade-detection-cancel-subscription-response.js +0 -2
- package/dist/models/trade-detection-subscription.d.ts +0 -26
- package/dist/models/trade-detection-subscription.js +0 -2
- package/dist/models/trading-instrument.d.ts +0 -22
- package/dist/models/trading-instrument.js +0 -2
- package/dist/models/trading-search-cryptocurrency-pair-instruments200-response.d.ts +0 -15
- package/dist/models/trading-search-cryptocurrency-pair-instruments200-response.js +0 -2
- package/dist/models/trading-session.d.ts +0 -6
- package/dist/models/trading-session.js +0 -2
- package/dist/models/trailing-stop.d.ts +0 -22
- package/dist/models/trailing-stop.js +0 -2
- package/dist/models/transactions-status.d.ts +0 -25
- package/dist/models/transactions-status.js +0 -2
- package/dist/models/underlying-option-instrument.d.ts +0 -27
- package/dist/models/underlying-option-instrument.js +0 -2
- package/dist/models/underlying-symbol-exchange.d.ts +0 -61
- package/dist/models/underlying-symbol-exchange.js +0 -2
- package/dist/models/underlying-symbol-type.d.ts +0 -32
- package/dist/models/underlying-symbol-type.js +0 -2
- package/dist/models/underlying-symbol.d.ts +0 -74
- package/dist/models/underlying-symbol.js +0 -2
- package/dist/models/universal-activity.d.ts +0 -114
- package/dist/models/universal-activity.js +0 -2
- package/dist/models/universal-symbol.d.ts +0 -74
- package/dist/models/universal-symbol.js +0 -2
- package/dist/models/user-idand-secret.d.ts +0 -19
- package/dist/models/user-idand-secret.js +0 -2
- package/dist/models/usexchange.d.ts +0 -62
- package/dist/models/usexchange.js +0 -2
- package/dist/models/validated-trade-body.d.ts +0 -13
- package/dist/models/validated-trade-body.js +0 -2
- package/dist/operationParameterMap.d.ts +0 -8
- package/dist/operationParameterMap.js +0 -966
- package/dist/pagination/page-types.d.ts +0 -16
- package/dist/pagination/page-types.js +0 -12
- package/dist/pagination/page.d.ts +0 -25
- package/dist/pagination/page.js +0 -32
- package/dist/pagination/pageable.d.ts +0 -47
- package/dist/pagination/pageable.js +0 -70
- package/dist/pagination/paginate.d.ts +0 -6
- package/dist/pagination/paginate.js +0 -39
- package/dist/requestAfterHook.d.ts +0 -8
- package/dist/requestAfterHook.js +0 -82
- package/dist/requestBeforeHook.d.ts +0 -10
- package/dist/requestBeforeHook.js +0 -8
- package/dist/requestBeforeUrlHook.d.ts +0 -7
- package/dist/requestBeforeUrlHook.js +0 -5
|
@@ -1,950 +0,0 @@
|
|
|
1
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
2
|
-
import { Configuration } from '../configuration';
|
|
3
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
4
|
-
import { Account } from '../models';
|
|
5
|
-
import { AccountHoldings } from '../models';
|
|
6
|
-
import { AccountHoldingsAccount } from '../models';
|
|
7
|
-
import { AccountInformationGetUserAccountOrderDetailRequest } from '../models';
|
|
8
|
-
import { AccountOrderRecord } from '../models';
|
|
9
|
-
import { AccountValueHistoryResponse } from '../models';
|
|
10
|
-
import { AllAccountPositionsResponse } from '../models';
|
|
11
|
-
import { Balance } from '../models';
|
|
12
|
-
import { PaginatedUniversalActivity } from '../models';
|
|
13
|
-
import { Position } from '../models';
|
|
14
|
-
import { RateOfReturnResponse } from '../models';
|
|
15
|
-
import { RecentOrdersResponse } from '../models';
|
|
16
|
-
/**
|
|
17
|
-
* AccountInformationApi - axios parameter creator
|
|
18
|
-
* @export
|
|
19
|
-
*/
|
|
20
|
-
export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
-
/**
|
|
22
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
23
|
-
* @summary List account activities
|
|
24
|
-
* @param {string} accountId
|
|
25
|
-
* @param {string} userId
|
|
26
|
-
* @param {string} userSecret
|
|
27
|
-
* @param {string | Date} [startDate] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
28
|
-
* @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
29
|
-
* @param {number} [offset] An integer that specifies the starting point of the paginated results. Default is 0.
|
|
30
|
-
* @param {number} [limit] An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
31
|
-
* @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `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 assets from one account to another. - `SPLIT` - A stock share split.
|
|
32
|
-
* @param {*} [options] Override http request option.
|
|
33
|
-
* @throws {RequiredError}
|
|
34
|
-
*/
|
|
35
|
-
getAccountActivities: (accountId: string, userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, offset?: number, limit?: number, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
-
/**
|
|
37
|
-
* 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.
|
|
38
|
-
* @summary List historical account total value
|
|
39
|
-
* @param {string} userId
|
|
40
|
-
* @param {string} userSecret
|
|
41
|
-
* @param {string} accountId
|
|
42
|
-
* @param {*} [options] Override http request option.
|
|
43
|
-
* @throws {RequiredError}
|
|
44
|
-
*/
|
|
45
|
-
getAccountBalanceHistory: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
-
/**
|
|
47
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
48
|
-
* @summary List all account positions
|
|
49
|
-
* @param {string} userId
|
|
50
|
-
* @param {string} userSecret
|
|
51
|
-
* @param {string} accountId
|
|
52
|
-
* @param {*} [options] Override http request option.
|
|
53
|
-
* @throws {RequiredError}
|
|
54
|
-
*/
|
|
55
|
-
getAllAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
-
/**
|
|
57
|
-
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
58
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
59
|
-
* @param {string} userId
|
|
60
|
-
* @param {string} userSecret
|
|
61
|
-
* @param {string} [brokerageAuthorizations] Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
62
|
-
* @param {*} [options] Override http request option.
|
|
63
|
-
* @deprecated
|
|
64
|
-
* @throws {RequiredError}
|
|
65
|
-
*/
|
|
66
|
-
getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
|
-
/**
|
|
68
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
69
|
-
* @summary List account balances
|
|
70
|
-
* @param {string} userId
|
|
71
|
-
* @param {string} userSecret
|
|
72
|
-
* @param {string} accountId
|
|
73
|
-
* @param {*} [options] Override http request option.
|
|
74
|
-
* @throws {RequiredError}
|
|
75
|
-
*/
|
|
76
|
-
getUserAccountBalance: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
-
/**
|
|
78
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
79
|
-
* @summary Get account detail
|
|
80
|
-
* @param {string} userId
|
|
81
|
-
* @param {string} userSecret
|
|
82
|
-
* @param {string} accountId
|
|
83
|
-
* @param {*} [options] Override http request option.
|
|
84
|
-
* @throws {RequiredError}
|
|
85
|
-
*/
|
|
86
|
-
getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
-
/**
|
|
88
|
-
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
89
|
-
* @summary Get account order detail
|
|
90
|
-
* @param {string} accountId
|
|
91
|
-
* @param {string} userId
|
|
92
|
-
* @param {string} userSecret
|
|
93
|
-
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
94
|
-
* @param {*} [options] Override http request option.
|
|
95
|
-
* @throws {RequiredError}
|
|
96
|
-
*/
|
|
97
|
-
getUserAccountOrderDetail: (accountId: string, userId: string, userSecret: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
98
|
-
/**
|
|
99
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
100
|
-
* @summary List account orders
|
|
101
|
-
* @param {string} userId
|
|
102
|
-
* @param {string} userSecret
|
|
103
|
-
* @param {string} accountId
|
|
104
|
-
* @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
|
|
105
|
-
* @param {number} [days] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
|
|
106
|
-
* @param {*} [options] Override http request option.
|
|
107
|
-
* @throws {RequiredError}
|
|
108
|
-
*/
|
|
109
|
-
getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
110
|
-
/**
|
|
111
|
-
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
112
|
-
* @summary List account positions
|
|
113
|
-
* @param {string} userId
|
|
114
|
-
* @param {string} userSecret
|
|
115
|
-
* @param {string} accountId
|
|
116
|
-
* @param {*} [options] Override http request option.
|
|
117
|
-
* @throws {RequiredError}
|
|
118
|
-
*/
|
|
119
|
-
getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
120
|
-
/**
|
|
121
|
-
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
122
|
-
* @summary List account recent orders (last 24 hours only)
|
|
123
|
-
* @param {string} userId
|
|
124
|
-
* @param {string} userSecret
|
|
125
|
-
* @param {string} accountId
|
|
126
|
-
* @param {boolean} [onlyExecuted] Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
|
|
127
|
-
* @param {*} [options] Override http request option.
|
|
128
|
-
* @throws {RequiredError}
|
|
129
|
-
*/
|
|
130
|
-
getUserAccountRecentOrders: (userId: string, userSecret: string, accountId: string, onlyExecuted?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
|
-
/**
|
|
132
|
-
* Returns a list of rate of return percents for a given account.
|
|
133
|
-
* @summary List account rate of returns
|
|
134
|
-
* @param {string} userId
|
|
135
|
-
* @param {string} userSecret
|
|
136
|
-
* @param {string} accountId
|
|
137
|
-
* @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.
|
|
138
|
-
* @param {*} [options] Override http request option.
|
|
139
|
-
* @throws {RequiredError}
|
|
140
|
-
*/
|
|
141
|
-
getUserAccountReturnRates: (userId: string, userSecret: string, accountId: string, timeframes?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
|
-
/**
|
|
143
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
144
|
-
* @summary List account holdings
|
|
145
|
-
* @param {string} accountId
|
|
146
|
-
* @param {string} userId
|
|
147
|
-
* @param {string} userSecret
|
|
148
|
-
* @param {*} [options] Override http request option.
|
|
149
|
-
* @deprecated
|
|
150
|
-
* @throws {RequiredError}
|
|
151
|
-
*/
|
|
152
|
-
getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
153
|
-
/**
|
|
154
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
155
|
-
* @summary List accounts
|
|
156
|
-
* @param {string} userId
|
|
157
|
-
* @param {string} userSecret
|
|
158
|
-
* @param {*} [options] Override http request option.
|
|
159
|
-
* @deprecated
|
|
160
|
-
* @throws {RequiredError}
|
|
161
|
-
*/
|
|
162
|
-
listUserAccounts: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
163
|
-
/**
|
|
164
|
-
* Updates various properties of a specified account.
|
|
165
|
-
* @summary Update details of an investment account
|
|
166
|
-
* @param {string} userId
|
|
167
|
-
* @param {string} userSecret
|
|
168
|
-
* @param {string} accountId The ID of the account to update.
|
|
169
|
-
* @param {*} [options] Override http request option.
|
|
170
|
-
* @throws {RequiredError}
|
|
171
|
-
*/
|
|
172
|
-
updateUserAccount: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
173
|
-
};
|
|
174
|
-
/**
|
|
175
|
-
* AccountInformationApi - functional programming interface
|
|
176
|
-
* @export
|
|
177
|
-
*/
|
|
178
|
-
export declare const AccountInformationApiFp: (configuration?: Configuration) => {
|
|
179
|
-
/**
|
|
180
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
181
|
-
* @summary List account activities
|
|
182
|
-
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
183
|
-
* @param {*} [options] Override http request option.
|
|
184
|
-
* @throws {RequiredError}
|
|
185
|
-
*/
|
|
186
|
-
getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedUniversalActivity>>;
|
|
187
|
-
/**
|
|
188
|
-
* 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.
|
|
189
|
-
* @summary List historical account total value
|
|
190
|
-
* @param {AccountInformationApiGetAccountBalanceHistoryRequest} requestParameters Request parameters.
|
|
191
|
-
* @param {*} [options] Override http request option.
|
|
192
|
-
* @throws {RequiredError}
|
|
193
|
-
*/
|
|
194
|
-
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
195
|
-
/**
|
|
196
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
197
|
-
* @summary List all account positions
|
|
198
|
-
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
199
|
-
* @param {*} [options] Override http request option.
|
|
200
|
-
* @throws {RequiredError}
|
|
201
|
-
*/
|
|
202
|
-
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllAccountPositionsResponse>>;
|
|
203
|
-
/**
|
|
204
|
-
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
205
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
206
|
-
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
207
|
-
* @param {*} [options] Override http request option.
|
|
208
|
-
* @deprecated
|
|
209
|
-
* @throws {RequiredError}
|
|
210
|
-
*/
|
|
211
|
-
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
|
|
212
|
-
/**
|
|
213
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
214
|
-
* @summary List account balances
|
|
215
|
-
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
216
|
-
* @param {*} [options] Override http request option.
|
|
217
|
-
* @throws {RequiredError}
|
|
218
|
-
*/
|
|
219
|
-
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Balance>>>;
|
|
220
|
-
/**
|
|
221
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
222
|
-
* @summary Get account detail
|
|
223
|
-
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
224
|
-
* @param {*} [options] Override http request option.
|
|
225
|
-
* @throws {RequiredError}
|
|
226
|
-
*/
|
|
227
|
-
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
|
|
228
|
-
/**
|
|
229
|
-
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
230
|
-
* @summary Get account order detail
|
|
231
|
-
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
232
|
-
* @param {*} [options] Override http request option.
|
|
233
|
-
* @throws {RequiredError}
|
|
234
|
-
*/
|
|
235
|
-
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
236
|
-
/**
|
|
237
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
238
|
-
* @summary List account orders
|
|
239
|
-
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
240
|
-
* @param {*} [options] Override http request option.
|
|
241
|
-
* @throws {RequiredError}
|
|
242
|
-
*/
|
|
243
|
-
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
|
|
244
|
-
/**
|
|
245
|
-
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
246
|
-
* @summary List account positions
|
|
247
|
-
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
248
|
-
* @param {*} [options] Override http request option.
|
|
249
|
-
* @throws {RequiredError}
|
|
250
|
-
*/
|
|
251
|
-
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
|
|
252
|
-
/**
|
|
253
|
-
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
254
|
-
* @summary List account recent orders (last 24 hours only)
|
|
255
|
-
* @param {AccountInformationApiGetUserAccountRecentOrdersRequest} requestParameters Request parameters.
|
|
256
|
-
* @param {*} [options] Override http request option.
|
|
257
|
-
* @throws {RequiredError}
|
|
258
|
-
*/
|
|
259
|
-
getUserAccountRecentOrders(requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecentOrdersResponse>>;
|
|
260
|
-
/**
|
|
261
|
-
* Returns a list of rate of return percents for a given account.
|
|
262
|
-
* @summary List account rate of returns
|
|
263
|
-
* @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
|
|
264
|
-
* @param {*} [options] Override http request option.
|
|
265
|
-
* @throws {RequiredError}
|
|
266
|
-
*/
|
|
267
|
-
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
268
|
-
/**
|
|
269
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
270
|
-
* @summary List account holdings
|
|
271
|
-
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
272
|
-
* @param {*} [options] Override http request option.
|
|
273
|
-
* @deprecated
|
|
274
|
-
* @throws {RequiredError}
|
|
275
|
-
*/
|
|
276
|
-
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
277
|
-
/**
|
|
278
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
279
|
-
* @summary List accounts
|
|
280
|
-
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
281
|
-
* @param {*} [options] Override http request option.
|
|
282
|
-
* @deprecated
|
|
283
|
-
* @throws {RequiredError}
|
|
284
|
-
*/
|
|
285
|
-
listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
286
|
-
/**
|
|
287
|
-
* Updates various properties of a specified account.
|
|
288
|
-
* @summary Update details of an investment account
|
|
289
|
-
* @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
|
|
290
|
-
* @param {*} [options] Override http request option.
|
|
291
|
-
* @throws {RequiredError}
|
|
292
|
-
*/
|
|
293
|
-
updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
294
|
-
};
|
|
295
|
-
/**
|
|
296
|
-
* AccountInformationApi - factory interface
|
|
297
|
-
* @export
|
|
298
|
-
*/
|
|
299
|
-
export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
300
|
-
/**
|
|
301
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
302
|
-
* @summary List account activities
|
|
303
|
-
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
304
|
-
* @param {*} [options] Override http request option.
|
|
305
|
-
* @throws {RequiredError}
|
|
306
|
-
*/
|
|
307
|
-
getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<PaginatedUniversalActivity>;
|
|
308
|
-
/**
|
|
309
|
-
* 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.
|
|
310
|
-
* @summary List historical account total value
|
|
311
|
-
* @param {AccountInformationApiGetAccountBalanceHistoryRequest} requestParameters Request parameters.
|
|
312
|
-
* @param {*} [options] Override http request option.
|
|
313
|
-
* @throws {RequiredError}
|
|
314
|
-
*/
|
|
315
|
-
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<AccountValueHistoryResponse>;
|
|
316
|
-
/**
|
|
317
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
318
|
-
* @summary List all account positions
|
|
319
|
-
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
320
|
-
* @param {*} [options] Override http request option.
|
|
321
|
-
* @throws {RequiredError}
|
|
322
|
-
*/
|
|
323
|
-
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<AllAccountPositionsResponse>;
|
|
324
|
-
/**
|
|
325
|
-
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
326
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
327
|
-
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
328
|
-
* @param {*} [options] Override http request option.
|
|
329
|
-
* @deprecated
|
|
330
|
-
* @throws {RequiredError}
|
|
331
|
-
*/
|
|
332
|
-
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
|
|
333
|
-
/**
|
|
334
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
335
|
-
* @summary List account balances
|
|
336
|
-
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
337
|
-
* @param {*} [options] Override http request option.
|
|
338
|
-
* @throws {RequiredError}
|
|
339
|
-
*/
|
|
340
|
-
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Balance>>;
|
|
341
|
-
/**
|
|
342
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
343
|
-
* @summary Get account detail
|
|
344
|
-
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
345
|
-
* @param {*} [options] Override http request option.
|
|
346
|
-
* @throws {RequiredError}
|
|
347
|
-
*/
|
|
348
|
-
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
|
|
349
|
-
/**
|
|
350
|
-
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
351
|
-
* @summary Get account order detail
|
|
352
|
-
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
353
|
-
* @param {*} [options] Override http request option.
|
|
354
|
-
* @throws {RequiredError}
|
|
355
|
-
*/
|
|
356
|
-
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
357
|
-
/**
|
|
358
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
359
|
-
* @summary List account orders
|
|
360
|
-
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
361
|
-
* @param {*} [options] Override http request option.
|
|
362
|
-
* @throws {RequiredError}
|
|
363
|
-
*/
|
|
364
|
-
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
|
|
365
|
-
/**
|
|
366
|
-
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
367
|
-
* @summary List account positions
|
|
368
|
-
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
369
|
-
* @param {*} [options] Override http request option.
|
|
370
|
-
* @throws {RequiredError}
|
|
371
|
-
*/
|
|
372
|
-
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
|
|
373
|
-
/**
|
|
374
|
-
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
375
|
-
* @summary List account recent orders (last 24 hours only)
|
|
376
|
-
* @param {AccountInformationApiGetUserAccountRecentOrdersRequest} requestParameters Request parameters.
|
|
377
|
-
* @param {*} [options] Override http request option.
|
|
378
|
-
* @throws {RequiredError}
|
|
379
|
-
*/
|
|
380
|
-
getUserAccountRecentOrders(requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<RecentOrdersResponse>;
|
|
381
|
-
/**
|
|
382
|
-
* Returns a list of rate of return percents for a given account.
|
|
383
|
-
* @summary List account rate of returns
|
|
384
|
-
* @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
|
|
385
|
-
* @param {*} [options] Override http request option.
|
|
386
|
-
* @throws {RequiredError}
|
|
387
|
-
*/
|
|
388
|
-
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
|
|
389
|
-
/**
|
|
390
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
391
|
-
* @summary List account holdings
|
|
392
|
-
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
393
|
-
* @param {*} [options] Override http request option.
|
|
394
|
-
* @deprecated
|
|
395
|
-
* @throws {RequiredError}
|
|
396
|
-
*/
|
|
397
|
-
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
|
|
398
|
-
/**
|
|
399
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
400
|
-
* @summary List accounts
|
|
401
|
-
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
402
|
-
* @param {*} [options] Override http request option.
|
|
403
|
-
* @deprecated
|
|
404
|
-
* @throws {RequiredError}
|
|
405
|
-
*/
|
|
406
|
-
listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
|
|
407
|
-
/**
|
|
408
|
-
* Updates various properties of a specified account.
|
|
409
|
-
* @summary Update details of an investment account
|
|
410
|
-
* @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
|
|
411
|
-
* @param {*} [options] Override http request option.
|
|
412
|
-
* @throws {RequiredError}
|
|
413
|
-
*/
|
|
414
|
-
updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
|
|
415
|
-
};
|
|
416
|
-
/**
|
|
417
|
-
* Request parameters for getAccountActivities operation in AccountInformationApi.
|
|
418
|
-
* @export
|
|
419
|
-
* @interface AccountInformationApiGetAccountActivitiesRequest
|
|
420
|
-
*/
|
|
421
|
-
export type AccountInformationApiGetAccountActivitiesRequest = {
|
|
422
|
-
/**
|
|
423
|
-
*
|
|
424
|
-
* @type {string}
|
|
425
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
426
|
-
*/
|
|
427
|
-
readonly accountId: string;
|
|
428
|
-
/**
|
|
429
|
-
*
|
|
430
|
-
* @type {string}
|
|
431
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
432
|
-
*/
|
|
433
|
-
readonly userId: string;
|
|
434
|
-
/**
|
|
435
|
-
*
|
|
436
|
-
* @type {string}
|
|
437
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
438
|
-
*/
|
|
439
|
-
readonly userSecret: string;
|
|
440
|
-
/**
|
|
441
|
-
* The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
|
|
442
|
-
* @type {string | Date}
|
|
443
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
444
|
-
*/
|
|
445
|
-
readonly startDate?: string | Date;
|
|
446
|
-
/**
|
|
447
|
-
* The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
|
|
448
|
-
* @type {string | Date}
|
|
449
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
450
|
-
*/
|
|
451
|
-
readonly endDate?: string | Date;
|
|
452
|
-
/**
|
|
453
|
-
* An integer that specifies the starting point of the paginated results. Default is 0.
|
|
454
|
-
* @type {number}
|
|
455
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
456
|
-
*/
|
|
457
|
-
readonly offset?: number;
|
|
458
|
-
/**
|
|
459
|
-
* An integer that specifies the maximum number of transactions to return. Default of 1000.
|
|
460
|
-
* @type {number}
|
|
461
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
462
|
-
*/
|
|
463
|
-
readonly limit?: number;
|
|
464
|
-
/**
|
|
465
|
-
* Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize brokerage transaction types into a common set of values. Here are some of the most popular values: - `BUY` - Asset bought. - `SELL` - Asset sold. - `DIVIDEND` - Dividend payout. - `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 assets from one account to another. - `SPLIT` - A stock share split.
|
|
466
|
-
* @type {string}
|
|
467
|
-
* @memberof AccountInformationApiGetAccountActivities
|
|
468
|
-
*/
|
|
469
|
-
readonly type?: string;
|
|
470
|
-
};
|
|
471
|
-
/**
|
|
472
|
-
* Request parameters for getAccountBalanceHistory operation in AccountInformationApi.
|
|
473
|
-
* @export
|
|
474
|
-
* @interface AccountInformationApiGetAccountBalanceHistoryRequest
|
|
475
|
-
*/
|
|
476
|
-
export type AccountInformationApiGetAccountBalanceHistoryRequest = {
|
|
477
|
-
/**
|
|
478
|
-
*
|
|
479
|
-
* @type {string}
|
|
480
|
-
* @memberof AccountInformationApiGetAccountBalanceHistory
|
|
481
|
-
*/
|
|
482
|
-
readonly userId: string;
|
|
483
|
-
/**
|
|
484
|
-
*
|
|
485
|
-
* @type {string}
|
|
486
|
-
* @memberof AccountInformationApiGetAccountBalanceHistory
|
|
487
|
-
*/
|
|
488
|
-
readonly userSecret: string;
|
|
489
|
-
/**
|
|
490
|
-
*
|
|
491
|
-
* @type {string}
|
|
492
|
-
* @memberof AccountInformationApiGetAccountBalanceHistory
|
|
493
|
-
*/
|
|
494
|
-
readonly accountId: string;
|
|
495
|
-
};
|
|
496
|
-
/**
|
|
497
|
-
* Request parameters for getAllAccountPositions operation in AccountInformationApi.
|
|
498
|
-
* @export
|
|
499
|
-
* @interface AccountInformationApiGetAllAccountPositionsRequest
|
|
500
|
-
*/
|
|
501
|
-
export type AccountInformationApiGetAllAccountPositionsRequest = {
|
|
502
|
-
/**
|
|
503
|
-
*
|
|
504
|
-
* @type {string}
|
|
505
|
-
* @memberof AccountInformationApiGetAllAccountPositions
|
|
506
|
-
*/
|
|
507
|
-
readonly userId: string;
|
|
508
|
-
/**
|
|
509
|
-
*
|
|
510
|
-
* @type {string}
|
|
511
|
-
* @memberof AccountInformationApiGetAllAccountPositions
|
|
512
|
-
*/
|
|
513
|
-
readonly userSecret: string;
|
|
514
|
-
/**
|
|
515
|
-
*
|
|
516
|
-
* @type {string}
|
|
517
|
-
* @memberof AccountInformationApiGetAllAccountPositions
|
|
518
|
-
*/
|
|
519
|
-
readonly accountId: string;
|
|
520
|
-
};
|
|
521
|
-
/**
|
|
522
|
-
* Request parameters for getAllUserHoldings operation in AccountInformationApi.
|
|
523
|
-
* @export
|
|
524
|
-
* @interface AccountInformationApiGetAllUserHoldingsRequest
|
|
525
|
-
*/
|
|
526
|
-
export type AccountInformationApiGetAllUserHoldingsRequest = {
|
|
527
|
-
/**
|
|
528
|
-
*
|
|
529
|
-
* @type {string}
|
|
530
|
-
* @memberof AccountInformationApiGetAllUserHoldings
|
|
531
|
-
*/
|
|
532
|
-
readonly userId: string;
|
|
533
|
-
/**
|
|
534
|
-
*
|
|
535
|
-
* @type {string}
|
|
536
|
-
* @memberof AccountInformationApiGetAllUserHoldings
|
|
537
|
-
*/
|
|
538
|
-
readonly userSecret: string;
|
|
539
|
-
/**
|
|
540
|
-
* Optional. Comma separated list of authorization IDs (only use if filtering is needed on one or more authorizations).
|
|
541
|
-
* @type {string}
|
|
542
|
-
* @memberof AccountInformationApiGetAllUserHoldings
|
|
543
|
-
*/
|
|
544
|
-
readonly brokerageAuthorizations?: string;
|
|
545
|
-
};
|
|
546
|
-
/**
|
|
547
|
-
* Request parameters for getUserAccountBalance operation in AccountInformationApi.
|
|
548
|
-
* @export
|
|
549
|
-
* @interface AccountInformationApiGetUserAccountBalanceRequest
|
|
550
|
-
*/
|
|
551
|
-
export type AccountInformationApiGetUserAccountBalanceRequest = {
|
|
552
|
-
/**
|
|
553
|
-
*
|
|
554
|
-
* @type {string}
|
|
555
|
-
* @memberof AccountInformationApiGetUserAccountBalance
|
|
556
|
-
*/
|
|
557
|
-
readonly userId: string;
|
|
558
|
-
/**
|
|
559
|
-
*
|
|
560
|
-
* @type {string}
|
|
561
|
-
* @memberof AccountInformationApiGetUserAccountBalance
|
|
562
|
-
*/
|
|
563
|
-
readonly userSecret: string;
|
|
564
|
-
/**
|
|
565
|
-
*
|
|
566
|
-
* @type {string}
|
|
567
|
-
* @memberof AccountInformationApiGetUserAccountBalance
|
|
568
|
-
*/
|
|
569
|
-
readonly accountId: string;
|
|
570
|
-
};
|
|
571
|
-
/**
|
|
572
|
-
* Request parameters for getUserAccountDetails operation in AccountInformationApi.
|
|
573
|
-
* @export
|
|
574
|
-
* @interface AccountInformationApiGetUserAccountDetailsRequest
|
|
575
|
-
*/
|
|
576
|
-
export type AccountInformationApiGetUserAccountDetailsRequest = {
|
|
577
|
-
/**
|
|
578
|
-
*
|
|
579
|
-
* @type {string}
|
|
580
|
-
* @memberof AccountInformationApiGetUserAccountDetails
|
|
581
|
-
*/
|
|
582
|
-
readonly userId: string;
|
|
583
|
-
/**
|
|
584
|
-
*
|
|
585
|
-
* @type {string}
|
|
586
|
-
* @memberof AccountInformationApiGetUserAccountDetails
|
|
587
|
-
*/
|
|
588
|
-
readonly userSecret: string;
|
|
589
|
-
/**
|
|
590
|
-
*
|
|
591
|
-
* @type {string}
|
|
592
|
-
* @memberof AccountInformationApiGetUserAccountDetails
|
|
593
|
-
*/
|
|
594
|
-
readonly accountId: string;
|
|
595
|
-
};
|
|
596
|
-
/**
|
|
597
|
-
* Request parameters for getUserAccountOrderDetail operation in AccountInformationApi.
|
|
598
|
-
* @export
|
|
599
|
-
* @interface AccountInformationApiGetUserAccountOrderDetailRequest
|
|
600
|
-
*/
|
|
601
|
-
export type AccountInformationApiGetUserAccountOrderDetailRequest = {
|
|
602
|
-
/**
|
|
603
|
-
*
|
|
604
|
-
* @type {string}
|
|
605
|
-
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
606
|
-
*/
|
|
607
|
-
readonly accountId: string;
|
|
608
|
-
/**
|
|
609
|
-
*
|
|
610
|
-
* @type {string}
|
|
611
|
-
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
612
|
-
*/
|
|
613
|
-
readonly userId: string;
|
|
614
|
-
/**
|
|
615
|
-
*
|
|
616
|
-
* @type {string}
|
|
617
|
-
* @memberof AccountInformationApiGetUserAccountOrderDetail
|
|
618
|
-
*/
|
|
619
|
-
readonly userSecret: string;
|
|
620
|
-
} & AccountInformationGetUserAccountOrderDetailRequest;
|
|
621
|
-
/**
|
|
622
|
-
* Request parameters for getUserAccountOrders operation in AccountInformationApi.
|
|
623
|
-
* @export
|
|
624
|
-
* @interface AccountInformationApiGetUserAccountOrdersRequest
|
|
625
|
-
*/
|
|
626
|
-
export type AccountInformationApiGetUserAccountOrdersRequest = {
|
|
627
|
-
/**
|
|
628
|
-
*
|
|
629
|
-
* @type {string}
|
|
630
|
-
* @memberof AccountInformationApiGetUserAccountOrders
|
|
631
|
-
*/
|
|
632
|
-
readonly userId: string;
|
|
633
|
-
/**
|
|
634
|
-
*
|
|
635
|
-
* @type {string}
|
|
636
|
-
* @memberof AccountInformationApiGetUserAccountOrders
|
|
637
|
-
*/
|
|
638
|
-
readonly userSecret: string;
|
|
639
|
-
/**
|
|
640
|
-
*
|
|
641
|
-
* @type {string}
|
|
642
|
-
* @memberof AccountInformationApiGetUserAccountOrders
|
|
643
|
-
*/
|
|
644
|
-
readonly accountId: string;
|
|
645
|
-
/**
|
|
646
|
-
* defaults value is set to \"all\"
|
|
647
|
-
* @type {'all' | 'open' | 'executed'}
|
|
648
|
-
* @memberof AccountInformationApiGetUserAccountOrders
|
|
649
|
-
*/
|
|
650
|
-
readonly state?: 'all' | 'open' | 'executed';
|
|
651
|
-
/**
|
|
652
|
-
* Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
|
|
653
|
-
* @type {number}
|
|
654
|
-
* @memberof AccountInformationApiGetUserAccountOrders
|
|
655
|
-
*/
|
|
656
|
-
readonly days?: number;
|
|
657
|
-
};
|
|
658
|
-
/**
|
|
659
|
-
* Request parameters for getUserAccountPositions operation in AccountInformationApi.
|
|
660
|
-
* @export
|
|
661
|
-
* @interface AccountInformationApiGetUserAccountPositionsRequest
|
|
662
|
-
*/
|
|
663
|
-
export type AccountInformationApiGetUserAccountPositionsRequest = {
|
|
664
|
-
/**
|
|
665
|
-
*
|
|
666
|
-
* @type {string}
|
|
667
|
-
* @memberof AccountInformationApiGetUserAccountPositions
|
|
668
|
-
*/
|
|
669
|
-
readonly userId: string;
|
|
670
|
-
/**
|
|
671
|
-
*
|
|
672
|
-
* @type {string}
|
|
673
|
-
* @memberof AccountInformationApiGetUserAccountPositions
|
|
674
|
-
*/
|
|
675
|
-
readonly userSecret: string;
|
|
676
|
-
/**
|
|
677
|
-
*
|
|
678
|
-
* @type {string}
|
|
679
|
-
* @memberof AccountInformationApiGetUserAccountPositions
|
|
680
|
-
*/
|
|
681
|
-
readonly accountId: string;
|
|
682
|
-
};
|
|
683
|
-
/**
|
|
684
|
-
* Request parameters for getUserAccountRecentOrders operation in AccountInformationApi.
|
|
685
|
-
* @export
|
|
686
|
-
* @interface AccountInformationApiGetUserAccountRecentOrdersRequest
|
|
687
|
-
*/
|
|
688
|
-
export type AccountInformationApiGetUserAccountRecentOrdersRequest = {
|
|
689
|
-
/**
|
|
690
|
-
*
|
|
691
|
-
* @type {string}
|
|
692
|
-
* @memberof AccountInformationApiGetUserAccountRecentOrders
|
|
693
|
-
*/
|
|
694
|
-
readonly userId: string;
|
|
695
|
-
/**
|
|
696
|
-
*
|
|
697
|
-
* @type {string}
|
|
698
|
-
* @memberof AccountInformationApiGetUserAccountRecentOrders
|
|
699
|
-
*/
|
|
700
|
-
readonly userSecret: string;
|
|
701
|
-
/**
|
|
702
|
-
*
|
|
703
|
-
* @type {string}
|
|
704
|
-
* @memberof AccountInformationApiGetUserAccountRecentOrders
|
|
705
|
-
*/
|
|
706
|
-
readonly accountId: string;
|
|
707
|
-
/**
|
|
708
|
-
* Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
|
|
709
|
-
* @type {boolean}
|
|
710
|
-
* @memberof AccountInformationApiGetUserAccountRecentOrders
|
|
711
|
-
*/
|
|
712
|
-
readonly onlyExecuted?: boolean;
|
|
713
|
-
};
|
|
714
|
-
/**
|
|
715
|
-
* Request parameters for getUserAccountReturnRates operation in AccountInformationApi.
|
|
716
|
-
* @export
|
|
717
|
-
* @interface AccountInformationApiGetUserAccountReturnRatesRequest
|
|
718
|
-
*/
|
|
719
|
-
export type AccountInformationApiGetUserAccountReturnRatesRequest = {
|
|
720
|
-
/**
|
|
721
|
-
*
|
|
722
|
-
* @type {string}
|
|
723
|
-
* @memberof AccountInformationApiGetUserAccountReturnRates
|
|
724
|
-
*/
|
|
725
|
-
readonly userId: string;
|
|
726
|
-
/**
|
|
727
|
-
*
|
|
728
|
-
* @type {string}
|
|
729
|
-
* @memberof AccountInformationApiGetUserAccountReturnRates
|
|
730
|
-
*/
|
|
731
|
-
readonly userSecret: string;
|
|
732
|
-
/**
|
|
733
|
-
*
|
|
734
|
-
* @type {string}
|
|
735
|
-
* @memberof AccountInformationApiGetUserAccountReturnRates
|
|
736
|
-
*/
|
|
737
|
-
readonly accountId: string;
|
|
738
|
-
/**
|
|
739
|
-
* 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.
|
|
740
|
-
* @type {string}
|
|
741
|
-
* @memberof AccountInformationApiGetUserAccountReturnRates
|
|
742
|
-
*/
|
|
743
|
-
readonly timeframes?: string;
|
|
744
|
-
};
|
|
745
|
-
/**
|
|
746
|
-
* Request parameters for getUserHoldings operation in AccountInformationApi.
|
|
747
|
-
* @export
|
|
748
|
-
* @interface AccountInformationApiGetUserHoldingsRequest
|
|
749
|
-
*/
|
|
750
|
-
export type AccountInformationApiGetUserHoldingsRequest = {
|
|
751
|
-
/**
|
|
752
|
-
*
|
|
753
|
-
* @type {string}
|
|
754
|
-
* @memberof AccountInformationApiGetUserHoldings
|
|
755
|
-
*/
|
|
756
|
-
readonly accountId: string;
|
|
757
|
-
/**
|
|
758
|
-
*
|
|
759
|
-
* @type {string}
|
|
760
|
-
* @memberof AccountInformationApiGetUserHoldings
|
|
761
|
-
*/
|
|
762
|
-
readonly userId: string;
|
|
763
|
-
/**
|
|
764
|
-
*
|
|
765
|
-
* @type {string}
|
|
766
|
-
* @memberof AccountInformationApiGetUserHoldings
|
|
767
|
-
*/
|
|
768
|
-
readonly userSecret: string;
|
|
769
|
-
};
|
|
770
|
-
/**
|
|
771
|
-
* Request parameters for listUserAccounts operation in AccountInformationApi.
|
|
772
|
-
* @export
|
|
773
|
-
* @interface AccountInformationApiListUserAccountsRequest
|
|
774
|
-
*/
|
|
775
|
-
export type AccountInformationApiListUserAccountsRequest = {
|
|
776
|
-
/**
|
|
777
|
-
*
|
|
778
|
-
* @type {string}
|
|
779
|
-
* @memberof AccountInformationApiListUserAccounts
|
|
780
|
-
*/
|
|
781
|
-
readonly userId: string;
|
|
782
|
-
/**
|
|
783
|
-
*
|
|
784
|
-
* @type {string}
|
|
785
|
-
* @memberof AccountInformationApiListUserAccounts
|
|
786
|
-
*/
|
|
787
|
-
readonly userSecret: string;
|
|
788
|
-
};
|
|
789
|
-
/**
|
|
790
|
-
* Request parameters for updateUserAccount operation in AccountInformationApi.
|
|
791
|
-
* @export
|
|
792
|
-
* @interface AccountInformationApiUpdateUserAccountRequest
|
|
793
|
-
*/
|
|
794
|
-
export type AccountInformationApiUpdateUserAccountRequest = {
|
|
795
|
-
/**
|
|
796
|
-
*
|
|
797
|
-
* @type {string}
|
|
798
|
-
* @memberof AccountInformationApiUpdateUserAccount
|
|
799
|
-
*/
|
|
800
|
-
readonly userId: string;
|
|
801
|
-
/**
|
|
802
|
-
*
|
|
803
|
-
* @type {string}
|
|
804
|
-
* @memberof AccountInformationApiUpdateUserAccount
|
|
805
|
-
*/
|
|
806
|
-
readonly userSecret: string;
|
|
807
|
-
/**
|
|
808
|
-
* The ID of the account to update.
|
|
809
|
-
* @type {string}
|
|
810
|
-
* @memberof AccountInformationApiUpdateUserAccount
|
|
811
|
-
*/
|
|
812
|
-
readonly accountId: string;
|
|
813
|
-
};
|
|
814
|
-
/**
|
|
815
|
-
* AccountInformationApiGenerated - object-oriented interface
|
|
816
|
-
* @export
|
|
817
|
-
* @class AccountInformationApiGenerated
|
|
818
|
-
* @extends {BaseAPI}
|
|
819
|
-
*/
|
|
820
|
-
export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
821
|
-
/**
|
|
822
|
-
* Returns all historical transactions for the specified account. This endpoint is paginated with a default page size of 1000. The endpoint will return a maximum of 1000 transactions per request. See the query parameters for pagination options. Transaction are returned in reverse chronological order, using the `trade_date` field. This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
823
|
-
* @summary List account activities
|
|
824
|
-
* @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
|
|
825
|
-
* @param {*} [options] Override http request option.
|
|
826
|
-
* @throws {RequiredError}
|
|
827
|
-
* @memberof AccountInformationApiGenerated
|
|
828
|
-
*/
|
|
829
|
-
getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedUniversalActivity, any, {}>>;
|
|
830
|
-
/**
|
|
831
|
-
* 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.
|
|
832
|
-
* @summary List historical account total value
|
|
833
|
-
* @param {AccountInformationApiGetAccountBalanceHistoryRequest} requestParameters Request parameters.
|
|
834
|
-
* @param {*} [options] Override http request option.
|
|
835
|
-
* @throws {RequiredError}
|
|
836
|
-
* @memberof AccountInformationApiGenerated
|
|
837
|
-
*/
|
|
838
|
-
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
839
|
-
/**
|
|
840
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
841
|
-
* @summary List all account positions
|
|
842
|
-
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
843
|
-
* @param {*} [options] Override http request option.
|
|
844
|
-
* @throws {RequiredError}
|
|
845
|
-
* @memberof AccountInformationApiGenerated
|
|
846
|
-
*/
|
|
847
|
-
getAllAccountPositions(requestParameters: AccountInformationApiGetAllAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AllAccountPositionsResponse, any, {}>>;
|
|
848
|
-
/**
|
|
849
|
-
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account. **Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.
|
|
850
|
-
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
851
|
-
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
852
|
-
* @param {*} [options] Override http request option.
|
|
853
|
-
* @deprecated
|
|
854
|
-
* @throws {RequiredError}
|
|
855
|
-
* @memberof AccountInformationApiGenerated
|
|
856
|
-
*/
|
|
857
|
-
getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any, {}>>;
|
|
858
|
-
/**
|
|
859
|
-
* Returns a list of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
860
|
-
* @summary List account balances
|
|
861
|
-
* @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
|
|
862
|
-
* @param {*} [options] Override http request option.
|
|
863
|
-
* @throws {RequiredError}
|
|
864
|
-
* @memberof AccountInformationApiGenerated
|
|
865
|
-
*/
|
|
866
|
-
getUserAccountBalance(requestParameters: AccountInformationApiGetUserAccountBalanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance[], any, {}>>;
|
|
867
|
-
/**
|
|
868
|
-
* Returns account detail known to SnapTrade for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
869
|
-
* @summary Get account detail
|
|
870
|
-
* @param {AccountInformationApiGetUserAccountDetailsRequest} requestParameters Request parameters.
|
|
871
|
-
* @param {*} [options] Override http request option.
|
|
872
|
-
* @throws {RequiredError}
|
|
873
|
-
* @memberof AccountInformationApiGenerated
|
|
874
|
-
*/
|
|
875
|
-
getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any, {}>>;
|
|
876
|
-
/**
|
|
877
|
-
* Returns the detail of a single order using the external order ID provided in the request body. This endpoint only works for single-leg orders at this time. Support for multi-leg orders will be added in the future. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
878
|
-
* @summary Get account order detail
|
|
879
|
-
* @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
|
|
880
|
-
* @param {*} [options] Override http request option.
|
|
881
|
-
* @throws {RequiredError}
|
|
882
|
-
* @memberof AccountInformationApiGenerated
|
|
883
|
-
*/
|
|
884
|
-
getUserAccountOrderDetail(requestParameters: AccountInformationApiGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
885
|
-
/**
|
|
886
|
-
* Returns a list of recent orders in the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
887
|
-
* @summary List account orders
|
|
888
|
-
* @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
|
|
889
|
-
* @param {*} [options] Override http request option.
|
|
890
|
-
* @throws {RequiredError}
|
|
891
|
-
* @memberof AccountInformationApiGenerated
|
|
892
|
-
*/
|
|
893
|
-
getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any, {}>>;
|
|
894
|
-
/**
|
|
895
|
-
* Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings). Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
896
|
-
* @summary List account positions
|
|
897
|
-
* @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
|
|
898
|
-
* @param {*} [options] Override http request option.
|
|
899
|
-
* @throws {RequiredError}
|
|
900
|
-
* @memberof AccountInformationApiGenerated
|
|
901
|
-
*/
|
|
902
|
-
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any, {}>>;
|
|
903
|
-
/**
|
|
904
|
-
* A lightweight endpoint that returns the latest page of orders placed in the last 24 hours in the specified account. For most brokerages, the default page size is 100 meaning the endpoint will return a max of 100 orders. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders Differs from /orders in that it is always realtime, and only checks the last 24 hours By default only returns executed orders, but that can be changed by setting *only_executed* to false
|
|
905
|
-
* @summary List account recent orders (last 24 hours only)
|
|
906
|
-
* @param {AccountInformationApiGetUserAccountRecentOrdersRequest} requestParameters Request parameters.
|
|
907
|
-
* @param {*} [options] Override http request option.
|
|
908
|
-
* @throws {RequiredError}
|
|
909
|
-
* @memberof AccountInformationApiGenerated
|
|
910
|
-
*/
|
|
911
|
-
getUserAccountRecentOrders(requestParameters: AccountInformationApiGetUserAccountRecentOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecentOrdersResponse, any, {}>>;
|
|
912
|
-
/**
|
|
913
|
-
* Returns a list of rate of return percents for a given account.
|
|
914
|
-
* @summary List account rate of returns
|
|
915
|
-
* @param {AccountInformationApiGetUserAccountReturnRatesRequest} requestParameters Request parameters.
|
|
916
|
-
* @param {*} [options] Override http request option.
|
|
917
|
-
* @throws {RequiredError}
|
|
918
|
-
* @memberof AccountInformationApiGenerated
|
|
919
|
-
*/
|
|
920
|
-
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
921
|
-
/**
|
|
922
|
-
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
923
|
-
* @summary List account holdings
|
|
924
|
-
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
925
|
-
* @param {*} [options] Override http request option.
|
|
926
|
-
* @deprecated
|
|
927
|
-
* @throws {RequiredError}
|
|
928
|
-
* @memberof AccountInformationApiGenerated
|
|
929
|
-
*/
|
|
930
|
-
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any, {}>>;
|
|
931
|
-
/**
|
|
932
|
-
* **Deprecated, please use the [list accounts for a connection endpoint](/reference/Connections/Connections_listBrokerageAuthorizationAccounts) instead.** Returns all brokerage accounts across all connections known to SnapTrade for the authenticated user. This endpoint returns Daily data regardless of the customer\'s plan. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage. To get real-time data on Pay as you Go / Real-time, use the connection-scoped endpoint linked above. Customers on Pay as you Go / Daily can force a refresh with the [manual refresh endpoint](/reference/Connections/Connections_refreshBrokerageAuthorization).
|
|
933
|
-
* @summary List accounts
|
|
934
|
-
* @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
|
|
935
|
-
* @param {*} [options] Override http request option.
|
|
936
|
-
* @deprecated
|
|
937
|
-
* @throws {RequiredError}
|
|
938
|
-
* @memberof AccountInformationApiGenerated
|
|
939
|
-
*/
|
|
940
|
-
listUserAccounts(requestParameters: AccountInformationApiListUserAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any, {}>>;
|
|
941
|
-
/**
|
|
942
|
-
* Updates various properties of a specified account.
|
|
943
|
-
* @summary Update details of an investment account
|
|
944
|
-
* @param {AccountInformationApiUpdateUserAccountRequest} requestParameters Request parameters.
|
|
945
|
-
* @param {*} [options] Override http request option.
|
|
946
|
-
* @throws {RequiredError}
|
|
947
|
-
* @memberof AccountInformationApiGenerated
|
|
948
|
-
*/
|
|
949
|
-
updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any, {}>>;
|
|
950
|
-
}
|