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,497 +0,0 @@
|
|
|
1
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
2
|
-
import { Configuration } from '../configuration';
|
|
3
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
4
|
-
import { Brokerage } from '../models';
|
|
5
|
-
import { BrokerageAuthorizationTypeReadOnly } from '../models';
|
|
6
|
-
import { BrokerageInstrumentsResponse } from '../models';
|
|
7
|
-
import { Currency } from '../models';
|
|
8
|
-
import { Exchange } from '../models';
|
|
9
|
-
import { ExchangeRatePairs } from '../models';
|
|
10
|
-
import { PartnerData } from '../models';
|
|
11
|
-
import { SecurityType } from '../models';
|
|
12
|
-
import { SymbolQuery } from '../models';
|
|
13
|
-
import { UniversalSymbol } from '../models';
|
|
14
|
-
/**
|
|
15
|
-
* ReferenceDataApi - axios parameter creator
|
|
16
|
-
* @export
|
|
17
|
-
*/
|
|
18
|
-
export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19
|
-
/**
|
|
20
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
21
|
-
* @summary Get exchange rate of a currency pair
|
|
22
|
-
* @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
|
|
23
|
-
* @param {*} [options] Override http request option.
|
|
24
|
-
* @throws {RequiredError}
|
|
25
|
-
*/
|
|
26
|
-
getCurrencyExchangeRatePair: (currencyPair: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
27
|
-
/**
|
|
28
|
-
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
29
|
-
* @summary Get Client Info
|
|
30
|
-
* @param {*} [options] Override http request option.
|
|
31
|
-
* @throws {RequiredError}
|
|
32
|
-
*/
|
|
33
|
-
getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
-
/**
|
|
35
|
-
* Return all available security types supported by SnapTrade.
|
|
36
|
-
* @summary List security types
|
|
37
|
-
* @param {*} [options] Override http request option.
|
|
38
|
-
* @throws {RequiredError}
|
|
39
|
-
*/
|
|
40
|
-
getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
-
/**
|
|
42
|
-
* Returns a list of all supported Exchanges.
|
|
43
|
-
* @summary Get exchanges
|
|
44
|
-
* @param {*} [options] Override http request option.
|
|
45
|
-
* @throws {RequiredError}
|
|
46
|
-
*/
|
|
47
|
-
getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
-
/**
|
|
49
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
|
|
50
|
-
* @summary Search symbols
|
|
51
|
-
* @param {SymbolQuery} [symbolQuery]
|
|
52
|
-
* @param {*} [options] Override http request option.
|
|
53
|
-
* @throws {RequiredError}
|
|
54
|
-
*/
|
|
55
|
-
getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
-
/**
|
|
57
|
-
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
|
|
58
|
-
* @summary Get symbol detail
|
|
59
|
-
* @param {string} query The ticker or Universal Symbol ID to look up the symbol with.
|
|
60
|
-
* @param {*} [options] Override http request option.
|
|
61
|
-
* @throws {RequiredError}
|
|
62
|
-
*/
|
|
63
|
-
getSymbolsByTicker: (query: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
-
/**
|
|
65
|
-
* Returns a list of all defined Brokerage authorization Type objects.
|
|
66
|
-
* @summary Get all brokerage authorization types
|
|
67
|
-
* @param {string} [brokerage] Comma separated value of brokerage slugs
|
|
68
|
-
* @param {*} [options] Override http request option.
|
|
69
|
-
* @throws {RequiredError}
|
|
70
|
-
*/
|
|
71
|
-
listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
-
/**
|
|
73
|
-
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
74
|
-
* @summary Get brokerage instruments
|
|
75
|
-
* @param {string} slug A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
|
76
|
-
* @param {*} [options] Override http request option.
|
|
77
|
-
* @throws {RequiredError}
|
|
78
|
-
*/
|
|
79
|
-
listAllBrokerageInstruments: (slug: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
-
/**
|
|
81
|
-
* Returns a list of all defined Brokerage objects.
|
|
82
|
-
* @summary Get brokerages
|
|
83
|
-
* @param {*} [options] Override http request option.
|
|
84
|
-
* @throws {RequiredError}
|
|
85
|
-
*/
|
|
86
|
-
listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
-
/**
|
|
88
|
-
* Returns a list of all defined Currency objects.
|
|
89
|
-
* @summary Get currencies
|
|
90
|
-
* @param {*} [options] Override http request option.
|
|
91
|
-
* @throws {RequiredError}
|
|
92
|
-
*/
|
|
93
|
-
listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
-
/**
|
|
95
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
96
|
-
* @summary Get currency exchange rates
|
|
97
|
-
* @param {*} [options] Override http request option.
|
|
98
|
-
* @throws {RequiredError}
|
|
99
|
-
*/
|
|
100
|
-
listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
|
-
/**
|
|
102
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
103
|
-
* @summary Search account symbols
|
|
104
|
-
* @param {string} userId
|
|
105
|
-
* @param {string} userSecret
|
|
106
|
-
* @param {string} accountId
|
|
107
|
-
* @param {SymbolQuery} [symbolQuery]
|
|
108
|
-
* @param {*} [options] Override http request option.
|
|
109
|
-
* @throws {RequiredError}
|
|
110
|
-
*/
|
|
111
|
-
symbolSearchUserAccount: (userId: string, userSecret: string, accountId: string, symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
112
|
-
};
|
|
113
|
-
/**
|
|
114
|
-
* ReferenceDataApi - functional programming interface
|
|
115
|
-
* @export
|
|
116
|
-
*/
|
|
117
|
-
export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
|
|
118
|
-
/**
|
|
119
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
120
|
-
* @summary Get exchange rate of a currency pair
|
|
121
|
-
* @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
|
|
122
|
-
* @param {*} [options] Override http request option.
|
|
123
|
-
* @throws {RequiredError}
|
|
124
|
-
*/
|
|
125
|
-
getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeRatePairs>>;
|
|
126
|
-
/**
|
|
127
|
-
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
128
|
-
* @summary Get Client Info
|
|
129
|
-
* @param {*} [options] Override http request option.
|
|
130
|
-
* @throws {RequiredError}
|
|
131
|
-
*/
|
|
132
|
-
getPartnerInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
|
|
133
|
-
/**
|
|
134
|
-
* Return all available security types supported by SnapTrade.
|
|
135
|
-
* @summary List security types
|
|
136
|
-
* @param {*} [options] Override http request option.
|
|
137
|
-
* @throws {RequiredError}
|
|
138
|
-
*/
|
|
139
|
-
getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
|
|
140
|
-
/**
|
|
141
|
-
* Returns a list of all supported Exchanges.
|
|
142
|
-
* @summary Get exchanges
|
|
143
|
-
* @param {*} [options] Override http request option.
|
|
144
|
-
* @throws {RequiredError}
|
|
145
|
-
*/
|
|
146
|
-
getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
|
|
147
|
-
/**
|
|
148
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
|
|
149
|
-
* @summary Search symbols
|
|
150
|
-
* @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
|
|
151
|
-
* @param {*} [options] Override http request option.
|
|
152
|
-
* @throws {RequiredError}
|
|
153
|
-
*/
|
|
154
|
-
getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
|
|
155
|
-
/**
|
|
156
|
-
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
|
|
157
|
-
* @summary Get symbol detail
|
|
158
|
-
* @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
|
|
159
|
-
* @param {*} [options] Override http request option.
|
|
160
|
-
* @throws {RequiredError}
|
|
161
|
-
*/
|
|
162
|
-
getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
|
|
163
|
-
/**
|
|
164
|
-
* Returns a list of all defined Brokerage authorization Type objects.
|
|
165
|
-
* @summary Get all brokerage authorization types
|
|
166
|
-
* @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
|
|
167
|
-
* @param {*} [options] Override http request option.
|
|
168
|
-
* @throws {RequiredError}
|
|
169
|
-
*/
|
|
170
|
-
listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
|
|
171
|
-
/**
|
|
172
|
-
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
173
|
-
* @summary Get brokerage instruments
|
|
174
|
-
* @param {ReferenceDataApiListAllBrokerageInstrumentsRequest} requestParameters Request parameters.
|
|
175
|
-
* @param {*} [options] Override http request option.
|
|
176
|
-
* @throws {RequiredError}
|
|
177
|
-
*/
|
|
178
|
-
listAllBrokerageInstruments(requestParameters: ReferenceDataApiListAllBrokerageInstrumentsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageInstrumentsResponse>>;
|
|
179
|
-
/**
|
|
180
|
-
* Returns a list of all defined Brokerage objects.
|
|
181
|
-
* @summary Get brokerages
|
|
182
|
-
* @param {*} [options] Override http request option.
|
|
183
|
-
* @throws {RequiredError}
|
|
184
|
-
*/
|
|
185
|
-
listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
|
|
186
|
-
/**
|
|
187
|
-
* Returns a list of all defined Currency objects.
|
|
188
|
-
* @summary Get currencies
|
|
189
|
-
* @param {*} [options] Override http request option.
|
|
190
|
-
* @throws {RequiredError}
|
|
191
|
-
*/
|
|
192
|
-
listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
|
|
193
|
-
/**
|
|
194
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
195
|
-
* @summary Get currency exchange rates
|
|
196
|
-
* @param {*} [options] Override http request option.
|
|
197
|
-
* @throws {RequiredError}
|
|
198
|
-
*/
|
|
199
|
-
listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
|
|
200
|
-
/**
|
|
201
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
202
|
-
* @summary Search account symbols
|
|
203
|
-
* @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
|
|
204
|
-
* @param {*} [options] Override http request option.
|
|
205
|
-
* @throws {RequiredError}
|
|
206
|
-
*/
|
|
207
|
-
symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
|
|
208
|
-
};
|
|
209
|
-
/**
|
|
210
|
-
* ReferenceDataApi - factory interface
|
|
211
|
-
* @export
|
|
212
|
-
*/
|
|
213
|
-
export declare const ReferenceDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
214
|
-
/**
|
|
215
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
216
|
-
* @summary Get exchange rate of a currency pair
|
|
217
|
-
* @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
|
|
218
|
-
* @param {*} [options] Override http request option.
|
|
219
|
-
* @throws {RequiredError}
|
|
220
|
-
*/
|
|
221
|
-
getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): AxiosPromise<ExchangeRatePairs>;
|
|
222
|
-
/**
|
|
223
|
-
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
224
|
-
* @summary Get Client Info
|
|
225
|
-
* @param {*} [options] Override http request option.
|
|
226
|
-
* @throws {RequiredError}
|
|
227
|
-
*/
|
|
228
|
-
getPartnerInfo(options?: AxiosRequestConfig): AxiosPromise<PartnerData>;
|
|
229
|
-
/**
|
|
230
|
-
* Return all available security types supported by SnapTrade.
|
|
231
|
-
* @summary List security types
|
|
232
|
-
* @param {*} [options] Override http request option.
|
|
233
|
-
* @throws {RequiredError}
|
|
234
|
-
*/
|
|
235
|
-
getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
|
|
236
|
-
/**
|
|
237
|
-
* Returns a list of all supported Exchanges.
|
|
238
|
-
* @summary Get exchanges
|
|
239
|
-
* @param {*} [options] Override http request option.
|
|
240
|
-
* @throws {RequiredError}
|
|
241
|
-
*/
|
|
242
|
-
getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
|
|
243
|
-
/**
|
|
244
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
|
|
245
|
-
* @summary Search symbols
|
|
246
|
-
* @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
|
|
247
|
-
* @param {*} [options] Override http request option.
|
|
248
|
-
* @throws {RequiredError}
|
|
249
|
-
*/
|
|
250
|
-
getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
|
|
251
|
-
/**
|
|
252
|
-
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
|
|
253
|
-
* @summary Get symbol detail
|
|
254
|
-
* @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
|
|
255
|
-
* @param {*} [options] Override http request option.
|
|
256
|
-
* @throws {RequiredError}
|
|
257
|
-
*/
|
|
258
|
-
getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): AxiosPromise<UniversalSymbol>;
|
|
259
|
-
/**
|
|
260
|
-
* Returns a list of all defined Brokerage authorization Type objects.
|
|
261
|
-
* @summary Get all brokerage authorization types
|
|
262
|
-
* @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
|
|
263
|
-
* @param {*} [options] Override http request option.
|
|
264
|
-
* @throws {RequiredError}
|
|
265
|
-
*/
|
|
266
|
-
listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
|
|
267
|
-
/**
|
|
268
|
-
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
269
|
-
* @summary Get brokerage instruments
|
|
270
|
-
* @param {ReferenceDataApiListAllBrokerageInstrumentsRequest} requestParameters Request parameters.
|
|
271
|
-
* @param {*} [options] Override http request option.
|
|
272
|
-
* @throws {RequiredError}
|
|
273
|
-
*/
|
|
274
|
-
listAllBrokerageInstruments(requestParameters: ReferenceDataApiListAllBrokerageInstrumentsRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageInstrumentsResponse>;
|
|
275
|
-
/**
|
|
276
|
-
* Returns a list of all defined Brokerage objects.
|
|
277
|
-
* @summary Get brokerages
|
|
278
|
-
* @param {*} [options] Override http request option.
|
|
279
|
-
* @throws {RequiredError}
|
|
280
|
-
*/
|
|
281
|
-
listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
|
|
282
|
-
/**
|
|
283
|
-
* Returns a list of all defined Currency objects.
|
|
284
|
-
* @summary Get currencies
|
|
285
|
-
* @param {*} [options] Override http request option.
|
|
286
|
-
* @throws {RequiredError}
|
|
287
|
-
*/
|
|
288
|
-
listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
|
|
289
|
-
/**
|
|
290
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
291
|
-
* @summary Get currency exchange rates
|
|
292
|
-
* @param {*} [options] Override http request option.
|
|
293
|
-
* @throws {RequiredError}
|
|
294
|
-
*/
|
|
295
|
-
listAllCurrenciesRates(options?: AxiosRequestConfig): AxiosPromise<Array<ExchangeRatePairs>>;
|
|
296
|
-
/**
|
|
297
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
298
|
-
* @summary Search account symbols
|
|
299
|
-
* @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
|
|
300
|
-
* @param {*} [options] Override http request option.
|
|
301
|
-
* @throws {RequiredError}
|
|
302
|
-
*/
|
|
303
|
-
symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
|
|
304
|
-
};
|
|
305
|
-
/**
|
|
306
|
-
* Request parameters for getCurrencyExchangeRatePair operation in ReferenceDataApi.
|
|
307
|
-
* @export
|
|
308
|
-
* @interface ReferenceDataApiGetCurrencyExchangeRatePairRequest
|
|
309
|
-
*/
|
|
310
|
-
export type ReferenceDataApiGetCurrencyExchangeRatePairRequest = {
|
|
311
|
-
/**
|
|
312
|
-
* A currency pair based on currency code for example, {CAD-USD}
|
|
313
|
-
* @type {string}
|
|
314
|
-
* @memberof ReferenceDataApiGetCurrencyExchangeRatePair
|
|
315
|
-
*/
|
|
316
|
-
readonly currencyPair: string;
|
|
317
|
-
};
|
|
318
|
-
/**
|
|
319
|
-
* Request parameters for getSymbols operation in ReferenceDataApi.
|
|
320
|
-
* @export
|
|
321
|
-
* @interface ReferenceDataApiGetSymbolsRequest
|
|
322
|
-
*/
|
|
323
|
-
export type ReferenceDataApiGetSymbolsRequest = {} & SymbolQuery;
|
|
324
|
-
/**
|
|
325
|
-
* Request parameters for getSymbolsByTicker operation in ReferenceDataApi.
|
|
326
|
-
* @export
|
|
327
|
-
* @interface ReferenceDataApiGetSymbolsByTickerRequest
|
|
328
|
-
*/
|
|
329
|
-
export type ReferenceDataApiGetSymbolsByTickerRequest = {
|
|
330
|
-
/**
|
|
331
|
-
* The ticker or Universal Symbol ID to look up the symbol with.
|
|
332
|
-
* @type {string}
|
|
333
|
-
* @memberof ReferenceDataApiGetSymbolsByTicker
|
|
334
|
-
*/
|
|
335
|
-
readonly query: string;
|
|
336
|
-
};
|
|
337
|
-
/**
|
|
338
|
-
* Request parameters for listAllBrokerageAuthorizationType operation in ReferenceDataApi.
|
|
339
|
-
* @export
|
|
340
|
-
* @interface ReferenceDataApiListAllBrokerageAuthorizationTypeRequest
|
|
341
|
-
*/
|
|
342
|
-
export type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest = {
|
|
343
|
-
/**
|
|
344
|
-
* Comma separated value of brokerage slugs
|
|
345
|
-
* @type {string}
|
|
346
|
-
* @memberof ReferenceDataApiListAllBrokerageAuthorizationType
|
|
347
|
-
*/
|
|
348
|
-
readonly brokerage?: string;
|
|
349
|
-
};
|
|
350
|
-
/**
|
|
351
|
-
* Request parameters for listAllBrokerageInstruments operation in ReferenceDataApi.
|
|
352
|
-
* @export
|
|
353
|
-
* @interface ReferenceDataApiListAllBrokerageInstrumentsRequest
|
|
354
|
-
*/
|
|
355
|
-
export type ReferenceDataApiListAllBrokerageInstrumentsRequest = {
|
|
356
|
-
/**
|
|
357
|
-
* A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
|
|
358
|
-
* @type {string}
|
|
359
|
-
* @memberof ReferenceDataApiListAllBrokerageInstruments
|
|
360
|
-
*/
|
|
361
|
-
readonly slug: string;
|
|
362
|
-
};
|
|
363
|
-
/**
|
|
364
|
-
* Request parameters for symbolSearchUserAccount operation in ReferenceDataApi.
|
|
365
|
-
* @export
|
|
366
|
-
* @interface ReferenceDataApiSymbolSearchUserAccountRequest
|
|
367
|
-
*/
|
|
368
|
-
export type ReferenceDataApiSymbolSearchUserAccountRequest = {
|
|
369
|
-
/**
|
|
370
|
-
*
|
|
371
|
-
* @type {string}
|
|
372
|
-
* @memberof ReferenceDataApiSymbolSearchUserAccount
|
|
373
|
-
*/
|
|
374
|
-
readonly userId: string;
|
|
375
|
-
/**
|
|
376
|
-
*
|
|
377
|
-
* @type {string}
|
|
378
|
-
* @memberof ReferenceDataApiSymbolSearchUserAccount
|
|
379
|
-
*/
|
|
380
|
-
readonly userSecret: string;
|
|
381
|
-
/**
|
|
382
|
-
*
|
|
383
|
-
* @type {string}
|
|
384
|
-
* @memberof ReferenceDataApiSymbolSearchUserAccount
|
|
385
|
-
*/
|
|
386
|
-
readonly accountId: string;
|
|
387
|
-
} & SymbolQuery;
|
|
388
|
-
/**
|
|
389
|
-
* ReferenceDataApiGenerated - object-oriented interface
|
|
390
|
-
* @export
|
|
391
|
-
* @class ReferenceDataApiGenerated
|
|
392
|
-
* @extends {BaseAPI}
|
|
393
|
-
*/
|
|
394
|
-
export declare class ReferenceDataApiGenerated extends BaseAPI {
|
|
395
|
-
/**
|
|
396
|
-
* Returns an Exchange Rate Pair object for the specified Currency Pair.
|
|
397
|
-
* @summary Get exchange rate of a currency pair
|
|
398
|
-
* @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
|
|
399
|
-
* @param {*} [options] Override http request option.
|
|
400
|
-
* @throws {RequiredError}
|
|
401
|
-
* @memberof ReferenceDataApiGenerated
|
|
402
|
-
*/
|
|
403
|
-
getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs, any, {}>>;
|
|
404
|
-
/**
|
|
405
|
-
* Returns configurations for your SnapTrade Client ID, including allowed brokerages and data access.
|
|
406
|
-
* @summary Get Client Info
|
|
407
|
-
* @param {*} [options] Override http request option.
|
|
408
|
-
* @throws {RequiredError}
|
|
409
|
-
* @memberof ReferenceDataApiGenerated
|
|
410
|
-
*/
|
|
411
|
-
getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any, {}>>;
|
|
412
|
-
/**
|
|
413
|
-
* Return all available security types supported by SnapTrade.
|
|
414
|
-
* @summary List security types
|
|
415
|
-
* @param {*} [options] Override http request option.
|
|
416
|
-
* @throws {RequiredError}
|
|
417
|
-
* @memberof ReferenceDataApiGenerated
|
|
418
|
-
*/
|
|
419
|
-
getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any, {}>>;
|
|
420
|
-
/**
|
|
421
|
-
* Returns a list of all supported Exchanges.
|
|
422
|
-
* @summary Get exchanges
|
|
423
|
-
* @param {*} [options] Override http request option.
|
|
424
|
-
* @throws {RequiredError}
|
|
425
|
-
* @memberof ReferenceDataApiGenerated
|
|
426
|
-
*/
|
|
427
|
-
getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any, {}>>;
|
|
428
|
-
/**
|
|
429
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned.
|
|
430
|
-
* @summary Search symbols
|
|
431
|
-
* @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
|
|
432
|
-
* @param {*} [options] Override http request option.
|
|
433
|
-
* @throws {RequiredError}
|
|
434
|
-
* @memberof ReferenceDataApiGenerated
|
|
435
|
-
*/
|
|
436
|
-
getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any, {}>>;
|
|
437
|
-
/**
|
|
438
|
-
* Returns the Universal Symbol object specified by the ticker or the Universal Symbol ID. When a ticker is specified, the first matching result is returned. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix. Please use the ticker with the proper suffix for the best results.
|
|
439
|
-
* @summary Get symbol detail
|
|
440
|
-
* @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
|
|
441
|
-
* @param {*} [options] Override http request option.
|
|
442
|
-
* @throws {RequiredError}
|
|
443
|
-
* @memberof ReferenceDataApiGenerated
|
|
444
|
-
*/
|
|
445
|
-
getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any, {}>>;
|
|
446
|
-
/**
|
|
447
|
-
* Returns a list of all defined Brokerage authorization Type objects.
|
|
448
|
-
* @summary Get all brokerage authorization types
|
|
449
|
-
* @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
|
|
450
|
-
* @param {*} [options] Override http request option.
|
|
451
|
-
* @throws {RequiredError}
|
|
452
|
-
* @memberof ReferenceDataApiGenerated
|
|
453
|
-
*/
|
|
454
|
-
listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any, {}>>;
|
|
455
|
-
/**
|
|
456
|
-
* Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
|
|
457
|
-
* @summary Get brokerage instruments
|
|
458
|
-
* @param {ReferenceDataApiListAllBrokerageInstrumentsRequest} requestParameters Request parameters.
|
|
459
|
-
* @param {*} [options] Override http request option.
|
|
460
|
-
* @throws {RequiredError}
|
|
461
|
-
* @memberof ReferenceDataApiGenerated
|
|
462
|
-
*/
|
|
463
|
-
listAllBrokerageInstruments(requestParameters: ReferenceDataApiListAllBrokerageInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageInstrumentsResponse, any, {}>>;
|
|
464
|
-
/**
|
|
465
|
-
* Returns a list of all defined Brokerage objects.
|
|
466
|
-
* @summary Get brokerages
|
|
467
|
-
* @param {*} [options] Override http request option.
|
|
468
|
-
* @throws {RequiredError}
|
|
469
|
-
* @memberof ReferenceDataApiGenerated
|
|
470
|
-
*/
|
|
471
|
-
listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any, {}>>;
|
|
472
|
-
/**
|
|
473
|
-
* Returns a list of all defined Currency objects.
|
|
474
|
-
* @summary Get currencies
|
|
475
|
-
* @param {*} [options] Override http request option.
|
|
476
|
-
* @throws {RequiredError}
|
|
477
|
-
* @memberof ReferenceDataApiGenerated
|
|
478
|
-
*/
|
|
479
|
-
listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any, {}>>;
|
|
480
|
-
/**
|
|
481
|
-
* Returns a list of all Exchange Rate Pairs for all supported Currencies.
|
|
482
|
-
* @summary Get currency exchange rates
|
|
483
|
-
* @param {*} [options] Override http request option.
|
|
484
|
-
* @throws {RequiredError}
|
|
485
|
-
* @memberof ReferenceDataApiGenerated
|
|
486
|
-
*/
|
|
487
|
-
listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any, {}>>;
|
|
488
|
-
/**
|
|
489
|
-
* Returns a list of Universal Symbol objects that match the given query. The matching takes into consideration both the ticker and the name of the symbol. Only the first 20 results are returned. The search results are further limited to the symbols supported by the brokerage for which the account is under.
|
|
490
|
-
* @summary Search account symbols
|
|
491
|
-
* @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
|
|
492
|
-
* @param {*} [options] Override http request option.
|
|
493
|
-
* @throws {RequiredError}
|
|
494
|
-
* @memberof ReferenceDataApiGenerated
|
|
495
|
-
*/
|
|
496
|
-
symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any, {}>>;
|
|
497
|
-
}
|