snaptrade-typescript-sdk 9.0.90 → 9.0.91
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 +293 -301
- package/dist/api/trading-api-generated.d.ts +335 -0
- package/dist/api/trading-api-generated.js +495 -0
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/browser.js +1 -1
- package/dist/client.d.ts +1 -2
- package/dist/client.js +0 -1
- package/dist/configuration.js +1 -1
- package/dist/models/{crypto-spot-quote.d.ts → cryptocurrency-pair-quote.d.ts} +6 -6
- package/dist/models/cryptocurrency-pair.d.ts +7 -1
- package/dist/models/index.d.ts +5 -6
- package/dist/models/index.js +5 -6
- package/dist/models/{crypto-spot-order-preview-estimated-fee.d.ts → simple-order-preview-estimated-fee.d.ts} +4 -4
- package/dist/models/simple-order-preview.d.ts +15 -0
- package/dist/models/{trading-crypto-spot-place-order-request.d.ts → trading-place-simple-order-request.d.ts} +18 -18
- package/dist/models/{trading-crypto-spot-symbols200-response.d.ts → trading-search-cryptocurrency-pair-instruments200-response.d.ts} +3 -3
- package/dist/operationParameterMap.js +131 -134
- package/package.json +1 -1
- package/dist/api/crypto-spot-trading-api-generated.d.ts +0 -366
- package/dist/api/crypto-spot-trading-api-generated.js +0 -577
- package/dist/api/crypto-spot-trading-api.d.ts +0 -4
- package/dist/api/crypto-spot-trading-api.js +0 -22
- package/dist/models/crypto-spot-order-preview.d.ts +0 -15
- package/dist/models/trading-crypto-spot-cancel-order-request.d.ts +0 -13
- package/dist/models/trading-crypto-spot-symbols200-response.js +0 -2
- /package/dist/models/{crypto-spot-order-preview-estimated-fee.js → cryptocurrency-pair-quote.js} +0 -0
- /package/dist/models/{crypto-spot-order-preview.js → simple-order-preview-estimated-fee.js} +0 -0
- /package/dist/models/{crypto-spot-quote.js → simple-order-preview.js} +0 -0
- /package/dist/models/{trading-crypto-spot-cancel-order-request.js → trading-place-simple-order-request.js} +0 -0
- /package/dist/models/{trading-crypto-spot-place-order-request.js → trading-search-cryptocurrency-pair-instruments200-response.js} +0 -0
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.91)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -42,11 +42,6 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
42
42
|
* [`snaptrade.connections.removeBrokerageAuthorization`](#snaptradeconnectionsremovebrokerageauthorization)
|
|
43
43
|
* [`snaptrade.connections.returnRates`](#snaptradeconnectionsreturnrates)
|
|
44
44
|
* [`snaptrade.connections.sessionEvents`](#snaptradeconnectionssessionevents)
|
|
45
|
-
* [`snaptrade.cryptoSpotTrading.cryptoSpotCancelOrder`](#snaptradecryptospottradingcryptospotcancelorder)
|
|
46
|
-
* [`snaptrade.cryptoSpotTrading.cryptoSpotPlaceOrder`](#snaptradecryptospottradingcryptospotplaceorder)
|
|
47
|
-
* [`snaptrade.cryptoSpotTrading.cryptoSpotPreviewOrder`](#snaptradecryptospottradingcryptospotprevieworder)
|
|
48
|
-
* [`snaptrade.cryptoSpotTrading.cryptoSpotQuote`](#snaptradecryptospottradingcryptospotquote)
|
|
49
|
-
* [`snaptrade.cryptoSpotTrading.cryptoSpotSymbols`](#snaptradecryptospottradingcryptospotsymbols)
|
|
50
45
|
* [`snaptrade.options.getOptionStrategy`](#snaptradeoptionsgetoptionstrategy)
|
|
51
46
|
* [`snaptrade.options.getOptionsChain`](#snaptradeoptionsgetoptionschain)
|
|
52
47
|
* [`snaptrade.options.getOptionsStrategyQuote`](#snaptradeoptionsgetoptionsstrategyquote)
|
|
@@ -63,13 +58,18 @@ Connect brokerage accounts to your app for live positions and trading
|
|
|
63
58
|
* [`snaptrade.referenceData.listAllCurrencies`](#snaptradereferencedatalistallcurrencies)
|
|
64
59
|
* [`snaptrade.referenceData.listAllCurrenciesRates`](#snaptradereferencedatalistallcurrenciesrates)
|
|
65
60
|
* [`snaptrade.referenceData.symbolSearchUserAccount`](#snaptradereferencedatasymbolsearchuseraccount)
|
|
61
|
+
* [`snaptrade.trading.cancelOrder`](#snaptradetradingcancelorder)
|
|
66
62
|
* [`snaptrade.trading.cancelUserAccountOrder`](#snaptradetradingcanceluseraccountorder)
|
|
63
|
+
* [`snaptrade.trading.getCryptocurrencyPairQuote`](#snaptradetradinggetcryptocurrencypairquote)
|
|
67
64
|
* [`snaptrade.trading.getOrderImpact`](#snaptradetradinggetorderimpact)
|
|
68
65
|
* [`snaptrade.trading.getUserAccountQuotes`](#snaptradetradinggetuseraccountquotes)
|
|
69
66
|
* [`snaptrade.trading.placeBracketOrder`](#snaptradetradingplacebracketorder)
|
|
70
67
|
* [`snaptrade.trading.placeForceOrder`](#snaptradetradingplaceforceorder)
|
|
71
68
|
* [`snaptrade.trading.placeOrder`](#snaptradetradingplaceorder)
|
|
69
|
+
* [`snaptrade.trading.placeSimpleOrder`](#snaptradetradingplacesimpleorder)
|
|
70
|
+
* [`snaptrade.trading.previewSimpleOrder`](#snaptradetradingpreviewsimpleorder)
|
|
72
71
|
* [`snaptrade.trading.replaceOrder`](#snaptradetradingreplaceorder)
|
|
72
|
+
* [`snaptrade.trading.searchCryptocurrencyPairInstruments`](#snaptradetradingsearchcryptocurrencypairinstruments)
|
|
73
73
|
* [`snaptrade.transactionsAndReporting.getActivities`](#snaptradetransactionsandreportinggetactivities)
|
|
74
74
|
* [`snaptrade.transactionsAndReporting.getReportingCustomRange`](#snaptradetransactionsandreportinggetreportingcustomrange)
|
|
75
75
|
|
|
@@ -1132,301 +1132,6 @@ Optional comma separated list of session IDs used to filter the request on speci
|
|
|
1132
1132
|
---
|
|
1133
1133
|
|
|
1134
1134
|
|
|
1135
|
-
### `snaptrade.cryptoSpotTrading.cryptoSpotCancelOrder`<a id="snaptradecryptospottradingcryptospotcancelorder"></a>
|
|
1136
|
-
|
|
1137
|
-
Cancels a cryptocurrency spot order in the specified account.
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1141
|
-
|
|
1142
|
-
```typescript
|
|
1143
|
-
const cryptoSpotCancelOrderResponse =
|
|
1144
|
-
await snaptrade.cryptoSpotTrading.cryptoSpotCancelOrder({
|
|
1145
|
-
userId: "snaptrade-user-123",
|
|
1146
|
-
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1147
|
-
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1148
|
-
brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
|
|
1149
|
-
});
|
|
1150
|
-
```
|
|
1151
|
-
|
|
1152
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1153
|
-
|
|
1154
|
-
##### brokerage_order_id: `string`<a id="brokerage_order_id-string"></a>
|
|
1155
|
-
|
|
1156
|
-
Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
|
|
1157
|
-
|
|
1158
|
-
##### userId: `string`<a id="userid-string"></a>
|
|
1159
|
-
|
|
1160
|
-
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1161
|
-
|
|
1162
|
-
##### accountId: `string`<a id="accountid-string"></a>
|
|
1163
|
-
|
|
1164
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
|
1165
|
-
|
|
1166
|
-
[OrderUpdatedResponse](./models/order-updated-response.ts)
|
|
1167
|
-
|
|
1168
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1169
|
-
|
|
1170
|
-
`/accounts/{accountId}/trading/crypto/spot/cancelOrder` `POST`
|
|
1171
|
-
|
|
1172
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1173
|
-
|
|
1174
|
-
---
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
### `snaptrade.cryptoSpotTrading.cryptoSpotPlaceOrder`<a id="snaptradecryptospottradingcryptospotplaceorder"></a>
|
|
1178
|
-
|
|
1179
|
-
Places a spot cryptocurrency order in the specified account.
|
|
1180
|
-
This endpoint does not compute the impact to the account balance from the order before submitting the order to the exchange.
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1184
|
-
|
|
1185
|
-
```typescript
|
|
1186
|
-
const cryptoSpotPlaceOrderResponse =
|
|
1187
|
-
await snaptrade.cryptoSpotTrading.cryptoSpotPlaceOrder({
|
|
1188
|
-
userId: "snaptrade-user-123",
|
|
1189
|
-
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1190
|
-
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1191
|
-
symbol: {
|
|
1192
|
-
base: "BTC",
|
|
1193
|
-
quote: "USD",
|
|
1194
|
-
},
|
|
1195
|
-
side: "BUY",
|
|
1196
|
-
type: "MARKET",
|
|
1197
|
-
time_in_force: "GTC",
|
|
1198
|
-
amount: "123.45",
|
|
1199
|
-
limit_price: "123.45",
|
|
1200
|
-
stop_price: "123.45",
|
|
1201
|
-
post_only: false,
|
|
1202
|
-
expiration_date: "2024-01-01T00:00:00Z",
|
|
1203
|
-
});
|
|
1204
|
-
```
|
|
1205
|
-
|
|
1206
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1207
|
-
|
|
1208
|
-
##### symbol: [`CryptocurrencyPair`](./models/cryptocurrency-pair.ts)<a id="symbol-cryptocurrencypairmodelscryptocurrency-pairts"></a>
|
|
1209
|
-
|
|
1210
|
-
##### side: [`ActionStrict`](./models/action-strict.ts)<a id="side-actionstrictmodelsaction-strictts"></a>
|
|
1211
|
-
|
|
1212
|
-
The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
|
|
1213
|
-
|
|
1214
|
-
##### type: `string`<a id="type-string"></a>
|
|
1215
|
-
|
|
1216
|
-
The type of order to place.
|
|
1217
|
-
|
|
1218
|
-
##### time_in_force: `string`<a id="time_in_force-string"></a>
|
|
1219
|
-
|
|
1220
|
-
The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date.
|
|
1221
|
-
|
|
1222
|
-
##### amount: `string`<a id="amount-string"></a>
|
|
1223
|
-
|
|
1224
|
-
The amount of the base currency to buy or sell.
|
|
1225
|
-
|
|
1226
|
-
##### userId: `string`<a id="userid-string"></a>
|
|
1227
|
-
|
|
1228
|
-
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1229
|
-
|
|
1230
|
-
##### accountId: `string`<a id="accountid-string"></a>
|
|
1231
|
-
|
|
1232
|
-
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
1233
|
-
|
|
1234
|
-
The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
|
|
1235
|
-
|
|
1236
|
-
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
1237
|
-
|
|
1238
|
-
The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
|
|
1239
|
-
|
|
1240
|
-
##### post_only: `boolean`<a id="post_only-boolean"></a>
|
|
1241
|
-
|
|
1242
|
-
Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
|
|
1243
|
-
|
|
1244
|
-
##### expiration_date: `string`<a id="expiration_date-string"></a>
|
|
1245
|
-
|
|
1246
|
-
The expiration date of the order. Required if the time_in_force is GTD.
|
|
1247
|
-
|
|
1248
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
|
1249
|
-
|
|
1250
|
-
[OrderUpdatedResponse](./models/order-updated-response.ts)
|
|
1251
|
-
|
|
1252
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1253
|
-
|
|
1254
|
-
`/accounts/{accountId}/trading/crypto/spot/placeOrder` `POST`
|
|
1255
|
-
|
|
1256
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1257
|
-
|
|
1258
|
-
---
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
### `snaptrade.cryptoSpotTrading.cryptoSpotPreviewOrder`<a id="snaptradecryptospottradingcryptospotprevieworder"></a>
|
|
1262
|
-
|
|
1263
|
-
Previews a cryptocurrency spot order using the specified account.
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1267
|
-
|
|
1268
|
-
```typescript
|
|
1269
|
-
const cryptoSpotPreviewOrderResponse =
|
|
1270
|
-
await snaptrade.cryptoSpotTrading.cryptoSpotPreviewOrder({
|
|
1271
|
-
userId: "snaptrade-user-123",
|
|
1272
|
-
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1273
|
-
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1274
|
-
symbol: {
|
|
1275
|
-
base: "BTC",
|
|
1276
|
-
quote: "USD",
|
|
1277
|
-
},
|
|
1278
|
-
side: "BUY",
|
|
1279
|
-
type: "MARKET",
|
|
1280
|
-
time_in_force: "GTC",
|
|
1281
|
-
amount: "123.45",
|
|
1282
|
-
limit_price: "123.45",
|
|
1283
|
-
stop_price: "123.45",
|
|
1284
|
-
post_only: false,
|
|
1285
|
-
expiration_date: "2024-01-01T00:00:00Z",
|
|
1286
|
-
});
|
|
1287
|
-
```
|
|
1288
|
-
|
|
1289
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1290
|
-
|
|
1291
|
-
##### symbol: [`CryptocurrencyPair`](./models/cryptocurrency-pair.ts)<a id="symbol-cryptocurrencypairmodelscryptocurrency-pairts"></a>
|
|
1292
|
-
|
|
1293
|
-
##### side: [`ActionStrict`](./models/action-strict.ts)<a id="side-actionstrictmodelsaction-strictts"></a>
|
|
1294
|
-
|
|
1295
|
-
The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
|
|
1296
|
-
|
|
1297
|
-
##### type: `string`<a id="type-string"></a>
|
|
1298
|
-
|
|
1299
|
-
The type of order to place.
|
|
1300
|
-
|
|
1301
|
-
##### time_in_force: `string`<a id="time_in_force-string"></a>
|
|
1302
|
-
|
|
1303
|
-
The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date.
|
|
1304
|
-
|
|
1305
|
-
##### amount: `string`<a id="amount-string"></a>
|
|
1306
|
-
|
|
1307
|
-
The amount of the base currency to buy or sell.
|
|
1308
|
-
|
|
1309
|
-
##### userId: `string`<a id="userid-string"></a>
|
|
1310
|
-
|
|
1311
|
-
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1312
|
-
|
|
1313
|
-
##### accountId: `string`<a id="accountid-string"></a>
|
|
1314
|
-
|
|
1315
|
-
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
1316
|
-
|
|
1317
|
-
The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
|
|
1318
|
-
|
|
1319
|
-
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
1320
|
-
|
|
1321
|
-
The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
|
|
1322
|
-
|
|
1323
|
-
##### post_only: `boolean`<a id="post_only-boolean"></a>
|
|
1324
|
-
|
|
1325
|
-
Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
|
|
1326
|
-
|
|
1327
|
-
##### expiration_date: `string`<a id="expiration_date-string"></a>
|
|
1328
|
-
|
|
1329
|
-
The expiration date of the order. Required if the time_in_force is GTD.
|
|
1330
|
-
|
|
1331
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
|
1332
|
-
|
|
1333
|
-
[CryptoSpotOrderPreview](./models/crypto-spot-order-preview.ts)
|
|
1334
|
-
|
|
1335
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1336
|
-
|
|
1337
|
-
`/accounts/{accountId}/trading/crypto/spot/previewOrder` `POST`
|
|
1338
|
-
|
|
1339
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1340
|
-
|
|
1341
|
-
---
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
### `snaptrade.cryptoSpotTrading.cryptoSpotQuote`<a id="snaptradecryptospottradingcryptospotquote"></a>
|
|
1345
|
-
|
|
1346
|
-
Gets a quote for the specified account.
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1350
|
-
|
|
1351
|
-
```typescript
|
|
1352
|
-
const cryptoSpotQuoteResponse =
|
|
1353
|
-
await snaptrade.cryptoSpotTrading.cryptoSpotQuote({
|
|
1354
|
-
userId: "snaptrade-user-123",
|
|
1355
|
-
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1356
|
-
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1357
|
-
base: "BTC",
|
|
1358
|
-
quote: "USD",
|
|
1359
|
-
});
|
|
1360
|
-
```
|
|
1361
|
-
|
|
1362
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1363
|
-
|
|
1364
|
-
##### userId: `string`<a id="userid-string"></a>
|
|
1365
|
-
|
|
1366
|
-
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1367
|
-
|
|
1368
|
-
##### accountId: `string`<a id="accountid-string"></a>
|
|
1369
|
-
|
|
1370
|
-
##### base: `string`<a id="base-string"></a>
|
|
1371
|
-
|
|
1372
|
-
##### quote: `string`<a id="quote-string"></a>
|
|
1373
|
-
|
|
1374
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
|
1375
|
-
|
|
1376
|
-
[CryptoSpotQuote](./models/crypto-spot-quote.ts)
|
|
1377
|
-
|
|
1378
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1379
|
-
|
|
1380
|
-
`/accounts/{accountId}/trading/crypto/spot/quote` `GET`
|
|
1381
|
-
|
|
1382
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1383
|
-
|
|
1384
|
-
---
|
|
1385
|
-
|
|
1386
|
-
|
|
1387
|
-
### `snaptrade.cryptoSpotTrading.cryptoSpotSymbols`<a id="snaptradecryptospottradingcryptospotsymbols"></a>
|
|
1388
|
-
|
|
1389
|
-
Searches cryptocurrency spot symbols accessible to the specified account.
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1393
|
-
|
|
1394
|
-
```typescript
|
|
1395
|
-
const cryptoSpotSymbolsResponse =
|
|
1396
|
-
await snaptrade.cryptoSpotTrading.cryptoSpotSymbols({
|
|
1397
|
-
userId: "snaptrade-user-123",
|
|
1398
|
-
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1399
|
-
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1400
|
-
base: "BTC",
|
|
1401
|
-
quote: "USD",
|
|
1402
|
-
});
|
|
1403
|
-
```
|
|
1404
|
-
|
|
1405
|
-
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1406
|
-
|
|
1407
|
-
##### userId: `string`<a id="userid-string"></a>
|
|
1408
|
-
|
|
1409
|
-
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1410
|
-
|
|
1411
|
-
##### accountId: `string`<a id="accountid-string"></a>
|
|
1412
|
-
|
|
1413
|
-
##### base: `string`<a id="base-string"></a>
|
|
1414
|
-
|
|
1415
|
-
##### quote: `string`<a id="quote-string"></a>
|
|
1416
|
-
|
|
1417
|
-
#### 🔄 Return<a id="🔄-return"></a>
|
|
1418
|
-
|
|
1419
|
-
[TradingCryptoSpotSymbols200Response](./models/trading-crypto-spot-symbols200-response.ts)
|
|
1420
|
-
|
|
1421
|
-
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1422
|
-
|
|
1423
|
-
`/accounts/{accountId}/trading/crypto/spot/symbols` `GET`
|
|
1424
|
-
|
|
1425
|
-
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1426
|
-
|
|
1427
|
-
---
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
1135
|
### `snaptrade.options.getOptionStrategy`<a id="snaptradeoptionsgetoptionstrategy"></a>
|
|
1431
1136
|
|
|
1432
1137
|
Creates an option strategy object that will be used to place an option strategy order.
|
|
@@ -1979,6 +1684,45 @@ The search query for symbols.
|
|
|
1979
1684
|
---
|
|
1980
1685
|
|
|
1981
1686
|
|
|
1687
|
+
### `snaptrade.trading.cancelOrder`<a id="snaptradetradingcancelorder"></a>
|
|
1688
|
+
|
|
1689
|
+
Cancels an order in the specified account.
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1693
|
+
|
|
1694
|
+
```typescript
|
|
1695
|
+
const cancelOrderResponse = await snaptrade.trading.cancelOrder({
|
|
1696
|
+
userId: "snaptrade-user-123",
|
|
1697
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1698
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1699
|
+
brokerageOrderId: "66a033fa-da74-4fcf-b527-feefdec9257e",
|
|
1700
|
+
});
|
|
1701
|
+
```
|
|
1702
|
+
|
|
1703
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1704
|
+
|
|
1705
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
1706
|
+
|
|
1707
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1708
|
+
|
|
1709
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
1710
|
+
|
|
1711
|
+
##### brokerageOrderId: `string`<a id="brokerageorderid-string"></a>
|
|
1712
|
+
|
|
1713
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1714
|
+
|
|
1715
|
+
[OrderUpdatedResponse](./models/order-updated-response.ts)
|
|
1716
|
+
|
|
1717
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1718
|
+
|
|
1719
|
+
`/accounts/{accountId}/trading/simple/{brokerageOrderId}/cancel` `POST`
|
|
1720
|
+
|
|
1721
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1722
|
+
|
|
1723
|
+
---
|
|
1724
|
+
|
|
1725
|
+
|
|
1982
1726
|
### `snaptrade.trading.cancelUserAccountOrder`<a id="snaptradetradingcanceluseraccountorder"></a>
|
|
1983
1727
|
|
|
1984
1728
|
Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.
|
|
@@ -2021,6 +1765,46 @@ Order ID returned by brokerage. This is the unique identifier for the order in t
|
|
|
2021
1765
|
---
|
|
2022
1766
|
|
|
2023
1767
|
|
|
1768
|
+
### `snaptrade.trading.getCryptocurrencyPairQuote`<a id="snaptradetradinggetcryptocurrencypairquote"></a>
|
|
1769
|
+
|
|
1770
|
+
Gets a quote for the specified account.
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1774
|
+
|
|
1775
|
+
```typescript
|
|
1776
|
+
const getCryptocurrencyPairQuoteResponse =
|
|
1777
|
+
await snaptrade.trading.getCryptocurrencyPairQuote({
|
|
1778
|
+
userId: "snaptrade-user-123",
|
|
1779
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
1780
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
1781
|
+
instrumentSymbol: "BTC-USD",
|
|
1782
|
+
});
|
|
1783
|
+
```
|
|
1784
|
+
|
|
1785
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
1786
|
+
|
|
1787
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
1788
|
+
|
|
1789
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
1790
|
+
|
|
1791
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
1792
|
+
|
|
1793
|
+
##### instrumentSymbol: `string`<a id="instrumentsymbol-string"></a>
|
|
1794
|
+
|
|
1795
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
1796
|
+
|
|
1797
|
+
[CryptocurrencyPairQuote](./models/cryptocurrency-pair-quote.ts)
|
|
1798
|
+
|
|
1799
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
1800
|
+
|
|
1801
|
+
`/accounts/{accountId}/trading/instruments/cryptocurrencyPairs/{instrumentSymbol}/quote` `GET`
|
|
1802
|
+
|
|
1803
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
1804
|
+
|
|
1805
|
+
---
|
|
1806
|
+
|
|
1807
|
+
|
|
2024
1808
|
### `snaptrade.trading.getOrderImpact`<a id="snaptradetradinggetorderimpact"></a>
|
|
2025
1809
|
|
|
2026
1810
|
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.
|
|
@@ -2358,6 +2142,171 @@ Optional, defaults to true. Determines if a wait is performed to check on order
|
|
|
2358
2142
|
---
|
|
2359
2143
|
|
|
2360
2144
|
|
|
2145
|
+
### `snaptrade.trading.placeSimpleOrder`<a id="snaptradetradingplacesimpleorder"></a>
|
|
2146
|
+
|
|
2147
|
+
Places an order in the specified account.
|
|
2148
|
+
This endpoint does not compute the impact to the account balance from the order before submitting the order.
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2152
|
+
|
|
2153
|
+
```typescript
|
|
2154
|
+
const placeSimpleOrderResponse = await snaptrade.trading.placeSimpleOrder({
|
|
2155
|
+
userId: "snaptrade-user-123",
|
|
2156
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
2157
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
2158
|
+
instrument: {
|
|
2159
|
+
symbol: "AAPL",
|
|
2160
|
+
type: "EQUITY",
|
|
2161
|
+
},
|
|
2162
|
+
side: "BUY",
|
|
2163
|
+
type: "MARKET",
|
|
2164
|
+
time_in_force: "GTC",
|
|
2165
|
+
amount: "123.45",
|
|
2166
|
+
limit_price: "123.45",
|
|
2167
|
+
stop_price: "123.45",
|
|
2168
|
+
post_only: false,
|
|
2169
|
+
expiration_date: "2024-01-01T00:00:00Z",
|
|
2170
|
+
});
|
|
2171
|
+
```
|
|
2172
|
+
|
|
2173
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
2174
|
+
|
|
2175
|
+
##### instrument: [`TradingInstrument`](./models/trading-instrument.ts)<a id="instrument-tradinginstrumentmodelstrading-instrumentts"></a>
|
|
2176
|
+
|
|
2177
|
+
##### side: [`ActionStrict`](./models/action-strict.ts)<a id="side-actionstrictmodelsaction-strictts"></a>
|
|
2178
|
+
|
|
2179
|
+
The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
|
|
2180
|
+
|
|
2181
|
+
##### type: `string`<a id="type-string"></a>
|
|
2182
|
+
|
|
2183
|
+
The type of order to place.
|
|
2184
|
+
|
|
2185
|
+
##### time_in_force: `string`<a id="time_in_force-string"></a>
|
|
2186
|
+
|
|
2187
|
+
The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date.
|
|
2188
|
+
|
|
2189
|
+
##### amount: `string`<a id="amount-string"></a>
|
|
2190
|
+
|
|
2191
|
+
The amount of the base currency to buy or sell.
|
|
2192
|
+
|
|
2193
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
2194
|
+
|
|
2195
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
2196
|
+
|
|
2197
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
2198
|
+
|
|
2199
|
+
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
2200
|
+
|
|
2201
|
+
The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
|
|
2202
|
+
|
|
2203
|
+
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
2204
|
+
|
|
2205
|
+
The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
|
|
2206
|
+
|
|
2207
|
+
##### post_only: `boolean`<a id="post_only-boolean"></a>
|
|
2208
|
+
|
|
2209
|
+
Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
|
|
2210
|
+
|
|
2211
|
+
##### expiration_date: `string`<a id="expiration_date-string"></a>
|
|
2212
|
+
|
|
2213
|
+
The expiration date of the order. Required if the time_in_force is GTD.
|
|
2214
|
+
|
|
2215
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
2216
|
+
|
|
2217
|
+
[OrderUpdatedResponse](./models/order-updated-response.ts)
|
|
2218
|
+
|
|
2219
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
2220
|
+
|
|
2221
|
+
`/accounts/{accountId}/trading/simple` `POST`
|
|
2222
|
+
|
|
2223
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
2224
|
+
|
|
2225
|
+
---
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
### `snaptrade.trading.previewSimpleOrder`<a id="snaptradetradingpreviewsimpleorder"></a>
|
|
2229
|
+
|
|
2230
|
+
Previews an order using the specified account.
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2234
|
+
|
|
2235
|
+
```typescript
|
|
2236
|
+
const previewSimpleOrderResponse = await snaptrade.trading.previewSimpleOrder({
|
|
2237
|
+
userId: "snaptrade-user-123",
|
|
2238
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
2239
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
2240
|
+
instrument: {
|
|
2241
|
+
symbol: "AAPL",
|
|
2242
|
+
type: "EQUITY",
|
|
2243
|
+
},
|
|
2244
|
+
side: "BUY",
|
|
2245
|
+
type: "MARKET",
|
|
2246
|
+
time_in_force: "GTC",
|
|
2247
|
+
amount: "123.45",
|
|
2248
|
+
limit_price: "123.45",
|
|
2249
|
+
stop_price: "123.45",
|
|
2250
|
+
post_only: false,
|
|
2251
|
+
expiration_date: "2024-01-01T00:00:00Z",
|
|
2252
|
+
});
|
|
2253
|
+
```
|
|
2254
|
+
|
|
2255
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
2256
|
+
|
|
2257
|
+
##### instrument: [`TradingInstrument`](./models/trading-instrument.ts)<a id="instrument-tradinginstrumentmodelstrading-instrumentts"></a>
|
|
2258
|
+
|
|
2259
|
+
##### side: [`ActionStrict`](./models/action-strict.ts)<a id="side-actionstrictmodelsaction-strictts"></a>
|
|
2260
|
+
|
|
2261
|
+
The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
|
|
2262
|
+
|
|
2263
|
+
##### type: `string`<a id="type-string"></a>
|
|
2264
|
+
|
|
2265
|
+
The type of order to place.
|
|
2266
|
+
|
|
2267
|
+
##### time_in_force: `string`<a id="time_in_force-string"></a>
|
|
2268
|
+
|
|
2269
|
+
The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled. - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely. - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled. - `GTD` - Good Til Date. The order is valid until the specified date.
|
|
2270
|
+
|
|
2271
|
+
##### amount: `string`<a id="amount-string"></a>
|
|
2272
|
+
|
|
2273
|
+
The amount of the base currency to buy or sell.
|
|
2274
|
+
|
|
2275
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
2276
|
+
|
|
2277
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
2278
|
+
|
|
2279
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
2280
|
+
|
|
2281
|
+
##### limit_price: `string`<a id="limit_price-string"></a>
|
|
2282
|
+
|
|
2283
|
+
The limit price. Required if the order type is LIMIT, STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT.
|
|
2284
|
+
|
|
2285
|
+
##### stop_price: `string`<a id="stop_price-string"></a>
|
|
2286
|
+
|
|
2287
|
+
The stop price. Required if the order type is STOP_LOSS_MARKET, STOP_LOSS_LIMIT, TAKE_PROFIT_MARKET or TAKE_PROFIT_LIMIT.
|
|
2288
|
+
|
|
2289
|
+
##### post_only: `boolean`<a id="post_only-boolean"></a>
|
|
2290
|
+
|
|
2291
|
+
Valid and required only for order type LIMIT. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
|
|
2292
|
+
|
|
2293
|
+
##### expiration_date: `string`<a id="expiration_date-string"></a>
|
|
2294
|
+
|
|
2295
|
+
The expiration date of the order. Required if the time_in_force is GTD.
|
|
2296
|
+
|
|
2297
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
2298
|
+
|
|
2299
|
+
[SimpleOrderPreview](./models/simple-order-preview.ts)
|
|
2300
|
+
|
|
2301
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
2302
|
+
|
|
2303
|
+
`/accounts/{accountId}/trading/simple/preview` `POST`
|
|
2304
|
+
|
|
2305
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
2306
|
+
|
|
2307
|
+
---
|
|
2308
|
+
|
|
2309
|
+
|
|
2361
2310
|
### `snaptrade.trading.replaceOrder`<a id="snaptradetradingreplaceorder"></a>
|
|
2362
2311
|
|
|
2363
2312
|
Replaces an existing pending order with a new one. The way this works is brokerage dependent, but usually involves cancelling
|
|
@@ -2431,6 +2380,49 @@ The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
|
|
|
2431
2380
|
---
|
|
2432
2381
|
|
|
2433
2382
|
|
|
2383
|
+
### `snaptrade.trading.searchCryptocurrencyPairInstruments`<a id="snaptradetradingsearchcryptocurrencypairinstruments"></a>
|
|
2384
|
+
|
|
2385
|
+
Searches cryptocurrency pairs instruments accessible to the specified account.
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
2389
|
+
|
|
2390
|
+
```typescript
|
|
2391
|
+
const searchCryptocurrencyPairInstrumentsResponse =
|
|
2392
|
+
await snaptrade.trading.searchCryptocurrencyPairInstruments({
|
|
2393
|
+
userId: "snaptrade-user-123",
|
|
2394
|
+
userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
|
|
2395
|
+
accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
|
|
2396
|
+
base: "BTC",
|
|
2397
|
+
quote: "USD",
|
|
2398
|
+
});
|
|
2399
|
+
```
|
|
2400
|
+
|
|
2401
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
|
2402
|
+
|
|
2403
|
+
##### userId: `string`<a id="userid-string"></a>
|
|
2404
|
+
|
|
2405
|
+
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
2406
|
+
|
|
2407
|
+
##### accountId: `string`<a id="accountid-string"></a>
|
|
2408
|
+
|
|
2409
|
+
##### base: `string`<a id="base-string"></a>
|
|
2410
|
+
|
|
2411
|
+
##### quote: `string`<a id="quote-string"></a>
|
|
2412
|
+
|
|
2413
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
|
2414
|
+
|
|
2415
|
+
[TradingSearchCryptocurrencyPairInstruments200Response](./models/trading-search-cryptocurrency-pair-instruments200-response.ts)
|
|
2416
|
+
|
|
2417
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
|
2418
|
+
|
|
2419
|
+
`/accounts/{accountId}/trading/instruments/cryptocurrencyPairs` `GET`
|
|
2420
|
+
|
|
2421
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
|
2422
|
+
|
|
2423
|
+
---
|
|
2424
|
+
|
|
2425
|
+
|
|
2434
2426
|
### `snaptrade.transactionsAndReporting.getActivities`<a id="snaptradetransactionsandreportinggetactivities"></a>
|
|
2435
2427
|

|
|
2436
2428
|
|