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,1058 +0,0 @@
|
|
|
1
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
2
|
-
import { Configuration } from '../configuration';
|
|
3
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
4
|
-
import { AccountInformationGetUserAccountOrderDetailRequest } from '../models';
|
|
5
|
-
import { AccountOrderRecord } from '../models';
|
|
6
|
-
import { CancelOrderResponse } from '../models';
|
|
7
|
-
import { ComplexOrderResponse } from '../models';
|
|
8
|
-
import { CryptoOrderForm } from '../models';
|
|
9
|
-
import { CryptoOrderPreview } from '../models';
|
|
10
|
-
import { CryptocurrencyPairQuote } from '../models';
|
|
11
|
-
import { ManualTradeAndImpact } from '../models';
|
|
12
|
-
import { ManualTradeForm } from '../models';
|
|
13
|
-
import { ManualTradeFormBracket } from '../models';
|
|
14
|
-
import { ManualTradeFormComplex } from '../models';
|
|
15
|
-
import { ManualTradeFormWithOptions } from '../models';
|
|
16
|
-
import { ManualTradeReplaceForm } from '../models';
|
|
17
|
-
import { MlegOrderResponse } from '../models';
|
|
18
|
-
import { MlegTradeForm } from '../models';
|
|
19
|
-
import { OptionImpact } from '../models';
|
|
20
|
-
import { OptionQuote } from '../models';
|
|
21
|
-
import { OrderUpdatedResponse } from '../models';
|
|
22
|
-
import { SymbolsQuotesInner } from '../models';
|
|
23
|
-
import { TradingSearchCryptocurrencyPairInstruments200Response } from '../models';
|
|
24
|
-
import { ValidatedTradeBody } from '../models';
|
|
25
|
-
/**
|
|
26
|
-
* TradingApi - axios parameter creator
|
|
27
|
-
* @export
|
|
28
|
-
*/
|
|
29
|
-
export declare const TradingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
|
-
/**
|
|
31
|
-
* Cancels an order in the specified account. Accepts order IDs for all asset types.
|
|
32
|
-
* @summary Cancel order
|
|
33
|
-
* @param {string} userId
|
|
34
|
-
* @param {string} userSecret
|
|
35
|
-
* @param {string} accountId
|
|
36
|
-
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
37
|
-
* @param {*} [options] Override http request option.
|
|
38
|
-
* @throws {RequiredError}
|
|
39
|
-
*/
|
|
40
|
-
cancelOrder: (userId: string, userSecret: string, accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
-
/**
|
|
42
|
-
* **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
43
|
-
* @summary Cancel equity order
|
|
44
|
-
* @param {string} userId
|
|
45
|
-
* @param {string} userSecret
|
|
46
|
-
* @param {string} accountId
|
|
47
|
-
* @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
|
|
48
|
-
* @param {*} [options] Override http request option.
|
|
49
|
-
* @deprecated
|
|
50
|
-
* @throws {RequiredError}
|
|
51
|
-
*/
|
|
52
|
-
cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
|
-
/**
|
|
54
|
-
* Gets a quote for the specified account.
|
|
55
|
-
* @summary Get crypto pair quote
|
|
56
|
-
* @param {string} userId
|
|
57
|
-
* @param {string} userSecret
|
|
58
|
-
* @param {string} accountId
|
|
59
|
-
* @param {string} instrumentSymbol
|
|
60
|
-
* @param {*} [options] Override http request option.
|
|
61
|
-
* @throws {RequiredError}
|
|
62
|
-
*/
|
|
63
|
-
getCryptocurrencyPairQuote: (userId: string, userSecret: string, accountId: string, instrumentSymbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
-
/**
|
|
65
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
66
|
-
* @summary Get option order impact
|
|
67
|
-
* @param {string} userId
|
|
68
|
-
* @param {string} userSecret
|
|
69
|
-
* @param {string} accountId
|
|
70
|
-
* @param {MlegTradeForm} mlegTradeForm
|
|
71
|
-
* @param {*} [options] Override http request option.
|
|
72
|
-
* @throws {RequiredError}
|
|
73
|
-
*/
|
|
74
|
-
getOptionImpact: (userId: string, userSecret: string, accountId: string, mlegTradeForm: MlegTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
|
-
/**
|
|
76
|
-
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
77
|
-
* @summary Check equity order impact
|
|
78
|
-
* @param {string} userId
|
|
79
|
-
* @param {string} userSecret
|
|
80
|
-
* @param {ManualTradeForm} manualTradeForm
|
|
81
|
-
* @param {*} [options] Override http request option.
|
|
82
|
-
* @throws {RequiredError}
|
|
83
|
-
*/
|
|
84
|
-
getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
|
-
/**
|
|
86
|
-
* Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
87
|
-
* @summary Get option quote
|
|
88
|
-
* @param {string} userId
|
|
89
|
-
* @param {string} userSecret
|
|
90
|
-
* @param {string} accountId
|
|
91
|
-
* @param {string} symbol The OCC-formatted option symbol.
|
|
92
|
-
* @param {*} [options] Override http request option.
|
|
93
|
-
* @throws {RequiredError}
|
|
94
|
-
*/
|
|
95
|
-
getUserAccountOptionQuotes: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
|
-
/**
|
|
97
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
98
|
-
* @summary Get equity symbol quotes
|
|
99
|
-
* @param {string} userId
|
|
100
|
-
* @param {string} userSecret
|
|
101
|
-
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
102
|
-
* @param {string} accountId
|
|
103
|
-
* @param {boolean} [useTicker] Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
|
|
104
|
-
* @param {*} [options] Override http request option.
|
|
105
|
-
* @throws {RequiredError}
|
|
106
|
-
*/
|
|
107
|
-
getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
108
|
-
/**
|
|
109
|
-
* **This endpoint is deprecated. Please switch to [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) ** Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
110
|
-
* @summary Place bracket order
|
|
111
|
-
* @param {string} accountId The ID of the account to execute the trade on.
|
|
112
|
-
* @param {string} userId
|
|
113
|
-
* @param {string} userSecret
|
|
114
|
-
* @param {ManualTradeFormBracket} manualTradeFormBracket
|
|
115
|
-
* @param {*} [options] Override http request option.
|
|
116
|
-
* @deprecated
|
|
117
|
-
* @throws {RequiredError}
|
|
118
|
-
*/
|
|
119
|
-
placeBracketOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormBracket: ManualTradeFormBracket, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
120
|
-
/**
|
|
121
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
122
|
-
* @summary Place complex order
|
|
123
|
-
* @param {string} accountId The ID of the account to execute the trade on.
|
|
124
|
-
* @param {string} userId
|
|
125
|
-
* @param {string} userSecret
|
|
126
|
-
* @param {ManualTradeFormComplex} manualTradeFormComplex
|
|
127
|
-
* @param {*} [options] Override http request option.
|
|
128
|
-
* @throws {RequiredError}
|
|
129
|
-
*/
|
|
130
|
-
placeComplexOrder: (accountId: string, userId: string, userSecret: string, manualTradeFormComplex: ManualTradeFormComplex, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
|
-
/**
|
|
132
|
-
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
133
|
-
* @summary Place crypto order
|
|
134
|
-
* @param {string} userId
|
|
135
|
-
* @param {string} userSecret
|
|
136
|
-
* @param {string} accountId
|
|
137
|
-
* @param {CryptoOrderForm} cryptoOrderForm
|
|
138
|
-
* @param {*} [options] Override http request option.
|
|
139
|
-
* @throws {RequiredError}
|
|
140
|
-
*/
|
|
141
|
-
placeCryptoOrder: (userId: string, userSecret: string, accountId: string, cryptoOrderForm: CryptoOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
|
-
/**
|
|
143
|
-
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
144
|
-
* @summary Place equity order
|
|
145
|
-
* @param {string} userId
|
|
146
|
-
* @param {string} userSecret
|
|
147
|
-
* @param {ManualTradeFormWithOptions} manualTradeFormWithOptions
|
|
148
|
-
* @param {*} [options] Override http request option.
|
|
149
|
-
* @throws {RequiredError}
|
|
150
|
-
*/
|
|
151
|
-
placeForceOrder: (userId: string, userSecret: string, manualTradeFormWithOptions: ManualTradeFormWithOptions, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
152
|
-
/**
|
|
153
|
-
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
154
|
-
* @summary Place option order
|
|
155
|
-
* @param {string} userId
|
|
156
|
-
* @param {string} userSecret
|
|
157
|
-
* @param {string} accountId
|
|
158
|
-
* @param {MlegTradeForm} mlegTradeForm
|
|
159
|
-
* @param {*} [options] Override http request option.
|
|
160
|
-
* @throws {RequiredError}
|
|
161
|
-
*/
|
|
162
|
-
placeMlegOrder: (userId: string, userSecret: string, accountId: string, mlegTradeForm: MlegTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
163
|
-
/**
|
|
164
|
-
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
165
|
-
* @summary Place checked equity order
|
|
166
|
-
* @param {string} tradeId Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
|
|
167
|
-
* @param {string} userId
|
|
168
|
-
* @param {string} userSecret
|
|
169
|
-
* @param {ValidatedTradeBody} [validatedTradeBody]
|
|
170
|
-
* @param {*} [options] Override http request option.
|
|
171
|
-
* @throws {RequiredError}
|
|
172
|
-
*/
|
|
173
|
-
placeOrder: (tradeId: string, userId: string, userSecret: string, validatedTradeBody?: ValidatedTradeBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
174
|
-
/**
|
|
175
|
-
* Previews an order using the specified account.
|
|
176
|
-
* @summary Preview crypto order
|
|
177
|
-
* @param {string} userId
|
|
178
|
-
* @param {string} userSecret
|
|
179
|
-
* @param {string} accountId
|
|
180
|
-
* @param {CryptoOrderForm} cryptoOrderForm
|
|
181
|
-
* @param {*} [options] Override http request option.
|
|
182
|
-
* @throws {RequiredError}
|
|
183
|
-
*/
|
|
184
|
-
previewCryptoOrder: (userId: string, userSecret: string, accountId: string, cryptoOrderForm: CryptoOrderForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
185
|
-
/**
|
|
186
|
-
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
187
|
-
* @summary Replace order
|
|
188
|
-
* @param {string} accountId The ID of the account to execute the trade on.
|
|
189
|
-
* @param {string} userId
|
|
190
|
-
* @param {string} userSecret
|
|
191
|
-
* @param {ManualTradeReplaceForm} manualTradeReplaceForm
|
|
192
|
-
* @param {*} [options] Override http request option.
|
|
193
|
-
* @throws {RequiredError}
|
|
194
|
-
*/
|
|
195
|
-
replaceOrder: (accountId: string, userId: string, userSecret: string, manualTradeReplaceForm: ManualTradeReplaceForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
196
|
-
/**
|
|
197
|
-
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
198
|
-
* @summary Get crypto pairs
|
|
199
|
-
* @param {string} userId
|
|
200
|
-
* @param {string} userSecret
|
|
201
|
-
* @param {string} accountId
|
|
202
|
-
* @param {string} [base]
|
|
203
|
-
* @param {string} [quote]
|
|
204
|
-
* @param {*} [options] Override http request option.
|
|
205
|
-
* @throws {RequiredError}
|
|
206
|
-
*/
|
|
207
|
-
searchCryptocurrencyPairInstruments: (userId: string, userSecret: string, accountId: string, base?: string, quote?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
208
|
-
};
|
|
209
|
-
/**
|
|
210
|
-
* TradingApi - functional programming interface
|
|
211
|
-
* @export
|
|
212
|
-
*/
|
|
213
|
-
export declare const TradingApiFp: (configuration?: Configuration) => {
|
|
214
|
-
/**
|
|
215
|
-
* Cancels an order in the specified account. Accepts order IDs for all asset types.
|
|
216
|
-
* @summary Cancel order
|
|
217
|
-
* @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
|
|
218
|
-
* @param {*} [options] Override http request option.
|
|
219
|
-
* @throws {RequiredError}
|
|
220
|
-
*/
|
|
221
|
-
cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelOrderResponse>>;
|
|
222
|
-
/**
|
|
223
|
-
* **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
224
|
-
* @summary Cancel equity order
|
|
225
|
-
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
226
|
-
* @param {*} [options] Override http request option.
|
|
227
|
-
* @deprecated
|
|
228
|
-
* @throws {RequiredError}
|
|
229
|
-
*/
|
|
230
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
231
|
-
/**
|
|
232
|
-
* Gets a quote for the specified account.
|
|
233
|
-
* @summary Get crypto pair quote
|
|
234
|
-
* @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
|
|
235
|
-
* @param {*} [options] Override http request option.
|
|
236
|
-
* @throws {RequiredError}
|
|
237
|
-
*/
|
|
238
|
-
getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptocurrencyPairQuote>>;
|
|
239
|
-
/**
|
|
240
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
241
|
-
* @summary Get option order impact
|
|
242
|
-
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
243
|
-
* @param {*} [options] Override http request option.
|
|
244
|
-
* @throws {RequiredError}
|
|
245
|
-
*/
|
|
246
|
-
getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionImpact>>;
|
|
247
|
-
/**
|
|
248
|
-
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
249
|
-
* @summary Check equity order impact
|
|
250
|
-
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
251
|
-
* @param {*} [options] Override http request option.
|
|
252
|
-
* @throws {RequiredError}
|
|
253
|
-
*/
|
|
254
|
-
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
255
|
-
/**
|
|
256
|
-
* Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
257
|
-
* @summary Get option quote
|
|
258
|
-
* @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
|
|
259
|
-
* @param {*} [options] Override http request option.
|
|
260
|
-
* @throws {RequiredError}
|
|
261
|
-
*/
|
|
262
|
-
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
263
|
-
/**
|
|
264
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
265
|
-
* @summary Get equity symbol quotes
|
|
266
|
-
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
267
|
-
* @param {*} [options] Override http request option.
|
|
268
|
-
* @throws {RequiredError}
|
|
269
|
-
*/
|
|
270
|
-
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
|
|
271
|
-
/**
|
|
272
|
-
* **This endpoint is deprecated. Please switch to [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) ** Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
273
|
-
* @summary Place bracket order
|
|
274
|
-
* @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
|
|
275
|
-
* @param {*} [options] Override http request option.
|
|
276
|
-
* @deprecated
|
|
277
|
-
* @throws {RequiredError}
|
|
278
|
-
*/
|
|
279
|
-
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
280
|
-
/**
|
|
281
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
282
|
-
* @summary Place complex order
|
|
283
|
-
* @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
|
|
284
|
-
* @param {*} [options] Override http request option.
|
|
285
|
-
* @throws {RequiredError}
|
|
286
|
-
*/
|
|
287
|
-
placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ComplexOrderResponse>>;
|
|
288
|
-
/**
|
|
289
|
-
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
290
|
-
* @summary Place crypto order
|
|
291
|
-
* @param {TradingApiPlaceCryptoOrderRequest} requestParameters Request parameters.
|
|
292
|
-
* @param {*} [options] Override http request option.
|
|
293
|
-
* @throws {RequiredError}
|
|
294
|
-
*/
|
|
295
|
-
placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderUpdatedResponse>>;
|
|
296
|
-
/**
|
|
297
|
-
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
298
|
-
* @summary Place equity order
|
|
299
|
-
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
300
|
-
* @param {*} [options] Override http request option.
|
|
301
|
-
* @throws {RequiredError}
|
|
302
|
-
*/
|
|
303
|
-
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
304
|
-
/**
|
|
305
|
-
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
306
|
-
* @summary Place option order
|
|
307
|
-
* @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
|
|
308
|
-
* @param {*} [options] Override http request option.
|
|
309
|
-
* @throws {RequiredError}
|
|
310
|
-
*/
|
|
311
|
-
placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MlegOrderResponse>>;
|
|
312
|
-
/**
|
|
313
|
-
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
314
|
-
* @summary Place checked equity order
|
|
315
|
-
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
316
|
-
* @param {*} [options] Override http request option.
|
|
317
|
-
* @throws {RequiredError}
|
|
318
|
-
*/
|
|
319
|
-
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
320
|
-
/**
|
|
321
|
-
* Previews an order using the specified account.
|
|
322
|
-
* @summary Preview crypto order
|
|
323
|
-
* @param {TradingApiPreviewCryptoOrderRequest} requestParameters Request parameters.
|
|
324
|
-
* @param {*} [options] Override http request option.
|
|
325
|
-
* @throws {RequiredError}
|
|
326
|
-
*/
|
|
327
|
-
previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptoOrderPreview>>;
|
|
328
|
-
/**
|
|
329
|
-
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
330
|
-
* @summary Replace order
|
|
331
|
-
* @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
|
|
332
|
-
* @param {*} [options] Override http request option.
|
|
333
|
-
* @throws {RequiredError}
|
|
334
|
-
*/
|
|
335
|
-
replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
336
|
-
/**
|
|
337
|
-
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
338
|
-
* @summary Get crypto pairs
|
|
339
|
-
* @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
|
|
340
|
-
* @param {*} [options] Override http request option.
|
|
341
|
-
* @throws {RequiredError}
|
|
342
|
-
*/
|
|
343
|
-
searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TradingSearchCryptocurrencyPairInstruments200Response>>;
|
|
344
|
-
};
|
|
345
|
-
/**
|
|
346
|
-
* TradingApi - factory interface
|
|
347
|
-
* @export
|
|
348
|
-
*/
|
|
349
|
-
export declare const TradingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
350
|
-
/**
|
|
351
|
-
* Cancels an order in the specified account. Accepts order IDs for all asset types.
|
|
352
|
-
* @summary Cancel order
|
|
353
|
-
* @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
|
|
354
|
-
* @param {*} [options] Override http request option.
|
|
355
|
-
* @throws {RequiredError}
|
|
356
|
-
*/
|
|
357
|
-
cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): AxiosPromise<CancelOrderResponse>;
|
|
358
|
-
/**
|
|
359
|
-
* **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
360
|
-
* @summary Cancel equity order
|
|
361
|
-
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
362
|
-
* @param {*} [options] Override http request option.
|
|
363
|
-
* @deprecated
|
|
364
|
-
* @throws {RequiredError}
|
|
365
|
-
*/
|
|
366
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
367
|
-
/**
|
|
368
|
-
* Gets a quote for the specified account.
|
|
369
|
-
* @summary Get crypto pair quote
|
|
370
|
-
* @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
|
|
371
|
-
* @param {*} [options] Override http request option.
|
|
372
|
-
* @throws {RequiredError}
|
|
373
|
-
*/
|
|
374
|
-
getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<CryptocurrencyPairQuote>;
|
|
375
|
-
/**
|
|
376
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
377
|
-
* @summary Get option order impact
|
|
378
|
-
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
379
|
-
* @param {*} [options] Override http request option.
|
|
380
|
-
* @throws {RequiredError}
|
|
381
|
-
*/
|
|
382
|
-
getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): AxiosPromise<OptionImpact>;
|
|
383
|
-
/**
|
|
384
|
-
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
385
|
-
* @summary Check equity order impact
|
|
386
|
-
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
387
|
-
* @param {*} [options] Override http request option.
|
|
388
|
-
* @throws {RequiredError}
|
|
389
|
-
*/
|
|
390
|
-
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
|
|
391
|
-
/**
|
|
392
|
-
* Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
393
|
-
* @summary Get option quote
|
|
394
|
-
* @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
|
|
395
|
-
* @param {*} [options] Override http request option.
|
|
396
|
-
* @throws {RequiredError}
|
|
397
|
-
*/
|
|
398
|
-
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
|
|
399
|
-
/**
|
|
400
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
401
|
-
* @summary Get equity symbol quotes
|
|
402
|
-
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
403
|
-
* @param {*} [options] Override http request option.
|
|
404
|
-
* @throws {RequiredError}
|
|
405
|
-
*/
|
|
406
|
-
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
|
|
407
|
-
/**
|
|
408
|
-
* **This endpoint is deprecated. Please switch to [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) ** Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
409
|
-
* @summary Place bracket order
|
|
410
|
-
* @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
|
|
411
|
-
* @param {*} [options] Override http request option.
|
|
412
|
-
* @deprecated
|
|
413
|
-
* @throws {RequiredError}
|
|
414
|
-
*/
|
|
415
|
-
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
416
|
-
/**
|
|
417
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
418
|
-
* @summary Place complex order
|
|
419
|
-
* @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
|
|
420
|
-
* @param {*} [options] Override http request option.
|
|
421
|
-
* @throws {RequiredError}
|
|
422
|
-
*/
|
|
423
|
-
placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): AxiosPromise<ComplexOrderResponse>;
|
|
424
|
-
/**
|
|
425
|
-
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
426
|
-
* @summary Place crypto order
|
|
427
|
-
* @param {TradingApiPlaceCryptoOrderRequest} requestParameters Request parameters.
|
|
428
|
-
* @param {*} [options] Override http request option.
|
|
429
|
-
* @throws {RequiredError}
|
|
430
|
-
*/
|
|
431
|
-
placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): AxiosPromise<OrderUpdatedResponse>;
|
|
432
|
-
/**
|
|
433
|
-
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
434
|
-
* @summary Place equity order
|
|
435
|
-
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
436
|
-
* @param {*} [options] Override http request option.
|
|
437
|
-
* @throws {RequiredError}
|
|
438
|
-
*/
|
|
439
|
-
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
440
|
-
/**
|
|
441
|
-
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
442
|
-
* @summary Place option order
|
|
443
|
-
* @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
|
|
444
|
-
* @param {*} [options] Override http request option.
|
|
445
|
-
* @throws {RequiredError}
|
|
446
|
-
*/
|
|
447
|
-
placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): AxiosPromise<MlegOrderResponse>;
|
|
448
|
-
/**
|
|
449
|
-
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
450
|
-
* @summary Place checked equity order
|
|
451
|
-
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
452
|
-
* @param {*} [options] Override http request option.
|
|
453
|
-
* @throws {RequiredError}
|
|
454
|
-
*/
|
|
455
|
-
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
456
|
-
/**
|
|
457
|
-
* Previews an order using the specified account.
|
|
458
|
-
* @summary Preview crypto order
|
|
459
|
-
* @param {TradingApiPreviewCryptoOrderRequest} requestParameters Request parameters.
|
|
460
|
-
* @param {*} [options] Override http request option.
|
|
461
|
-
* @throws {RequiredError}
|
|
462
|
-
*/
|
|
463
|
-
previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): AxiosPromise<CryptoOrderPreview>;
|
|
464
|
-
/**
|
|
465
|
-
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
466
|
-
* @summary Replace order
|
|
467
|
-
* @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
|
|
468
|
-
* @param {*} [options] Override http request option.
|
|
469
|
-
* @throws {RequiredError}
|
|
470
|
-
*/
|
|
471
|
-
replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
472
|
-
/**
|
|
473
|
-
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
474
|
-
* @summary Get crypto pairs
|
|
475
|
-
* @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
|
|
476
|
-
* @param {*} [options] Override http request option.
|
|
477
|
-
* @throws {RequiredError}
|
|
478
|
-
*/
|
|
479
|
-
searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): AxiosPromise<TradingSearchCryptocurrencyPairInstruments200Response>;
|
|
480
|
-
};
|
|
481
|
-
/**
|
|
482
|
-
* Request parameters for cancelOrder operation in TradingApi.
|
|
483
|
-
* @export
|
|
484
|
-
* @interface TradingApiCancelOrderRequest
|
|
485
|
-
*/
|
|
486
|
-
export type TradingApiCancelOrderRequest = {
|
|
487
|
-
/**
|
|
488
|
-
*
|
|
489
|
-
* @type {string}
|
|
490
|
-
* @memberof TradingApiCancelOrder
|
|
491
|
-
*/
|
|
492
|
-
readonly userId: string;
|
|
493
|
-
/**
|
|
494
|
-
*
|
|
495
|
-
* @type {string}
|
|
496
|
-
* @memberof TradingApiCancelOrder
|
|
497
|
-
*/
|
|
498
|
-
readonly userSecret: string;
|
|
499
|
-
/**
|
|
500
|
-
*
|
|
501
|
-
* @type {string}
|
|
502
|
-
* @memberof TradingApiCancelOrder
|
|
503
|
-
*/
|
|
504
|
-
readonly accountId: string;
|
|
505
|
-
} & AccountInformationGetUserAccountOrderDetailRequest;
|
|
506
|
-
/**
|
|
507
|
-
* Request parameters for cancelUserAccountOrder operation in TradingApi.
|
|
508
|
-
* @export
|
|
509
|
-
* @interface TradingApiCancelUserAccountOrderRequest
|
|
510
|
-
*/
|
|
511
|
-
export type TradingApiCancelUserAccountOrderRequest = {
|
|
512
|
-
/**
|
|
513
|
-
*
|
|
514
|
-
* @type {string}
|
|
515
|
-
* @memberof TradingApiCancelUserAccountOrder
|
|
516
|
-
*/
|
|
517
|
-
readonly userId: string;
|
|
518
|
-
/**
|
|
519
|
-
*
|
|
520
|
-
* @type {string}
|
|
521
|
-
* @memberof TradingApiCancelUserAccountOrder
|
|
522
|
-
*/
|
|
523
|
-
readonly userSecret: string;
|
|
524
|
-
/**
|
|
525
|
-
*
|
|
526
|
-
* @type {string}
|
|
527
|
-
* @memberof TradingApiCancelUserAccountOrder
|
|
528
|
-
*/
|
|
529
|
-
readonly accountId: string;
|
|
530
|
-
} & AccountInformationGetUserAccountOrderDetailRequest;
|
|
531
|
-
/**
|
|
532
|
-
* Request parameters for getCryptocurrencyPairQuote operation in TradingApi.
|
|
533
|
-
* @export
|
|
534
|
-
* @interface TradingApiGetCryptocurrencyPairQuoteRequest
|
|
535
|
-
*/
|
|
536
|
-
export type TradingApiGetCryptocurrencyPairQuoteRequest = {
|
|
537
|
-
/**
|
|
538
|
-
*
|
|
539
|
-
* @type {string}
|
|
540
|
-
* @memberof TradingApiGetCryptocurrencyPairQuote
|
|
541
|
-
*/
|
|
542
|
-
readonly userId: string;
|
|
543
|
-
/**
|
|
544
|
-
*
|
|
545
|
-
* @type {string}
|
|
546
|
-
* @memberof TradingApiGetCryptocurrencyPairQuote
|
|
547
|
-
*/
|
|
548
|
-
readonly userSecret: string;
|
|
549
|
-
/**
|
|
550
|
-
*
|
|
551
|
-
* @type {string}
|
|
552
|
-
* @memberof TradingApiGetCryptocurrencyPairQuote
|
|
553
|
-
*/
|
|
554
|
-
readonly accountId: string;
|
|
555
|
-
/**
|
|
556
|
-
*
|
|
557
|
-
* @type {string}
|
|
558
|
-
* @memberof TradingApiGetCryptocurrencyPairQuote
|
|
559
|
-
*/
|
|
560
|
-
readonly instrumentSymbol: string;
|
|
561
|
-
};
|
|
562
|
-
/**
|
|
563
|
-
* Request parameters for getOptionImpact operation in TradingApi.
|
|
564
|
-
* @export
|
|
565
|
-
* @interface TradingApiGetOptionImpactRequest
|
|
566
|
-
*/
|
|
567
|
-
export type TradingApiGetOptionImpactRequest = {
|
|
568
|
-
/**
|
|
569
|
-
*
|
|
570
|
-
* @type {string}
|
|
571
|
-
* @memberof TradingApiGetOptionImpact
|
|
572
|
-
*/
|
|
573
|
-
readonly userId: string;
|
|
574
|
-
/**
|
|
575
|
-
*
|
|
576
|
-
* @type {string}
|
|
577
|
-
* @memberof TradingApiGetOptionImpact
|
|
578
|
-
*/
|
|
579
|
-
readonly userSecret: string;
|
|
580
|
-
/**
|
|
581
|
-
*
|
|
582
|
-
* @type {string}
|
|
583
|
-
* @memberof TradingApiGetOptionImpact
|
|
584
|
-
*/
|
|
585
|
-
readonly accountId: string;
|
|
586
|
-
} & MlegTradeForm;
|
|
587
|
-
/**
|
|
588
|
-
* Request parameters for getOrderImpact operation in TradingApi.
|
|
589
|
-
* @export
|
|
590
|
-
* @interface TradingApiGetOrderImpactRequest
|
|
591
|
-
*/
|
|
592
|
-
export type TradingApiGetOrderImpactRequest = {
|
|
593
|
-
/**
|
|
594
|
-
*
|
|
595
|
-
* @type {string}
|
|
596
|
-
* @memberof TradingApiGetOrderImpact
|
|
597
|
-
*/
|
|
598
|
-
readonly userId: string;
|
|
599
|
-
/**
|
|
600
|
-
*
|
|
601
|
-
* @type {string}
|
|
602
|
-
* @memberof TradingApiGetOrderImpact
|
|
603
|
-
*/
|
|
604
|
-
readonly userSecret: string;
|
|
605
|
-
} & ManualTradeForm;
|
|
606
|
-
/**
|
|
607
|
-
* Request parameters for getUserAccountOptionQuotes operation in TradingApi.
|
|
608
|
-
* @export
|
|
609
|
-
* @interface TradingApiGetUserAccountOptionQuotesRequest
|
|
610
|
-
*/
|
|
611
|
-
export type TradingApiGetUserAccountOptionQuotesRequest = {
|
|
612
|
-
/**
|
|
613
|
-
*
|
|
614
|
-
* @type {string}
|
|
615
|
-
* @memberof TradingApiGetUserAccountOptionQuotes
|
|
616
|
-
*/
|
|
617
|
-
readonly userId: string;
|
|
618
|
-
/**
|
|
619
|
-
*
|
|
620
|
-
* @type {string}
|
|
621
|
-
* @memberof TradingApiGetUserAccountOptionQuotes
|
|
622
|
-
*/
|
|
623
|
-
readonly userSecret: string;
|
|
624
|
-
/**
|
|
625
|
-
*
|
|
626
|
-
* @type {string}
|
|
627
|
-
* @memberof TradingApiGetUserAccountOptionQuotes
|
|
628
|
-
*/
|
|
629
|
-
readonly accountId: string;
|
|
630
|
-
/**
|
|
631
|
-
* The OCC-formatted option symbol.
|
|
632
|
-
* @type {string}
|
|
633
|
-
* @memberof TradingApiGetUserAccountOptionQuotes
|
|
634
|
-
*/
|
|
635
|
-
readonly symbol: string;
|
|
636
|
-
};
|
|
637
|
-
/**
|
|
638
|
-
* Request parameters for getUserAccountQuotes operation in TradingApi.
|
|
639
|
-
* @export
|
|
640
|
-
* @interface TradingApiGetUserAccountQuotesRequest
|
|
641
|
-
*/
|
|
642
|
-
export type TradingApiGetUserAccountQuotesRequest = {
|
|
643
|
-
/**
|
|
644
|
-
*
|
|
645
|
-
* @type {string}
|
|
646
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
647
|
-
*/
|
|
648
|
-
readonly userId: string;
|
|
649
|
-
/**
|
|
650
|
-
*
|
|
651
|
-
* @type {string}
|
|
652
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
653
|
-
*/
|
|
654
|
-
readonly userSecret: string;
|
|
655
|
-
/**
|
|
656
|
-
* List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
657
|
-
* @type {string}
|
|
658
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
659
|
-
*/
|
|
660
|
-
readonly symbols: string;
|
|
661
|
-
/**
|
|
662
|
-
*
|
|
663
|
-
* @type {string}
|
|
664
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
665
|
-
*/
|
|
666
|
-
readonly accountId: string;
|
|
667
|
-
/**
|
|
668
|
-
* Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
|
|
669
|
-
* @type {boolean}
|
|
670
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
671
|
-
*/
|
|
672
|
-
readonly useTicker?: boolean;
|
|
673
|
-
};
|
|
674
|
-
/**
|
|
675
|
-
* Request parameters for placeBracketOrder operation in TradingApi.
|
|
676
|
-
* @export
|
|
677
|
-
* @interface TradingApiPlaceBracketOrderRequest
|
|
678
|
-
*/
|
|
679
|
-
export type TradingApiPlaceBracketOrderRequest = {
|
|
680
|
-
/**
|
|
681
|
-
* The ID of the account to execute the trade on.
|
|
682
|
-
* @type {string}
|
|
683
|
-
* @memberof TradingApiPlaceBracketOrder
|
|
684
|
-
*/
|
|
685
|
-
readonly accountId: string;
|
|
686
|
-
/**
|
|
687
|
-
*
|
|
688
|
-
* @type {string}
|
|
689
|
-
* @memberof TradingApiPlaceBracketOrder
|
|
690
|
-
*/
|
|
691
|
-
readonly userId: string;
|
|
692
|
-
/**
|
|
693
|
-
*
|
|
694
|
-
* @type {string}
|
|
695
|
-
* @memberof TradingApiPlaceBracketOrder
|
|
696
|
-
*/
|
|
697
|
-
readonly userSecret: string;
|
|
698
|
-
} & ManualTradeFormBracket;
|
|
699
|
-
/**
|
|
700
|
-
* Request parameters for placeComplexOrder operation in TradingApi.
|
|
701
|
-
* @export
|
|
702
|
-
* @interface TradingApiPlaceComplexOrderRequest
|
|
703
|
-
*/
|
|
704
|
-
export type TradingApiPlaceComplexOrderRequest = {
|
|
705
|
-
/**
|
|
706
|
-
* The ID of the account to execute the trade on.
|
|
707
|
-
* @type {string}
|
|
708
|
-
* @memberof TradingApiPlaceComplexOrder
|
|
709
|
-
*/
|
|
710
|
-
readonly accountId: string;
|
|
711
|
-
/**
|
|
712
|
-
*
|
|
713
|
-
* @type {string}
|
|
714
|
-
* @memberof TradingApiPlaceComplexOrder
|
|
715
|
-
*/
|
|
716
|
-
readonly userId: string;
|
|
717
|
-
/**
|
|
718
|
-
*
|
|
719
|
-
* @type {string}
|
|
720
|
-
* @memberof TradingApiPlaceComplexOrder
|
|
721
|
-
*/
|
|
722
|
-
readonly userSecret: string;
|
|
723
|
-
} & ManualTradeFormComplex;
|
|
724
|
-
/**
|
|
725
|
-
* Request parameters for placeCryptoOrder operation in TradingApi.
|
|
726
|
-
* @export
|
|
727
|
-
* @interface TradingApiPlaceCryptoOrderRequest
|
|
728
|
-
*/
|
|
729
|
-
export type TradingApiPlaceCryptoOrderRequest = {
|
|
730
|
-
/**
|
|
731
|
-
*
|
|
732
|
-
* @type {string}
|
|
733
|
-
* @memberof TradingApiPlaceCryptoOrder
|
|
734
|
-
*/
|
|
735
|
-
readonly userId: string;
|
|
736
|
-
/**
|
|
737
|
-
*
|
|
738
|
-
* @type {string}
|
|
739
|
-
* @memberof TradingApiPlaceCryptoOrder
|
|
740
|
-
*/
|
|
741
|
-
readonly userSecret: string;
|
|
742
|
-
/**
|
|
743
|
-
*
|
|
744
|
-
* @type {string}
|
|
745
|
-
* @memberof TradingApiPlaceCryptoOrder
|
|
746
|
-
*/
|
|
747
|
-
readonly accountId: string;
|
|
748
|
-
} & CryptoOrderForm;
|
|
749
|
-
/**
|
|
750
|
-
* Request parameters for placeForceOrder operation in TradingApi.
|
|
751
|
-
* @export
|
|
752
|
-
* @interface TradingApiPlaceForceOrderRequest
|
|
753
|
-
*/
|
|
754
|
-
export type TradingApiPlaceForceOrderRequest = {
|
|
755
|
-
/**
|
|
756
|
-
*
|
|
757
|
-
* @type {string}
|
|
758
|
-
* @memberof TradingApiPlaceForceOrder
|
|
759
|
-
*/
|
|
760
|
-
readonly userId: string;
|
|
761
|
-
/**
|
|
762
|
-
*
|
|
763
|
-
* @type {string}
|
|
764
|
-
* @memberof TradingApiPlaceForceOrder
|
|
765
|
-
*/
|
|
766
|
-
readonly userSecret: string;
|
|
767
|
-
} & ManualTradeFormWithOptions;
|
|
768
|
-
/**
|
|
769
|
-
* Request parameters for placeMlegOrder operation in TradingApi.
|
|
770
|
-
* @export
|
|
771
|
-
* @interface TradingApiPlaceMlegOrderRequest
|
|
772
|
-
*/
|
|
773
|
-
export type TradingApiPlaceMlegOrderRequest = {
|
|
774
|
-
/**
|
|
775
|
-
*
|
|
776
|
-
* @type {string}
|
|
777
|
-
* @memberof TradingApiPlaceMlegOrder
|
|
778
|
-
*/
|
|
779
|
-
readonly userId: string;
|
|
780
|
-
/**
|
|
781
|
-
*
|
|
782
|
-
* @type {string}
|
|
783
|
-
* @memberof TradingApiPlaceMlegOrder
|
|
784
|
-
*/
|
|
785
|
-
readonly userSecret: string;
|
|
786
|
-
/**
|
|
787
|
-
*
|
|
788
|
-
* @type {string}
|
|
789
|
-
* @memberof TradingApiPlaceMlegOrder
|
|
790
|
-
*/
|
|
791
|
-
readonly accountId: string;
|
|
792
|
-
} & MlegTradeForm;
|
|
793
|
-
/**
|
|
794
|
-
* Request parameters for placeOrder operation in TradingApi.
|
|
795
|
-
* @export
|
|
796
|
-
* @interface TradingApiPlaceOrderRequest
|
|
797
|
-
*/
|
|
798
|
-
export type TradingApiPlaceOrderRequest = {
|
|
799
|
-
/**
|
|
800
|
-
* Obtained from calling the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact)
|
|
801
|
-
* @type {string}
|
|
802
|
-
* @memberof TradingApiPlaceOrder
|
|
803
|
-
*/
|
|
804
|
-
readonly tradeId: string;
|
|
805
|
-
/**
|
|
806
|
-
*
|
|
807
|
-
* @type {string}
|
|
808
|
-
* @memberof TradingApiPlaceOrder
|
|
809
|
-
*/
|
|
810
|
-
readonly userId: string;
|
|
811
|
-
/**
|
|
812
|
-
*
|
|
813
|
-
* @type {string}
|
|
814
|
-
* @memberof TradingApiPlaceOrder
|
|
815
|
-
*/
|
|
816
|
-
readonly userSecret: string;
|
|
817
|
-
} & ValidatedTradeBody;
|
|
818
|
-
/**
|
|
819
|
-
* Request parameters for previewCryptoOrder operation in TradingApi.
|
|
820
|
-
* @export
|
|
821
|
-
* @interface TradingApiPreviewCryptoOrderRequest
|
|
822
|
-
*/
|
|
823
|
-
export type TradingApiPreviewCryptoOrderRequest = {
|
|
824
|
-
/**
|
|
825
|
-
*
|
|
826
|
-
* @type {string}
|
|
827
|
-
* @memberof TradingApiPreviewCryptoOrder
|
|
828
|
-
*/
|
|
829
|
-
readonly userId: string;
|
|
830
|
-
/**
|
|
831
|
-
*
|
|
832
|
-
* @type {string}
|
|
833
|
-
* @memberof TradingApiPreviewCryptoOrder
|
|
834
|
-
*/
|
|
835
|
-
readonly userSecret: string;
|
|
836
|
-
/**
|
|
837
|
-
*
|
|
838
|
-
* @type {string}
|
|
839
|
-
* @memberof TradingApiPreviewCryptoOrder
|
|
840
|
-
*/
|
|
841
|
-
readonly accountId: string;
|
|
842
|
-
} & CryptoOrderForm;
|
|
843
|
-
/**
|
|
844
|
-
* Request parameters for replaceOrder operation in TradingApi.
|
|
845
|
-
* @export
|
|
846
|
-
* @interface TradingApiReplaceOrderRequest
|
|
847
|
-
*/
|
|
848
|
-
export type TradingApiReplaceOrderRequest = {
|
|
849
|
-
/**
|
|
850
|
-
* The ID of the account to execute the trade on.
|
|
851
|
-
* @type {string}
|
|
852
|
-
* @memberof TradingApiReplaceOrder
|
|
853
|
-
*/
|
|
854
|
-
readonly accountId: string;
|
|
855
|
-
/**
|
|
856
|
-
*
|
|
857
|
-
* @type {string}
|
|
858
|
-
* @memberof TradingApiReplaceOrder
|
|
859
|
-
*/
|
|
860
|
-
readonly userId: string;
|
|
861
|
-
/**
|
|
862
|
-
*
|
|
863
|
-
* @type {string}
|
|
864
|
-
* @memberof TradingApiReplaceOrder
|
|
865
|
-
*/
|
|
866
|
-
readonly userSecret: string;
|
|
867
|
-
} & ManualTradeReplaceForm;
|
|
868
|
-
/**
|
|
869
|
-
* Request parameters for searchCryptocurrencyPairInstruments operation in TradingApi.
|
|
870
|
-
* @export
|
|
871
|
-
* @interface TradingApiSearchCryptocurrencyPairInstrumentsRequest
|
|
872
|
-
*/
|
|
873
|
-
export type TradingApiSearchCryptocurrencyPairInstrumentsRequest = {
|
|
874
|
-
/**
|
|
875
|
-
*
|
|
876
|
-
* @type {string}
|
|
877
|
-
* @memberof TradingApiSearchCryptocurrencyPairInstruments
|
|
878
|
-
*/
|
|
879
|
-
readonly userId: string;
|
|
880
|
-
/**
|
|
881
|
-
*
|
|
882
|
-
* @type {string}
|
|
883
|
-
* @memberof TradingApiSearchCryptocurrencyPairInstruments
|
|
884
|
-
*/
|
|
885
|
-
readonly userSecret: string;
|
|
886
|
-
/**
|
|
887
|
-
*
|
|
888
|
-
* @type {string}
|
|
889
|
-
* @memberof TradingApiSearchCryptocurrencyPairInstruments
|
|
890
|
-
*/
|
|
891
|
-
readonly accountId: string;
|
|
892
|
-
/**
|
|
893
|
-
*
|
|
894
|
-
* @type {string}
|
|
895
|
-
* @memberof TradingApiSearchCryptocurrencyPairInstruments
|
|
896
|
-
*/
|
|
897
|
-
readonly base?: string;
|
|
898
|
-
/**
|
|
899
|
-
*
|
|
900
|
-
* @type {string}
|
|
901
|
-
* @memberof TradingApiSearchCryptocurrencyPairInstruments
|
|
902
|
-
*/
|
|
903
|
-
readonly quote?: string;
|
|
904
|
-
};
|
|
905
|
-
/**
|
|
906
|
-
* TradingApiGenerated - object-oriented interface
|
|
907
|
-
* @export
|
|
908
|
-
* @class TradingApiGenerated
|
|
909
|
-
* @extends {BaseAPI}
|
|
910
|
-
*/
|
|
911
|
-
export declare class TradingApiGenerated extends BaseAPI {
|
|
912
|
-
/**
|
|
913
|
-
* Cancels an order in the specified account. Accepts order IDs for all asset types.
|
|
914
|
-
* @summary Cancel order
|
|
915
|
-
* @param {TradingApiCancelOrderRequest} requestParameters Request parameters.
|
|
916
|
-
* @param {*} [options] Override http request option.
|
|
917
|
-
* @throws {RequiredError}
|
|
918
|
-
* @memberof TradingApiGenerated
|
|
919
|
-
*/
|
|
920
|
-
cancelOrder(requestParameters: TradingApiCancelOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CancelOrderResponse, any, {}>>;
|
|
921
|
-
/**
|
|
922
|
-
* **This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) ** Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
923
|
-
* @summary Cancel equity order
|
|
924
|
-
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
925
|
-
* @param {*} [options] Override http request option.
|
|
926
|
-
* @deprecated
|
|
927
|
-
* @throws {RequiredError}
|
|
928
|
-
* @memberof TradingApiGenerated
|
|
929
|
-
*/
|
|
930
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
931
|
-
/**
|
|
932
|
-
* Gets a quote for the specified account.
|
|
933
|
-
* @summary Get crypto pair quote
|
|
934
|
-
* @param {TradingApiGetCryptocurrencyPairQuoteRequest} requestParameters Request parameters.
|
|
935
|
-
* @param {*} [options] Override http request option.
|
|
936
|
-
* @throws {RequiredError}
|
|
937
|
-
* @memberof TradingApiGenerated
|
|
938
|
-
*/
|
|
939
|
-
getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any, {}>>;
|
|
940
|
-
/**
|
|
941
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain enabled brokerages. Please refer to the [brokerage trading support page](https://support.snaptrade.com/brokerages) for more information on which brokerages support this endpoint.
|
|
942
|
-
* @summary Get option order impact
|
|
943
|
-
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
944
|
-
* @param {*} [options] Override http request option.
|
|
945
|
-
* @throws {RequiredError}
|
|
946
|
-
* @memberof TradingApiGenerated
|
|
947
|
-
*/
|
|
948
|
-
getOptionImpact(requestParameters: TradingApiGetOptionImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionImpact, any, {}>>;
|
|
949
|
-
/**
|
|
950
|
-
* Simulates an order and its impact on the account. This endpoint does not place the order with the brokerage. If successful, it returns a `Trade` object and the ID of the object can be used to place the order with the brokerage using the [place checked order endpoint](/reference/Trading/Trading_placeOrder). Please note that the `Trade` object returned expires after 5 minutes. Any order placed using an expired `Trade` will be rejected.
|
|
951
|
-
* @summary Check equity order impact
|
|
952
|
-
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
953
|
-
* @param {*} [options] Override http request option.
|
|
954
|
-
* @throws {RequiredError}
|
|
955
|
-
* @memberof TradingApiGenerated
|
|
956
|
-
*/
|
|
957
|
-
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any, {}>>;
|
|
958
|
-
/**
|
|
959
|
-
* Returns a quote for a single option contract. The option contract is specified using in the 21 character OCC format. For example `AAPL 251114C00240000` represents a call option on AAPL expiring on 2025-11-14 with a strike price of $240. For more information on the OCC format, see [here](https://en.wikipedia.org/wiki/Option_symbol#OCC_format) **Note:** These are derived values and are not suitable for trading purposes.
|
|
960
|
-
* @summary Get option quote
|
|
961
|
-
* @param {TradingApiGetUserAccountOptionQuotesRequest} requestParameters Request parameters.
|
|
962
|
-
* @param {*} [options] Override http request option.
|
|
963
|
-
* @throws {RequiredError}
|
|
964
|
-
* @memberof TradingApiGenerated
|
|
965
|
-
*/
|
|
966
|
-
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any, {}>>;
|
|
967
|
-
/**
|
|
968
|
-
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
969
|
-
* @summary Get equity symbol quotes
|
|
970
|
-
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
971
|
-
* @param {*} [options] Override http request option.
|
|
972
|
-
* @throws {RequiredError}
|
|
973
|
-
* @memberof TradingApiGenerated
|
|
974
|
-
*/
|
|
975
|
-
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any, {}>>;
|
|
976
|
-
/**
|
|
977
|
-
* **This endpoint is deprecated. Please switch to [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) ** Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for use. Only supported on certain brokerages
|
|
978
|
-
* @summary Place bracket order
|
|
979
|
-
* @param {TradingApiPlaceBracketOrderRequest} requestParameters Request parameters.
|
|
980
|
-
* @param {*} [options] Override http request option.
|
|
981
|
-
* @deprecated
|
|
982
|
-
* @throws {RequiredError}
|
|
983
|
-
* @memberof TradingApiGenerated
|
|
984
|
-
*/
|
|
985
|
-
placeBracketOrder(requestParameters: TradingApiPlaceBracketOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
986
|
-
/**
|
|
987
|
-
* Places a complex conditional order (OCO, OTO, or OTOCO). Disabled by default — contact support to enable. Only supported on certain brokerages. - **OCO** (One Cancels the Other): Two peer orders; when one fills the other is cancelled. - **OTO** (One Triggers the Other): A trigger order that, when filled, activates a conditional order. - **OTOCO** (One Triggers a One Cancels the Other): A trigger order that, when filled, activates an OCO pair of two peer orders.
|
|
988
|
-
* @summary Place complex order
|
|
989
|
-
* @param {TradingApiPlaceComplexOrderRequest} requestParameters Request parameters.
|
|
990
|
-
* @param {*} [options] Override http request option.
|
|
991
|
-
* @throws {RequiredError}
|
|
992
|
-
* @memberof TradingApiGenerated
|
|
993
|
-
*/
|
|
994
|
-
placeComplexOrder(requestParameters: TradingApiPlaceComplexOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ComplexOrderResponse, any, {}>>;
|
|
995
|
-
/**
|
|
996
|
-
* Places an order in the specified account. This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
997
|
-
* @summary Place crypto order
|
|
998
|
-
* @param {TradingApiPlaceCryptoOrderRequest} requestParameters Request parameters.
|
|
999
|
-
* @param {*} [options] Override http request option.
|
|
1000
|
-
* @throws {RequiredError}
|
|
1001
|
-
* @memberof TradingApiGenerated
|
|
1002
|
-
*/
|
|
1003
|
-
placeCryptoOrder(requestParameters: TradingApiPlaceCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderUpdatedResponse, any, {}>>;
|
|
1004
|
-
/**
|
|
1005
|
-
* Places a brokerage order in the specified account. The order could be rejected by the brokerage if it is invalid or if the account does not have sufficient funds. This endpoint does not compute the impact to the account balance from the order and any potential commissions before submitting the order to the brokerage. If that is desired, you can use the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
1006
|
-
* @summary Place equity order
|
|
1007
|
-
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
1008
|
-
* @param {*} [options] Override http request option.
|
|
1009
|
-
* @throws {RequiredError}
|
|
1010
|
-
* @memberof TradingApiGenerated
|
|
1011
|
-
*/
|
|
1012
|
-
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
1013
|
-
/**
|
|
1014
|
-
* Places a multi-leg option order. Only supported on certain option trading brokerages. https://support.snaptrade.com/brokerages has information on brokerage trading support
|
|
1015
|
-
* @summary Place option order
|
|
1016
|
-
* @param {TradingApiPlaceMlegOrderRequest} requestParameters Request parameters.
|
|
1017
|
-
* @param {*} [options] Override http request option.
|
|
1018
|
-
* @throws {RequiredError}
|
|
1019
|
-
* @memberof TradingApiGenerated
|
|
1020
|
-
*/
|
|
1021
|
-
placeMlegOrder(requestParameters: TradingApiPlaceMlegOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MlegOrderResponse, any, {}>>;
|
|
1022
|
-
/**
|
|
1023
|
-
* Places the previously checked order with the brokerage. The `tradeId` is obtained from the [check order impact endpoint](/reference/Trading/Trading_getOrderImpact). If you prefer to place the order without checking for impact first, you can use the [place order endpoint](/reference/Trading/Trading_placeForceOrder). It\'s recommended to trigger a manual refresh of the account after placing an order to ensure the account is up to date. You can use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint for this.
|
|
1024
|
-
* @summary Place checked equity order
|
|
1025
|
-
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
1026
|
-
* @param {*} [options] Override http request option.
|
|
1027
|
-
* @throws {RequiredError}
|
|
1028
|
-
* @memberof TradingApiGenerated
|
|
1029
|
-
*/
|
|
1030
|
-
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
1031
|
-
/**
|
|
1032
|
-
* Previews an order using the specified account.
|
|
1033
|
-
* @summary Preview crypto order
|
|
1034
|
-
* @param {TradingApiPreviewCryptoOrderRequest} requestParameters Request parameters.
|
|
1035
|
-
* @param {*} [options] Override http request option.
|
|
1036
|
-
* @throws {RequiredError}
|
|
1037
|
-
* @memberof TradingApiGenerated
|
|
1038
|
-
*/
|
|
1039
|
-
previewCryptoOrder(requestParameters: TradingApiPreviewCryptoOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptoOrderPreview, any, {}>>;
|
|
1040
|
-
/**
|
|
1041
|
-
* Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling the existing order and placing a new one. The order\'s brokerage_order_id may or may not change, be sure to use the one returned in the response going forward. Only supported on some brokerages
|
|
1042
|
-
* @summary Replace order
|
|
1043
|
-
* @param {TradingApiReplaceOrderRequest} requestParameters Request parameters.
|
|
1044
|
-
* @param {*} [options] Override http request option.
|
|
1045
|
-
* @throws {RequiredError}
|
|
1046
|
-
* @memberof TradingApiGenerated
|
|
1047
|
-
*/
|
|
1048
|
-
replaceOrder(requestParameters: TradingApiReplaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any, {}>>;
|
|
1049
|
-
/**
|
|
1050
|
-
* Searches cryptocurrency pairs instruments accessible to the specified account. Both `base` and `quote` are optional. Omit both for a full list of cryptocurrency pairs.
|
|
1051
|
-
* @summary Get crypto pairs
|
|
1052
|
-
* @param {TradingApiSearchCryptocurrencyPairInstrumentsRequest} requestParameters Request parameters.
|
|
1053
|
-
* @param {*} [options] Override http request option.
|
|
1054
|
-
* @throws {RequiredError}
|
|
1055
|
-
* @memberof TradingApiGenerated
|
|
1056
|
-
*/
|
|
1057
|
-
searchCryptocurrencyPairInstruments(requestParameters: TradingApiSearchCryptocurrencyPairInstrumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TradingSearchCryptocurrencyPairInstruments200Response, any, {}>>;
|
|
1058
|
-
}
|