snaptrade-typescript-sdk 8.17.0 → 8.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +147 -183
- package/dist/api/account-information-api-custom.d.ts +3 -3
- package/dist/api/account-information-api-custom.js +27 -27
- package/dist/api/account-information-api.d.ts +526 -527
- package/dist/api/account-information-api.js +1049 -1050
- package/dist/api/api-status-api-custom.d.ts +3 -3
- package/dist/api/api-status-api-custom.js +27 -27
- package/dist/api/api-status-api.d.ts +70 -71
- package/dist/api/api-status-api.js +203 -204
- package/dist/api/authentication-api-custom.d.ts +3 -3
- package/dist/api/authentication-api-custom.js +27 -27
- package/dist/api/authentication-api.d.ts +267 -268
- package/dist/api/authentication-api.js +661 -662
- package/dist/api/connections-api-custom.d.ts +3 -3
- package/dist/api/connections-api-custom.js +27 -27
- package/dist/api/connections-api.d.ts +275 -276
- package/dist/api/connections-api.js +583 -584
- package/dist/api/error-logs-api-custom.d.ts +3 -3
- package/dist/api/error-logs-api-custom.js +27 -27
- package/dist/api/error-logs-api.d.ts +94 -95
- package/dist/api/error-logs-api.js +240 -241
- package/dist/api/options-api-custom.d.ts +3 -3
- package/dist/api/options-api-custom.js +27 -27
- package/dist/api/options-api.d.ts +369 -370
- package/dist/api/options-api.js +730 -731
- package/dist/api/reference-data-api-custom.d.ts +3 -3
- package/dist/api/reference-data-api-custom.js +27 -27
- package/dist/api/reference-data-api.d.ts +468 -469
- package/dist/api/reference-data-api.js +1246 -1247
- package/dist/api/trading-api-custom.d.ts +3 -3
- package/dist/api/trading-api-custom.js +27 -27
- package/dist/api/trading-api.d.ts +403 -634
- package/dist/api/trading-api.js +841 -1282
- package/dist/api/transactions-and-reporting-api-custom.d.ts +3 -3
- package/dist/api/transactions-and-reporting-api-custom.js +27 -27
- package/dist/api/transactions-and-reporting-api.d.ts +218 -219
- package/dist/api/transactions-and-reporting-api.js +403 -404
- package/dist/api.d.ts +19 -21
- package/dist/api.js +37 -39
- package/dist/base.d.ts +54 -55
- package/dist/base.js +81 -82
- package/dist/client-custom.d.ts +4 -4
- package/dist/client-custom.js +9 -9
- package/dist/client.d.ts +25 -27
- package/dist/client.js +50 -52
- package/dist/common.d.ts +67 -67
- package/dist/common.js +236 -233
- package/dist/configuration.d.ts +99 -100
- package/dist/configuration.js +55 -56
- package/dist/index.d.ts +14 -15
- package/dist/index.js +32 -33
- package/dist/jest.config.d.ts +3 -3
- package/dist/jest.config.js +13 -13
- package/dist/models/account-holdings-account.d.ts +53 -54
- package/dist/models/account-holdings-account.js +14 -15
- package/dist/models/account-holdings.d.ts +46 -47
- package/dist/models/account-holdings.js +14 -15
- package/dist/models/account-order-record-status.d.ts +16 -17
- package/dist/models/account-order-record-status.js +14 -15
- package/dist/models/account-order-record.d.ts +132 -133
- package/dist/models/account-order-record.js +14 -15
- package/dist/models/account-simple.d.ts +43 -44
- package/dist/models/account-simple.js +14 -15
- package/dist/models/account-sync-status.d.ts +24 -25
- package/dist/models/account-sync-status.js +14 -15
- package/dist/models/account.d.ts +82 -83
- package/dist/models/account.js +14 -15
- package/dist/models/action.d.ts +16 -17
- package/dist/models/action.js +14 -15
- package/dist/models/authentication-login-snap-trade-user200-response.d.ts +17 -18
- package/dist/models/authentication-login-snap-trade-user200-response.js +14 -15
- package/dist/models/balance.d.ts +31 -32
- package/dist/models/balance.js +14 -15
- package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts +36 -37
- package/dist/models/brokerage-authorization-type-read-only-brokerage.js +14 -15
- package/dist/models/brokerage-authorization-type-read-only.d.ts +46 -47
- package/dist/models/brokerage-authorization-type-read-only.js +14 -15
- package/dist/models/brokerage-authorization-type.d.ts +26 -27
- package/dist/models/brokerage-authorization-type.js +14 -15
- package/dist/models/brokerage-authorization.d.ts +75 -76
- package/dist/models/brokerage-authorization.js +14 -15
- package/dist/models/brokerage-symbol.d.ts +50 -51
- package/dist/models/brokerage-symbol.js +14 -15
- package/dist/models/brokerage-type.d.ts +30 -31
- package/dist/models/brokerage-type.js +14 -15
- package/dist/models/brokerage.d.ts +127 -128
- package/dist/models/brokerage.js +14 -15
- package/dist/models/calculated-trade.d.ts +31 -32
- package/dist/models/calculated-trade.js +14 -15
- package/dist/models/cash-restriction.d.ts +50 -51
- package/dist/models/cash-restriction.js +14 -15
- package/dist/models/connections-session-events200-response-inner.d.ts +16 -17
- package/dist/models/connections-session-events200-response-inner.js +14 -15
- package/dist/models/currency.d.ts +36 -37
- package/dist/models/currency.js +14 -15
- package/dist/models/delete-user-response.d.ts +30 -31
- package/dist/models/delete-user-response.js +14 -15
- package/dist/models/dividend-at-date.d.ts +36 -37
- package/dist/models/dividend-at-date.js +14 -15
- package/dist/models/encrypted-response-encrypted-message-data.d.ts +36 -37
- package/dist/models/encrypted-response-encrypted-message-data.js +14 -15
- package/dist/models/encrypted-response.d.ts +30 -31
- package/dist/models/encrypted-response.js +14 -15
- package/dist/models/exchange-rate-pairs.d.ts +37 -38
- package/dist/models/exchange-rate-pairs.js +14 -15
- package/dist/models/exchange.d.ts +66 -67
- package/dist/models/exchange.js +14 -15
- package/dist/models/excluded-asset.d.ts +25 -26
- package/dist/models/excluded-asset.js +14 -15
- package/dist/models/index.d.ts +108 -108
- package/dist/models/index.js +124 -124
- package/dist/models/jwt.d.ts +24 -25
- package/dist/models/jwt.js +14 -15
- package/dist/models/login-redirect-uri.d.ts +29 -30
- package/dist/models/login-redirect-uri.js +14 -15
- package/dist/models/manual-trade-and-impact.d.ts +38 -39
- package/dist/models/manual-trade-and-impact.js +14 -15
- package/dist/models/manual-trade-balance.d.ts +38 -39
- package/dist/models/manual-trade-balance.js +14 -15
- package/dist/models/manual-trade-form.d.ts +68 -69
- package/dist/models/manual-trade-form.js +14 -15
- package/dist/models/manual-trade-symbol.d.ts +55 -56
- package/dist/models/manual-trade-symbol.js +14 -15
- package/dist/models/manual-trade.d.ts +70 -71
- package/dist/models/manual-trade.js +14 -15
- package/dist/models/model-asset-class-details.d.ts +32 -32
- package/dist/models/model-asset-class-details.js +14 -15
- package/dist/models/model-asset-class-target.d.ts +25 -26
- package/dist/models/model-asset-class-target.js +14 -15
- package/dist/models/model-asset-class.d.ts +30 -31
- package/dist/models/model-asset-class.js +14 -15
- package/dist/models/model-portfolio-asset-class.d.ts +31 -32
- package/dist/models/model-portfolio-asset-class.js +14 -15
- package/dist/models/model-portfolio-details.d.ts +39 -39
- package/dist/models/model-portfolio-details.js +14 -15
- package/dist/models/model-portfolio-security.d.ts +31 -32
- package/dist/models/model-portfolio-security.js +14 -15
- package/dist/models/model-portfolio.d.ts +38 -39
- package/dist/models/model-portfolio.js +14 -15
- package/dist/models/model400-failed-request-response.d.ts +30 -31
- package/dist/models/model400-failed-request-response.js +14 -15
- package/dist/models/model401-failed-request-response.d.ts +30 -31
- package/dist/models/model401-failed-request-response.js +14 -15
- package/dist/models/model403-failed-request-response.d.ts +30 -31
- package/dist/models/model403-failed-request-response.js +14 -15
- package/dist/models/model404-failed-request-response.d.ts +30 -31
- package/dist/models/model404-failed-request-response.js +14 -15
- package/dist/models/monthly-dividends.d.ts +31 -32
- package/dist/models/monthly-dividends.js +14 -15
- package/dist/models/net-contributions.d.ts +36 -37
- package/dist/models/net-contributions.js +14 -15
- package/dist/models/net-dividend.d.ts +37 -38
- package/dist/models/net-dividend.js +14 -15
- package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts +36 -37
- package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js +14 -15
- package/dist/models/option-chain-inner-chain-per-root-inner.d.ts +37 -38
- package/dist/models/option-chain-inner-chain-per-root-inner.js +14 -15
- package/dist/models/option-chain-inner.d.ts +49 -50
- package/dist/models/option-chain-inner.js +14 -15
- package/dist/models/option-leg.d.ts +38 -39
- package/dist/models/option-leg.js +14 -15
- package/dist/models/option-strategy-legs-inner.d.ts +41 -42
- package/dist/models/option-strategy-legs-inner.js +14 -15
- package/dist/models/option-strategy.d.ts +50 -51
- package/dist/models/option-strategy.js +14 -15
- package/dist/models/options-get-option-strategy-request.d.ts +38 -39
- package/dist/models/options-get-option-strategy-request.js +14 -15
- package/dist/models/options-holdings.d.ts +56 -57
- package/dist/models/options-holdings.js +14 -15
- package/dist/models/options-place-option-strategy-request.d.ts +38 -39
- package/dist/models/options-place-option-strategy-request.js +14 -15
- package/dist/models/options-position.d.ts +62 -63
- package/dist/models/options-position.js +14 -15
- package/dist/models/options-symbol.d.ts +85 -86
- package/dist/models/options-symbol.js +14 -15
- package/dist/models/order-type.d.ts +16 -17
- package/dist/models/order-type.js +14 -15
- package/dist/models/partner-data.d.ts +91 -92
- package/dist/models/partner-data.js +14 -15
- package/dist/models/past-value.d.ts +36 -37
- package/dist/models/past-value.js +14 -15
- package/dist/models/performance-custom.d.ts +137 -138
- package/dist/models/performance-custom.js +14 -15
- package/dist/models/portfolio-group-info.d.ts +92 -93
- package/dist/models/portfolio-group-info.js +14 -15
- package/dist/models/portfolio-group-position.d.ts +37 -38
- package/dist/models/portfolio-group-position.js +14 -15
- package/dist/models/portfolio-group-settings.d.ts +49 -50
- package/dist/models/portfolio-group-settings.js +14 -15
- package/dist/models/portfolio-group.d.ts +30 -31
- package/dist/models/portfolio-group.js +14 -15
- package/dist/models/position-symbol.d.ts +55 -56
- package/dist/models/position-symbol.js +14 -15
- package/dist/models/position.d.ts +55 -56
- package/dist/models/position.js +14 -15
- package/dist/models/redirect-tokenand-pin.d.ts +30 -31
- package/dist/models/redirect-tokenand-pin.js +14 -15
- package/dist/models/security-type.d.ts +42 -43
- package/dist/models/security-type.js +14 -15
- package/dist/models/session-event.d.ts +62 -63
- package/dist/models/session-event.js +14 -15
- package/dist/models/snap-trade-apidisclaimer-accept-status.d.ts +30 -31
- package/dist/models/snap-trade-apidisclaimer-accept-status.js +14 -15
- package/dist/models/snap-trade-holdings-account-account-id.d.ts +75 -76
- package/dist/models/snap-trade-holdings-account-account-id.js +14 -15
- package/dist/models/snap-trade-holdings-account.d.ts +70 -71
- package/dist/models/snap-trade-holdings-account.js +14 -15
- package/dist/models/snap-trade-holdings-total-value.d.ts +30 -31
- package/dist/models/snap-trade-holdings-total-value.js +14 -15
- package/dist/models/snap-trade-login-user-request-body.d.ts +49 -50
- package/dist/models/snap-trade-login-user-request-body.js +14 -15
- package/dist/models/snap-trade-register-user-request-body.d.ts +29 -30
- package/dist/models/snap-trade-register-user-request-body.js +14 -15
- package/dist/models/status.d.ts +36 -37
- package/dist/models/status.js +14 -15
- package/dist/models/strategy-impact-legs-inner.d.ts +60 -61
- package/dist/models/strategy-impact-legs-inner.js +14 -15
- package/dist/models/strategy-impact.d.ts +85 -86
- package/dist/models/strategy-impact.js +14 -15
- package/dist/models/strategy-order-place-orders-inner-legs-inner.d.ts +60 -61
- package/dist/models/strategy-order-place-orders-inner-legs-inner.js +14 -15
- package/dist/models/strategy-order-place-orders-inner.d.ts +277 -278
- package/dist/models/strategy-order-place-orders-inner.js +14 -15
- package/dist/models/strategy-order-place.d.ts +31 -32
- package/dist/models/strategy-order-place.js +14 -15
- package/dist/models/strategy-order-record.d.ts +89 -90
- package/dist/models/strategy-order-record.js +14 -15
- package/dist/models/strategy-quotes-greek.d.ts +48 -49
- package/dist/models/strategy-quotes-greek.js +14 -15
- package/dist/models/strategy-quotes.d.ts +56 -57
- package/dist/models/strategy-quotes.js +14 -15
- package/dist/models/sub-period-return-rate.d.ts +36 -37
- package/dist/models/sub-period-return-rate.js +14 -15
- package/dist/models/symbol-query.d.ts +23 -24
- package/dist/models/symbol-query.js +14 -15
- package/dist/models/symbol.d.ts +63 -64
- package/dist/models/symbol.js +14 -15
- package/dist/models/symbols-quotes-inner.d.ts +54 -55
- package/dist/models/symbols-quotes-inner.js +14 -15
- package/dist/models/target-asset.d.ts +57 -57
- package/dist/models/target-asset.js +14 -15
- package/dist/models/time-in-force.d.ts +16 -17
- package/dist/models/time-in-force.js +14 -15
- package/dist/models/trade-execution-status.d.ts +80 -81
- package/dist/models/trade-execution-status.js +14 -15
- package/dist/models/trade-impact.d.ts +50 -51
- package/dist/models/trade-impact.js +14 -15
- package/dist/models/trade.d.ts +71 -71
- package/dist/models/trade.js +14 -15
- package/dist/models/trading-cancel-user-account-order-request.d.ts +23 -24
- package/dist/models/trading-cancel-user-account-order-request.js +14 -15
- package/dist/models/trading-place-ocoorder-request.d.ts +29 -30
- package/dist/models/trading-place-ocoorder-request.js +14 -15
- package/dist/models/transactions-status.d.ts +29 -30
- package/dist/models/transactions-status.js +14 -15
- package/dist/models/underlying-symbol.d.ts +63 -64
- package/dist/models/underlying-symbol.js +14 -15
- package/dist/models/universal-activity.d.ts +118 -119
- package/dist/models/universal-activity.js +14 -15
- package/dist/models/universal-symbol-ticker.d.ts +69 -70
- package/dist/models/universal-symbol-ticker.js +14 -15
- package/dist/models/universal-symbol.d.ts +69 -69
- package/dist/models/universal-symbol.js +14 -15
- package/dist/models/user-error-log.d.ts +54 -55
- package/dist/models/user-error-log.js +14 -15
- package/dist/models/user-idand-secret.d.ts +30 -31
- package/dist/models/user-idand-secret.js +14 -15
- package/dist/models/user-settings.d.ts +79 -80
- package/dist/models/user-settings.js +14 -15
- package/dist/models/usexchange.d.ts +72 -73
- package/dist/models/usexchange.js +14 -15
- package/dist/pagination/page-types.d.ts +26 -27
- package/dist/pagination/page-types.js +12 -13
- package/dist/pagination/page.d.ts +35 -36
- package/dist/pagination/page.js +60 -61
- package/dist/pagination/pageable.d.ts +57 -58
- package/dist/pagination/pageable.js +126 -127
- package/dist/pagination/paginate.d.ts +16 -17
- package/dist/pagination/paginate.js +77 -78
- package/dist/requestAfterHook.d.ts +8 -8
- package/dist/requestAfterHook.js +45 -45
- package/dist/requestBeforeHook.d.ts +9 -9
- package/dist/requestBeforeHook.js +8 -8
- package/package.json +42 -42
- package/dist/api/portfolio-management-api-custom.d.ts +0 -3
- package/dist/api/portfolio-management-api-custom.js +0 -27
- package/dist/api/portfolio-management-api.d.ts +0 -1612
- package/dist/api/portfolio-management-api.js +0 -3534
|
@@ -1,634 +1,403 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* SnapTrade
|
|
3
|
-
* Connect brokerage accounts to your app for live positions and trading
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.0
|
|
6
|
-
* Contact: api@snaptrade.com
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This file is auto generated by Konfig (https://konfigthis.com).
|
|
9
|
-
*
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
*
|
|
32
|
-
* @
|
|
33
|
-
* @param {
|
|
34
|
-
* @
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
*
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
*
|
|
43
|
-
* @
|
|
44
|
-
* @
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
*
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
*
|
|
53
|
-
* @
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {
|
|
56
|
-
* @
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
*
|
|
62
|
-
* @
|
|
63
|
-
* @param {string}
|
|
64
|
-
* @param {
|
|
65
|
-
* @param {
|
|
66
|
-
* @
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
*
|
|
72
|
-
* @
|
|
73
|
-
* @param {string}
|
|
74
|
-
* @param {
|
|
75
|
-
* @param {
|
|
76
|
-
* @
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
*
|
|
84
|
-
* @
|
|
85
|
-
* @param {
|
|
86
|
-
* @
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
*
|
|
97
|
-
* @
|
|
98
|
-
* @param {
|
|
99
|
-
* @
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
*
|
|
105
|
-
* @
|
|
106
|
-
* @param {
|
|
107
|
-
* @param {
|
|
108
|
-
* @
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
*
|
|
114
|
-
* @
|
|
115
|
-
* @param {
|
|
116
|
-
* @
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
*
|
|
124
|
-
* @
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
*
|
|
129
|
-
* @
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
*
|
|
140
|
-
* @
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
*
|
|
151
|
-
* @
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
*
|
|
159
|
-
* @
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
*
|
|
167
|
-
* @
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
*
|
|
175
|
-
* @
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
*
|
|
183
|
-
* @
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
*
|
|
191
|
-
* @
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
/**
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
}
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
*
|
|
313
|
-
* @
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
/**
|
|
324
|
-
* The ID of
|
|
325
|
-
* @type {string}
|
|
326
|
-
* @memberof
|
|
327
|
-
*/
|
|
328
|
-
readonly
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
*
|
|
338
|
-
* @
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
}
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
/**
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
readonly userId: string;
|
|
405
|
-
/**
|
|
406
|
-
*
|
|
407
|
-
* @type {string}
|
|
408
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
409
|
-
*/
|
|
410
|
-
readonly userSecret: string;
|
|
411
|
-
/**
|
|
412
|
-
* List of universal_symbol_id or tickers to get quotes for.
|
|
413
|
-
* @type {string}
|
|
414
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
415
|
-
*/
|
|
416
|
-
readonly symbols: string;
|
|
417
|
-
/**
|
|
418
|
-
* The ID of the account to get quotes.
|
|
419
|
-
* @type {string}
|
|
420
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
421
|
-
*/
|
|
422
|
-
readonly accountId: string;
|
|
423
|
-
/**
|
|
424
|
-
* Should be set to True if providing tickers.
|
|
425
|
-
* @type {boolean}
|
|
426
|
-
* @memberof TradingApiGetUserAccountQuotes
|
|
427
|
-
*/
|
|
428
|
-
readonly useTicker?: boolean;
|
|
429
|
-
};
|
|
430
|
-
/**
|
|
431
|
-
* Request parameters for modifyCalculatedTradeById operation in TradingApi.
|
|
432
|
-
* @export
|
|
433
|
-
* @interface TradingApiModifyCalculatedTradeByIdRequest
|
|
434
|
-
*/
|
|
435
|
-
export type TradingApiModifyCalculatedTradeByIdRequest = {
|
|
436
|
-
/**
|
|
437
|
-
* The ID of the PortfolioGroup to perform rebalancing calculations
|
|
438
|
-
* @type {string}
|
|
439
|
-
* @memberof TradingApiModifyCalculatedTradeById
|
|
440
|
-
*/
|
|
441
|
-
readonly portfolioGroupId: string;
|
|
442
|
-
/**
|
|
443
|
-
* The ID of calculated trade to get account impact
|
|
444
|
-
* @type {string}
|
|
445
|
-
* @memberof TradingApiModifyCalculatedTradeById
|
|
446
|
-
*/
|
|
447
|
-
readonly calculatedTradeId: string;
|
|
448
|
-
/**
|
|
449
|
-
* The ID of trade object
|
|
450
|
-
* @type {string}
|
|
451
|
-
* @memberof TradingApiModifyCalculatedTradeById
|
|
452
|
-
*/
|
|
453
|
-
readonly tradeId: string;
|
|
454
|
-
} & Trade;
|
|
455
|
-
/**
|
|
456
|
-
* Request parameters for placeCalculatedTrades operation in TradingApi.
|
|
457
|
-
* @export
|
|
458
|
-
* @interface TradingApiPlaceCalculatedTradesRequest
|
|
459
|
-
*/
|
|
460
|
-
export type TradingApiPlaceCalculatedTradesRequest = {
|
|
461
|
-
/**
|
|
462
|
-
* The ID of the PortfolioGroup to perform rebalancing calculations
|
|
463
|
-
* @type {string}
|
|
464
|
-
* @memberof TradingApiPlaceCalculatedTrades
|
|
465
|
-
*/
|
|
466
|
-
readonly portfolioGroupId: string;
|
|
467
|
-
/**
|
|
468
|
-
* The ID of calculated trade to get account impact
|
|
469
|
-
* @type {string}
|
|
470
|
-
* @memberof TradingApiPlaceCalculatedTrades
|
|
471
|
-
*/
|
|
472
|
-
readonly calculatedTradeId: string;
|
|
473
|
-
};
|
|
474
|
-
/**
|
|
475
|
-
* Request parameters for placeForceOrder operation in TradingApi.
|
|
476
|
-
* @export
|
|
477
|
-
* @interface TradingApiPlaceForceOrderRequest
|
|
478
|
-
*/
|
|
479
|
-
export type TradingApiPlaceForceOrderRequest = {
|
|
480
|
-
/**
|
|
481
|
-
*
|
|
482
|
-
* @type {string}
|
|
483
|
-
* @memberof TradingApiPlaceForceOrder
|
|
484
|
-
*/
|
|
485
|
-
readonly userId: string;
|
|
486
|
-
/**
|
|
487
|
-
*
|
|
488
|
-
* @type {string}
|
|
489
|
-
* @memberof TradingApiPlaceForceOrder
|
|
490
|
-
*/
|
|
491
|
-
readonly userSecret: string;
|
|
492
|
-
} & ManualTradeForm;
|
|
493
|
-
/**
|
|
494
|
-
* Request parameters for placeOCOOrder operation in TradingApi.
|
|
495
|
-
* @export
|
|
496
|
-
* @interface TradingApiPlaceOCOOrderRequest
|
|
497
|
-
*/
|
|
498
|
-
export type TradingApiPlaceOCOOrderRequest = {
|
|
499
|
-
/**
|
|
500
|
-
*
|
|
501
|
-
* @type {string}
|
|
502
|
-
* @memberof TradingApiPlaceOCOOrder
|
|
503
|
-
*/
|
|
504
|
-
readonly userId: string;
|
|
505
|
-
/**
|
|
506
|
-
*
|
|
507
|
-
* @type {string}
|
|
508
|
-
* @memberof TradingApiPlaceOCOOrder
|
|
509
|
-
*/
|
|
510
|
-
readonly userSecret: string;
|
|
511
|
-
} & TradingPlaceOCOOrderRequest;
|
|
512
|
-
/**
|
|
513
|
-
* Request parameters for placeOrder operation in TradingApi.
|
|
514
|
-
* @export
|
|
515
|
-
* @interface TradingApiPlaceOrderRequest
|
|
516
|
-
*/
|
|
517
|
-
export type TradingApiPlaceOrderRequest = {
|
|
518
|
-
/**
|
|
519
|
-
* The ID of trade object obtained from trade/impact endpoint
|
|
520
|
-
* @type {string}
|
|
521
|
-
* @memberof TradingApiPlaceOrder
|
|
522
|
-
*/
|
|
523
|
-
readonly tradeId: string;
|
|
524
|
-
/**
|
|
525
|
-
*
|
|
526
|
-
* @type {string}
|
|
527
|
-
* @memberof TradingApiPlaceOrder
|
|
528
|
-
*/
|
|
529
|
-
readonly userId: string;
|
|
530
|
-
/**
|
|
531
|
-
*
|
|
532
|
-
* @type {string}
|
|
533
|
-
* @memberof TradingApiPlaceOrder
|
|
534
|
-
*/
|
|
535
|
-
readonly userSecret: string;
|
|
536
|
-
};
|
|
537
|
-
/**
|
|
538
|
-
* TradingApi - object-oriented interface
|
|
539
|
-
* @export
|
|
540
|
-
* @class TradingApi
|
|
541
|
-
* @extends {BaseAPI}
|
|
542
|
-
*/
|
|
543
|
-
export declare class TradingApi extends TradingApiCustom {
|
|
544
|
-
/**
|
|
545
|
-
*
|
|
546
|
-
* @summary Cancel open order in account
|
|
547
|
-
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
548
|
-
* @param {*} [options] Override http request option.
|
|
549
|
-
* @throws {RequiredError}
|
|
550
|
-
* @memberof TradingApi
|
|
551
|
-
*/
|
|
552
|
-
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
553
|
-
/**
|
|
554
|
-
*
|
|
555
|
-
* @summary Return details of a specific trade before it\'s placed
|
|
556
|
-
* @param {TradingApiGetCalculatedTradeImpactByIdRequest} requestParameters Request parameters.
|
|
557
|
-
* @param {*} [options] Override http request option.
|
|
558
|
-
* @throws {RequiredError}
|
|
559
|
-
* @memberof TradingApi
|
|
560
|
-
*/
|
|
561
|
-
getCalculatedTradeImpactById(requestParameters: TradingApiGetCalculatedTradeImpactByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Trade, any>>;
|
|
562
|
-
/**
|
|
563
|
-
*
|
|
564
|
-
* @summary Return the impact of placing a series of trades on the portfolio
|
|
565
|
-
* @param {TradingApiGetCalculatedTradesImpactRequest} requestParameters Request parameters.
|
|
566
|
-
* @param {*} [options] Override http request option.
|
|
567
|
-
* @throws {RequiredError}
|
|
568
|
-
* @memberof TradingApi
|
|
569
|
-
*/
|
|
570
|
-
getCalculatedTradesImpact(requestParameters: TradingApiGetCalculatedTradesImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TradeImpact[], any>>;
|
|
571
|
-
/**
|
|
572
|
-
*
|
|
573
|
-
* @summary Check impact of trades on account.
|
|
574
|
-
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
575
|
-
* @param {*} [options] Override http request option.
|
|
576
|
-
* @throws {RequiredError}
|
|
577
|
-
* @memberof TradingApi
|
|
578
|
-
*/
|
|
579
|
-
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
|
|
580
|
-
/**
|
|
581
|
-
*
|
|
582
|
-
* @summary Get symbol quotes
|
|
583
|
-
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
584
|
-
* @param {*} [options] Override http request option.
|
|
585
|
-
* @throws {RequiredError}
|
|
586
|
-
* @memberof TradingApi
|
|
587
|
-
*/
|
|
588
|
-
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
|
|
589
|
-
/**
|
|
590
|
-
*
|
|
591
|
-
* @summary Modify units of a trade before it is placed
|
|
592
|
-
* @param {TradingApiModifyCalculatedTradeByIdRequest} requestParameters Request parameters.
|
|
593
|
-
* @param {*} [options] Override http request option.
|
|
594
|
-
* @throws {RequiredError}
|
|
595
|
-
* @memberof TradingApi
|
|
596
|
-
*/
|
|
597
|
-
modifyCalculatedTradeById(requestParameters: TradingApiModifyCalculatedTradeByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Trade, any>>;
|
|
598
|
-
/**
|
|
599
|
-
*
|
|
600
|
-
* @summary Place orders for the CalculatedTrades in series
|
|
601
|
-
* @param {TradingApiPlaceCalculatedTradesRequest} requestParameters Request parameters.
|
|
602
|
-
* @param {*} [options] Override http request option.
|
|
603
|
-
* @throws {RequiredError}
|
|
604
|
-
* @memberof TradingApi
|
|
605
|
-
*/
|
|
606
|
-
placeCalculatedTrades(requestParameters: TradingApiPlaceCalculatedTradesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TradeExecutionStatus[], any>>;
|
|
607
|
-
/**
|
|
608
|
-
*
|
|
609
|
-
* @summary Place a trade with NO validation.
|
|
610
|
-
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
611
|
-
* @param {*} [options] Override http request option.
|
|
612
|
-
* @throws {RequiredError}
|
|
613
|
-
* @memberof TradingApi
|
|
614
|
-
*/
|
|
615
|
-
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @summary Place a OCO (One Cancels Other) order
|
|
619
|
-
* @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
|
|
620
|
-
* @param {*} [options] Override http request option.
|
|
621
|
-
* @throws {RequiredError}
|
|
622
|
-
* @memberof TradingApi
|
|
623
|
-
*/
|
|
624
|
-
placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
625
|
-
/**
|
|
626
|
-
*
|
|
627
|
-
* @summary Place order
|
|
628
|
-
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
629
|
-
* @param {*} [options] Override http request option.
|
|
630
|
-
* @throws {RequiredError}
|
|
631
|
-
* @memberof TradingApi
|
|
632
|
-
*/
|
|
633
|
-
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
634
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* SnapTrade
|
|
3
|
+
* Connect brokerage accounts to your app for live positions and trading
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: api@snaptrade.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This file is auto generated by Konfig (https://konfigthis.com).
|
|
9
|
+
* Do not edit the class manually.
|
|
10
|
+
*/
|
|
11
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
12
|
+
import { Configuration } from '../configuration';
|
|
13
|
+
import { RequestArgs } from '../base';
|
|
14
|
+
import { AccountOrderRecord } from '../models';
|
|
15
|
+
import { ManualTradeAndImpact } from '../models';
|
|
16
|
+
import { ManualTradeForm } from '../models';
|
|
17
|
+
import { SymbolsQuotesInner } from '../models';
|
|
18
|
+
import { TradingCancelUserAccountOrderRequest } from '../models';
|
|
19
|
+
import { TradingPlaceOCOOrderRequest } from '../models';
|
|
20
|
+
import { TradingApiCustom } from "./trading-api-custom";
|
|
21
|
+
/**
|
|
22
|
+
* TradingApi - axios parameter creator
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const TradingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @summary Cancel open order in account
|
|
29
|
+
* @param {string} userId
|
|
30
|
+
* @param {string} userSecret
|
|
31
|
+
* @param {string} accountId The ID of the account get positions.
|
|
32
|
+
* @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, tradingCancelUserAccountOrderRequest: TradingCancelUserAccountOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @summary Check impact of trades on account.
|
|
40
|
+
* @param {string} userId
|
|
41
|
+
* @param {string} userSecret
|
|
42
|
+
* @param {ManualTradeForm} manualTradeForm
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @summary Get symbol quotes
|
|
50
|
+
* @param {string} userId
|
|
51
|
+
* @param {string} userSecret
|
|
52
|
+
* @param {string} symbols List of universal_symbol_id or tickers to get quotes for.
|
|
53
|
+
* @param {string} accountId The ID of the account to get quotes.
|
|
54
|
+
* @param {boolean} [useTicker] Should be set to True if providing tickers.
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @summary Place a trade with NO validation.
|
|
62
|
+
* @param {string} userId
|
|
63
|
+
* @param {string} userSecret
|
|
64
|
+
* @param {ManualTradeForm} manualTradeForm
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
placeForceOrder: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @summary Place a OCO (One Cancels Other) order
|
|
72
|
+
* @param {string} userId
|
|
73
|
+
* @param {string} userSecret
|
|
74
|
+
* @param {TradingPlaceOCOOrderRequest} tradingPlaceOCOOrderRequest
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
placeOCOOrder: (userId: string, userSecret: string, tradingPlaceOCOOrderRequest: TradingPlaceOCOOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
/**
|
|
80
|
+
*
|
|
81
|
+
* @summary Place order
|
|
82
|
+
* @param {string} tradeId The ID of trade object obtained from trade/impact endpoint
|
|
83
|
+
* @param {string} userId
|
|
84
|
+
* @param {string} userSecret
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
*/
|
|
88
|
+
placeOrder: (tradeId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* TradingApi - functional programming interface
|
|
92
|
+
* @export
|
|
93
|
+
*/
|
|
94
|
+
export declare const TradingApiFp: (configuration?: Configuration) => {
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @summary Cancel open order in account
|
|
98
|
+
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
103
|
+
/**
|
|
104
|
+
*
|
|
105
|
+
* @summary Check impact of trades on account.
|
|
106
|
+
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @summary Get symbol quotes
|
|
114
|
+
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @summary Place a trade with NO validation.
|
|
122
|
+
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @summary Place a OCO (One Cancels Other) order
|
|
130
|
+
* @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @summary Place order
|
|
138
|
+
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* TradingApi - factory interface
|
|
146
|
+
* @export
|
|
147
|
+
*/
|
|
148
|
+
export declare const TradingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
149
|
+
/**
|
|
150
|
+
*
|
|
151
|
+
* @summary Cancel open order in account
|
|
152
|
+
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
157
|
+
/**
|
|
158
|
+
*
|
|
159
|
+
* @summary Check impact of trades on account.
|
|
160
|
+
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
161
|
+
* @param {*} [options] Override http request option.
|
|
162
|
+
* @throws {RequiredError}
|
|
163
|
+
*/
|
|
164
|
+
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @summary Get symbol quotes
|
|
168
|
+
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
|
|
173
|
+
/**
|
|
174
|
+
*
|
|
175
|
+
* @summary Place a trade with NO validation.
|
|
176
|
+
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
177
|
+
* @param {*} [options] Override http request option.
|
|
178
|
+
* @throws {RequiredError}
|
|
179
|
+
*/
|
|
180
|
+
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @summary Place a OCO (One Cancels Other) order
|
|
184
|
+
* @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @summary Place order
|
|
192
|
+
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* Request parameters for cancelUserAccountOrder operation in TradingApi.
|
|
200
|
+
* @export
|
|
201
|
+
* @interface TradingApiCancelUserAccountOrderRequest
|
|
202
|
+
*/
|
|
203
|
+
export type TradingApiCancelUserAccountOrderRequest = {
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {string}
|
|
207
|
+
* @memberof TradingApiCancelUserAccountOrder
|
|
208
|
+
*/
|
|
209
|
+
readonly userId: string;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @type {string}
|
|
213
|
+
* @memberof TradingApiCancelUserAccountOrder
|
|
214
|
+
*/
|
|
215
|
+
readonly userSecret: string;
|
|
216
|
+
/**
|
|
217
|
+
* The ID of the account get positions.
|
|
218
|
+
* @type {string}
|
|
219
|
+
* @memberof TradingApiCancelUserAccountOrder
|
|
220
|
+
*/
|
|
221
|
+
readonly accountId: string;
|
|
222
|
+
} & TradingCancelUserAccountOrderRequest;
|
|
223
|
+
/**
|
|
224
|
+
* Request parameters for getOrderImpact operation in TradingApi.
|
|
225
|
+
* @export
|
|
226
|
+
* @interface TradingApiGetOrderImpactRequest
|
|
227
|
+
*/
|
|
228
|
+
export type TradingApiGetOrderImpactRequest = {
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof TradingApiGetOrderImpact
|
|
233
|
+
*/
|
|
234
|
+
readonly userId: string;
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof TradingApiGetOrderImpact
|
|
239
|
+
*/
|
|
240
|
+
readonly userSecret: string;
|
|
241
|
+
} & ManualTradeForm;
|
|
242
|
+
/**
|
|
243
|
+
* Request parameters for getUserAccountQuotes operation in TradingApi.
|
|
244
|
+
* @export
|
|
245
|
+
* @interface TradingApiGetUserAccountQuotesRequest
|
|
246
|
+
*/
|
|
247
|
+
export type TradingApiGetUserAccountQuotesRequest = {
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof TradingApiGetUserAccountQuotes
|
|
252
|
+
*/
|
|
253
|
+
readonly userId: string;
|
|
254
|
+
/**
|
|
255
|
+
*
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof TradingApiGetUserAccountQuotes
|
|
258
|
+
*/
|
|
259
|
+
readonly userSecret: string;
|
|
260
|
+
/**
|
|
261
|
+
* List of universal_symbol_id or tickers to get quotes for.
|
|
262
|
+
* @type {string}
|
|
263
|
+
* @memberof TradingApiGetUserAccountQuotes
|
|
264
|
+
*/
|
|
265
|
+
readonly symbols: string;
|
|
266
|
+
/**
|
|
267
|
+
* The ID of the account to get quotes.
|
|
268
|
+
* @type {string}
|
|
269
|
+
* @memberof TradingApiGetUserAccountQuotes
|
|
270
|
+
*/
|
|
271
|
+
readonly accountId: string;
|
|
272
|
+
/**
|
|
273
|
+
* Should be set to True if providing tickers.
|
|
274
|
+
* @type {boolean}
|
|
275
|
+
* @memberof TradingApiGetUserAccountQuotes
|
|
276
|
+
*/
|
|
277
|
+
readonly useTicker?: boolean;
|
|
278
|
+
};
|
|
279
|
+
/**
|
|
280
|
+
* Request parameters for placeForceOrder operation in TradingApi.
|
|
281
|
+
* @export
|
|
282
|
+
* @interface TradingApiPlaceForceOrderRequest
|
|
283
|
+
*/
|
|
284
|
+
export type TradingApiPlaceForceOrderRequest = {
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof TradingApiPlaceForceOrder
|
|
289
|
+
*/
|
|
290
|
+
readonly userId: string;
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof TradingApiPlaceForceOrder
|
|
295
|
+
*/
|
|
296
|
+
readonly userSecret: string;
|
|
297
|
+
} & ManualTradeForm;
|
|
298
|
+
/**
|
|
299
|
+
* Request parameters for placeOCOOrder operation in TradingApi.
|
|
300
|
+
* @export
|
|
301
|
+
* @interface TradingApiPlaceOCOOrderRequest
|
|
302
|
+
*/
|
|
303
|
+
export type TradingApiPlaceOCOOrderRequest = {
|
|
304
|
+
/**
|
|
305
|
+
*
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof TradingApiPlaceOCOOrder
|
|
308
|
+
*/
|
|
309
|
+
readonly userId: string;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @type {string}
|
|
313
|
+
* @memberof TradingApiPlaceOCOOrder
|
|
314
|
+
*/
|
|
315
|
+
readonly userSecret: string;
|
|
316
|
+
} & TradingPlaceOCOOrderRequest;
|
|
317
|
+
/**
|
|
318
|
+
* Request parameters for placeOrder operation in TradingApi.
|
|
319
|
+
* @export
|
|
320
|
+
* @interface TradingApiPlaceOrderRequest
|
|
321
|
+
*/
|
|
322
|
+
export type TradingApiPlaceOrderRequest = {
|
|
323
|
+
/**
|
|
324
|
+
* The ID of trade object obtained from trade/impact endpoint
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof TradingApiPlaceOrder
|
|
327
|
+
*/
|
|
328
|
+
readonly tradeId: string;
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @type {string}
|
|
332
|
+
* @memberof TradingApiPlaceOrder
|
|
333
|
+
*/
|
|
334
|
+
readonly userId: string;
|
|
335
|
+
/**
|
|
336
|
+
*
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof TradingApiPlaceOrder
|
|
339
|
+
*/
|
|
340
|
+
readonly userSecret: string;
|
|
341
|
+
};
|
|
342
|
+
/**
|
|
343
|
+
* TradingApi - object-oriented interface
|
|
344
|
+
* @export
|
|
345
|
+
* @class TradingApi
|
|
346
|
+
* @extends {BaseAPI}
|
|
347
|
+
*/
|
|
348
|
+
export declare class TradingApi extends TradingApiCustom {
|
|
349
|
+
/**
|
|
350
|
+
*
|
|
351
|
+
* @summary Cancel open order in account
|
|
352
|
+
* @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
* @memberof TradingApi
|
|
356
|
+
*/
|
|
357
|
+
cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @summary Check impact of trades on account.
|
|
361
|
+
* @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
* @memberof TradingApi
|
|
365
|
+
*/
|
|
366
|
+
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
|
|
367
|
+
/**
|
|
368
|
+
*
|
|
369
|
+
* @summary Get symbol quotes
|
|
370
|
+
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
371
|
+
* @param {*} [options] Override http request option.
|
|
372
|
+
* @throws {RequiredError}
|
|
373
|
+
* @memberof TradingApi
|
|
374
|
+
*/
|
|
375
|
+
getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
|
|
376
|
+
/**
|
|
377
|
+
*
|
|
378
|
+
* @summary Place a trade with NO validation.
|
|
379
|
+
* @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
* @memberof TradingApi
|
|
383
|
+
*/
|
|
384
|
+
placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @summary Place a OCO (One Cancels Other) order
|
|
388
|
+
* @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
* @memberof TradingApi
|
|
392
|
+
*/
|
|
393
|
+
placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
394
|
+
/**
|
|
395
|
+
*
|
|
396
|
+
* @summary Place order
|
|
397
|
+
* @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
|
|
398
|
+
* @param {*} [options] Override http request option.
|
|
399
|
+
* @throws {RequiredError}
|
|
400
|
+
* @memberof TradingApi
|
|
401
|
+
*/
|
|
402
|
+
placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
|
|
403
|
+
}
|