snaptrade-typescript-sdk 9.0.171 → 9.0.173
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 +19 -18
- package/dist/api/options-api-generated.d.ts +12 -5
- package/dist/api/options-api-generated.js +12 -8
- package/dist/api/trading-api-generated.d.ts +4 -4
- package/dist/api/trading-api-generated.js +4 -4
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account-order-record-quote-universal-symbol.d.ts +1 -1
- package/dist/models/account-order-record-universal-symbol.d.ts +1 -1
- package/dist/models/account.d.ts +1 -1
- package/dist/models/crypto-order-form.d.ts +4 -4
- package/dist/models/mleg-price-effect-strict.d.ts +1 -1
- package/dist/models/mleg-trade-form.d.ts +2 -2
- package/dist/models/option-impact.d.ts +13 -5
- package/dist/models/position-symbol.d.ts +3 -3
- package/dist/models/security-type.d.ts +1 -1
- package/dist/models/simple-order-form.d.ts +4 -4
- package/dist/models/underlying-symbol-type.d.ts +1 -1
- package/dist/models/underlying-symbol.d.ts +1 -1
- package/dist/models/universal-symbol.d.ts +1 -1
- package/dist/operationParameterMap.js +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Connect brokerage accounts to your app for live positions and trading
|
|
8
8
|
|
|
9
|
-
[](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.173)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -1438,9 +1438,7 @@ Defaults to true. Indicates if request should fetch only executed orders. Set to
|
|
|
1438
1438
|
|
|
1439
1439
|
### `snaptrade.options.getOptionQuote`<a id="snaptradeoptionsgetoptionquote"></a>
|
|
1440
1440
|
|
|
1441
|
-
Returns a real-time quote for a single option contract. The option contract is specified using
|
|
1442
|
-
|
|
1443
|
-
OCC format: `AAPL 251219C00150000` (underlying padded to 6 characters with spaces, followed by date, put/call, and strike).
|
|
1441
|
+
Returns a real-time 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)
|
|
1444
1442
|
|
|
1445
1443
|
|
|
1446
1444
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -1449,6 +1447,7 @@ OCC format: `AAPL 251219C00150000` (underlying padded to 6 characters with spac
|
|
|
1449
1447
|
const getOptionQuoteResponse = await snaptrade.options.getOptionQuote({
|
|
1450
1448
|
userId: "snaptrade-user-123",
|
|
1451
1449
|
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1450
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1452
1451
|
symbol: "AAPL 251219C00150000",
|
|
1453
1452
|
});
|
|
1454
1453
|
```
|
|
@@ -1459,6 +1458,8 @@ const getOptionQuoteResponse = await snaptrade.options.getOptionQuote({
|
|
|
1459
1458
|
|
|
1460
1459
|
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1461
1460
|
|
|
1461
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
1462
|
+
|
|
1462
1463
|
##### symbol: `string`<a id="symbol-string"></a>
|
|
1463
1464
|
|
|
1464
1465
|
The OCC-formatted option symbol.
|
|
@@ -1469,7 +1470,7 @@ The OCC-formatted option symbol.
|
|
|
1469
1470
|
|
|
1470
1471
|
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1471
1472
|
|
|
1472
|
-
`/
|
|
1473
|
+
`/accounts/{accountId}/quotes/options` `GET`
|
|
1473
1474
|
|
|
1474
1475
|
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1475
1476
|
|
|
@@ -1992,7 +1993,7 @@ const getCryptocurrencyPairQuoteResponse =
|
|
|
1992
1993
|
### `snaptrade.trading.getOptionImpact`<a id="snaptradetradinggetoptionimpact"></a>
|
|
1993
1994
|
|
|
1994
1995
|
Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it.
|
|
1995
|
-
Only supported for certain brokerages. Please refer to https://
|
|
1996
|
+
Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
1996
1997
|
|
|
1997
1998
|
|
|
1998
1999
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -2040,11 +2041,11 @@ The Time in Force type for the order. This field indicates how long the order wi
|
|
|
2040
2041
|
|
|
2041
2042
|
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
2042
2043
|
|
|
2043
|
-
The limit price. Required if the order type is LIMIT
|
|
2044
|
+
The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
|
|
2044
2045
|
|
|
2045
2046
|
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
2046
2047
|
|
|
2047
|
-
The stop price. Required if the order type is STOP_LOSS_MARKET
|
|
2048
|
+
The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
|
|
2048
2049
|
|
|
2049
2050
|
##### price_effect: [`MlegPriceEffectStrict`](./models/mleg-price-effect-strict.ts)<a id="price_effect-mlegpriceeffectstrictmodelsmleg-price-effect-strictts"></a>
|
|
2050
2051
|
|
|
@@ -2329,19 +2330,19 @@ The amount of the base currency to buy or sell.
|
|
|
2329
2330
|
|
|
2330
2331
|
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
2331
2332
|
|
|
2332
|
-
The limit price. Required if the order type is LIMIT
|
|
2333
|
+
The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
|
|
2333
2334
|
|
|
2334
2335
|
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
2335
2336
|
|
|
2336
|
-
The stop price. Required if the order type is STOP_LOSS_MARKET
|
|
2337
|
+
The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
|
|
2337
2338
|
|
|
2338
2339
|
##### post_only: `boolean`<a id="post_only-boolean"></a>
|
|
2339
2340
|
|
|
2340
|
-
Valid and required only for order type LIMIT
|
|
2341
|
+
Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
|
|
2341
2342
|
|
|
2342
2343
|
##### expiration_date: `string`<a id="expiration_date-string"></a>
|
|
2343
2344
|
|
|
2344
|
-
The expiration date of the order. Required if the time_in_force is GTD
|
|
2345
|
+
The expiration date of the order. Required if the time_in_force is `GTD`.
|
|
2345
2346
|
|
|
2346
2347
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
2347
2348
|
|
|
@@ -2495,11 +2496,11 @@ The Time in Force type for the order. This field indicates how long the order wi
|
|
|
2495
2496
|
|
|
2496
2497
|
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
2497
2498
|
|
|
2498
|
-
The limit price. Required if the order type is LIMIT
|
|
2499
|
+
The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT`.
|
|
2499
2500
|
|
|
2500
2501
|
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
2501
2502
|
|
|
2502
|
-
The stop price. Required if the order type is STOP_LOSS_MARKET
|
|
2503
|
+
The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`.
|
|
2503
2504
|
|
|
2504
2505
|
##### price_effect: [`MlegPriceEffectStrict`](./models/mleg-price-effect-strict.ts)<a id="price_effect-mlegpriceeffectstrictmodelsmleg-price-effect-strictts"></a>
|
|
2505
2506
|
|
|
@@ -2616,19 +2617,19 @@ The amount of the base currency to buy or sell.
|
|
|
2616
2617
|
|
|
2617
2618
|
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
2618
2619
|
|
|
2619
|
-
The limit price. Required if the order type is LIMIT
|
|
2620
|
+
The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
|
|
2620
2621
|
|
|
2621
2622
|
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
2622
2623
|
|
|
2623
|
-
The stop price. Required if the order type is STOP_LOSS_MARKET
|
|
2624
|
+
The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
|
|
2624
2625
|
|
|
2625
2626
|
##### post_only: `boolean`<a id="post_only-boolean"></a>
|
|
2626
2627
|
|
|
2627
|
-
Valid and required only for order type LIMIT
|
|
2628
|
+
Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
|
|
2628
2629
|
|
|
2629
2630
|
##### expiration_date: `string`<a id="expiration_date-string"></a>
|
|
2630
2631
|
|
|
2631
|
-
The expiration date of the order. Required if the time_in_force is GTD
|
|
2632
|
+
The expiration date of the order. Required if the time_in_force is `GTD`.
|
|
2632
2633
|
|
|
2633
2634
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
2634
2635
|
|
|
@@ -9,15 +9,16 @@ import { OptionsPosition } from '../models';
|
|
|
9
9
|
*/
|
|
10
10
|
export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
11
11
|
/**
|
|
12
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
12
|
+
* Returns a real-time 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)
|
|
13
13
|
* @summary Get option quote
|
|
14
14
|
* @param {string} userId
|
|
15
15
|
* @param {string} userSecret
|
|
16
|
+
* @param {string} accountId
|
|
16
17
|
* @param {string} symbol The OCC-formatted option symbol.
|
|
17
18
|
* @param {*} [options] Override http request option.
|
|
18
19
|
* @throws {RequiredError}
|
|
19
20
|
*/
|
|
20
|
-
getOptionQuote: (userId: string, userSecret: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21
|
+
getOptionQuote: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
21
22
|
/**
|
|
22
23
|
* Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions). Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
|
|
23
24
|
* @summary List account option positions
|
|
@@ -35,7 +36,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35
36
|
*/
|
|
36
37
|
export declare const OptionsApiFp: (configuration?: Configuration) => {
|
|
37
38
|
/**
|
|
38
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
39
|
+
* Returns a real-time 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)
|
|
39
40
|
* @summary Get option quote
|
|
40
41
|
* @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
|
|
41
42
|
* @param {*} [options] Override http request option.
|
|
@@ -57,7 +58,7 @@ export declare const OptionsApiFp: (configuration?: Configuration) => {
|
|
|
57
58
|
*/
|
|
58
59
|
export declare const OptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
59
60
|
/**
|
|
60
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
61
|
+
* Returns a real-time 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)
|
|
61
62
|
* @summary Get option quote
|
|
62
63
|
* @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
|
|
63
64
|
* @param {*} [options] Override http request option.
|
|
@@ -92,6 +93,12 @@ export type OptionsApiGetOptionQuoteRequest = {
|
|
|
92
93
|
*/
|
|
93
94
|
readonly userSecret: string;
|
|
94
95
|
/**
|
|
96
|
+
*
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof OptionsApiGetOptionQuote
|
|
99
|
+
*/
|
|
100
|
+
readonly accountId: string;
|
|
101
|
+
/**
|
|
95
102
|
* The OCC-formatted option symbol.
|
|
96
103
|
* @type {string}
|
|
97
104
|
* @memberof OptionsApiGetOptionQuote
|
|
@@ -131,7 +138,7 @@ export type OptionsApiListOptionHoldingsRequest = {
|
|
|
131
138
|
*/
|
|
132
139
|
export declare class OptionsApiGenerated extends BaseAPI {
|
|
133
140
|
/**
|
|
134
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
141
|
+
* Returns a real-time 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)
|
|
135
142
|
* @summary Get option quote
|
|
136
143
|
* @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
|
|
137
144
|
* @param {*} [options] Override http request option.
|
|
@@ -36,22 +36,26 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
|
|
|
36
36
|
const OptionsApiAxiosParamCreator = function (configuration) {
|
|
37
37
|
return {
|
|
38
38
|
/**
|
|
39
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
39
|
+
* Returns a real-time 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)
|
|
40
40
|
* @summary Get option quote
|
|
41
41
|
* @param {string} userId
|
|
42
42
|
* @param {string} userSecret
|
|
43
|
+
* @param {string} accountId
|
|
43
44
|
* @param {string} symbol The OCC-formatted option symbol.
|
|
44
45
|
* @param {*} [options] Override http request option.
|
|
45
46
|
* @throws {RequiredError}
|
|
46
47
|
*/
|
|
47
|
-
getOptionQuote: (userId, userSecret, symbol, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
48
|
+
getOptionQuote: (userId, userSecret, accountId, symbol, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
48
49
|
// verify required parameter 'userId' is not null or undefined
|
|
49
50
|
(0, common_1.assertParamExists)('getOptionQuote', 'userId', userId);
|
|
50
51
|
// verify required parameter 'userSecret' is not null or undefined
|
|
51
52
|
(0, common_1.assertParamExists)('getOptionQuote', 'userSecret', userSecret);
|
|
53
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
54
|
+
(0, common_1.assertParamExists)('getOptionQuote', 'accountId', accountId);
|
|
52
55
|
// verify required parameter 'symbol' is not null or undefined
|
|
53
56
|
(0, common_1.assertParamExists)('getOptionQuote', 'symbol', symbol);
|
|
54
|
-
const localVarPath = `/
|
|
57
|
+
const localVarPath = `/accounts/{accountId}/quotes/options`
|
|
58
|
+
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
|
|
55
59
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56
60
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
57
61
|
let baseOptions;
|
|
@@ -83,7 +87,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
|
|
|
83
87
|
requestConfig: localVarRequestOptions,
|
|
84
88
|
path: localVarPath,
|
|
85
89
|
configuration,
|
|
86
|
-
pathTemplate: '/
|
|
90
|
+
pathTemplate: '/accounts/{accountId}/quotes/options',
|
|
87
91
|
httpMethod: 'GET'
|
|
88
92
|
});
|
|
89
93
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -158,7 +162,7 @@ const OptionsApiFp = function (configuration) {
|
|
|
158
162
|
const localVarAxiosParamCreator = (0, exports.OptionsApiAxiosParamCreator)(configuration);
|
|
159
163
|
return {
|
|
160
164
|
/**
|
|
161
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
165
|
+
* Returns a real-time 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)
|
|
162
166
|
* @summary Get option quote
|
|
163
167
|
* @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
|
|
164
168
|
* @param {*} [options] Override http request option.
|
|
@@ -166,7 +170,7 @@ const OptionsApiFp = function (configuration) {
|
|
|
166
170
|
*/
|
|
167
171
|
getOptionQuote(requestParameters, options) {
|
|
168
172
|
return __awaiter(this, void 0, void 0, function* () {
|
|
169
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionQuote(requestParameters.userId, requestParameters.userSecret, requestParameters.symbol, options);
|
|
173
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionQuote(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.symbol, options);
|
|
170
174
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
171
175
|
});
|
|
172
176
|
},
|
|
@@ -194,7 +198,7 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
|
|
|
194
198
|
const localVarFp = (0, exports.OptionsApiFp)(configuration);
|
|
195
199
|
return {
|
|
196
200
|
/**
|
|
197
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
201
|
+
* Returns a real-time 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)
|
|
198
202
|
* @summary Get option quote
|
|
199
203
|
* @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
|
|
200
204
|
* @param {*} [options] Override http request option.
|
|
@@ -224,7 +228,7 @@ exports.OptionsApiFactory = OptionsApiFactory;
|
|
|
224
228
|
*/
|
|
225
229
|
class OptionsApiGenerated extends base_1.BaseAPI {
|
|
226
230
|
/**
|
|
227
|
-
* Returns a real-time quote for a single option contract. The option contract is specified using
|
|
231
|
+
* Returns a real-time 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)
|
|
228
232
|
* @summary Get option quote
|
|
229
233
|
* @param {OptionsApiGetOptionQuoteRequest} requestParameters Request parameters.
|
|
230
234
|
* @param {*} [options] Override http request option.
|
|
@@ -59,7 +59,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
59
59
|
*/
|
|
60
60
|
getCryptocurrencyPairQuote: (userId: string, userSecret: string, accountId: string, instrumentSymbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
61
|
/**
|
|
62
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
62
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
63
63
|
* @summary Get option order impact
|
|
64
64
|
* @param {string} userId
|
|
65
65
|
* @param {string} userSecret
|
|
@@ -211,7 +211,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
|
|
|
211
211
|
*/
|
|
212
212
|
getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CryptocurrencyPairQuote>>;
|
|
213
213
|
/**
|
|
214
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
214
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
215
215
|
* @summary Get option order impact
|
|
216
216
|
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
217
217
|
* @param {*} [options] Override http request option.
|
|
@@ -330,7 +330,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
|
|
|
330
330
|
*/
|
|
331
331
|
getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<CryptocurrencyPairQuote>;
|
|
332
332
|
/**
|
|
333
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
333
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
334
334
|
* @summary Get option order impact
|
|
335
335
|
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
336
336
|
* @param {*} [options] Override http request option.
|
|
@@ -822,7 +822,7 @@ export declare class TradingApiGenerated extends BaseAPI {
|
|
|
822
822
|
*/
|
|
823
823
|
getCryptocurrencyPairQuote(requestParameters: TradingApiGetCryptocurrencyPairQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptocurrencyPairQuote, any>>;
|
|
824
824
|
/**
|
|
825
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
825
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
826
826
|
* @summary Get option order impact
|
|
827
827
|
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
828
828
|
* @param {*} [options] Override http request option.
|
|
@@ -218,7 +218,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
|
|
|
218
218
|
};
|
|
219
219
|
}),
|
|
220
220
|
/**
|
|
221
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
221
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
222
222
|
* @summary Get option order impact
|
|
223
223
|
* @param {string} userId
|
|
224
224
|
* @param {string} userSecret
|
|
@@ -941,7 +941,7 @@ const TradingApiFp = function (configuration) {
|
|
|
941
941
|
});
|
|
942
942
|
},
|
|
943
943
|
/**
|
|
944
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
944
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
945
945
|
* @summary Get option order impact
|
|
946
946
|
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
947
947
|
* @param {*} [options] Override http request option.
|
|
@@ -1211,7 +1211,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
|
|
|
1211
1211
|
return localVarFp.getCryptocurrencyPairQuote(requestParameters, options).then((request) => request(axios, basePath));
|
|
1212
1212
|
},
|
|
1213
1213
|
/**
|
|
1214
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
1214
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
1215
1215
|
* @summary Get option order impact
|
|
1216
1216
|
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
1217
1217
|
* @param {*} [options] Override http request option.
|
|
@@ -1365,7 +1365,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
|
|
|
1365
1365
|
return (0, exports.TradingApiFp)(this.configuration).getCryptocurrencyPairQuote(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1366
1366
|
}
|
|
1367
1367
|
/**
|
|
1368
|
-
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to https://
|
|
1368
|
+
* Simulates an option order with up to 4 legs and returns the estimated cost and transaction fees without placing it. Only supported for certain brokerages. Please refer to the [brokerage trading support page](https://snaptrade.notion.site/brokerages) for more information on which brokerages support this endpoint.
|
|
1369
1369
|
* @summary Get option order impact
|
|
1370
1370
|
* @param {TradingApiGetOptionImpactRequest} requestParameters Request parameters.
|
|
1371
1371
|
* @param {*} [options] Override http request option.
|