snaptrade-typescript-sdk 9.0.198 → 9.0.200
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 +45 -215
- package/dist/api/trading-api-generated.d.ts +8 -4
- package/dist/api/trading-api-generated.js +8 -4
- 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/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/trade-detection-cancel-subscription-response.d.ts +14 -0
- package/dist/models/trade-detection-cancel-subscription-response.js +2 -0
- package/dist/models/trade-detection-subscription.d.ts +26 -0
- package/dist/models/trade-detection-subscription.js +2 -0
- package/dist/operationParameterMap.js +0 -64
- package/package.json +1 -1
- package/dist/api/experimental-endpoints-api-generated.d.ts +0 -300
- package/dist/api/experimental-endpoints-api-generated.js +0 -441
- package/dist/api/experimental-endpoints-api.d.ts +0 -4
- package/dist/api/experimental-endpoints-api.js +0 -22
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AccountInformationApi, ApiStatusApi, AuthenticationApi, ConnectionsApi,
|
|
1
|
+
import { AccountInformationApi, ApiStatusApi, AuthenticationApi, ConnectionsApi, OptionsApi, ReferenceDataApi, TradingApi, TransactionsAndReportingApi } from "./api";
|
|
2
2
|
import { ConfigurationParameters } from "./configuration";
|
|
3
3
|
import { SnaptradeCustom } from "./client-custom";
|
|
4
4
|
export declare class Snaptrade extends SnaptradeCustom {
|
|
@@ -6,7 +6,6 @@ export declare class Snaptrade extends SnaptradeCustom {
|
|
|
6
6
|
readonly apiStatus: ApiStatusApi;
|
|
7
7
|
readonly authentication: AuthenticationApi;
|
|
8
8
|
readonly connections: ConnectionsApi;
|
|
9
|
-
readonly experimentalEndpoints: ExperimentalEndpointsApi;
|
|
10
9
|
readonly options: OptionsApi;
|
|
11
10
|
readonly referenceData: ReferenceDataApi;
|
|
12
11
|
readonly trading: TradingApi;
|
package/dist/client.js
CHANGED
|
@@ -22,7 +22,6 @@ class Snaptrade extends client_custom_1.SnaptradeCustom {
|
|
|
22
22
|
this.apiStatus = new api_1.ApiStatusApi(configuration);
|
|
23
23
|
this.authentication = new api_1.AuthenticationApi(configuration);
|
|
24
24
|
this.connections = new api_1.ConnectionsApi(configuration);
|
|
25
|
-
this.experimentalEndpoints = new api_1.ExperimentalEndpointsApi(configuration);
|
|
26
25
|
this.options = new api_1.OptionsApi(configuration);
|
|
27
26
|
this.referenceData = new api_1.ReferenceDataApi(configuration);
|
|
28
27
|
this.trading = new api_1.TradingApi(configuration);
|
package/dist/configuration.js
CHANGED
|
@@ -32,7 +32,7 @@ class Configuration {
|
|
|
32
32
|
this.accessToken = param.accessToken;
|
|
33
33
|
this.basePath = param.basePath;
|
|
34
34
|
this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
|
|
35
|
-
this.userAgent = param.userAgent === undefined ? "Konfig/9.0.
|
|
35
|
+
this.userAgent = param.userAgent === undefined ? "Konfig/9.0.200/typescript" : param.userAgent;
|
|
36
36
|
this.formDataCtor = param.formDataCtor;
|
|
37
37
|
}
|
|
38
38
|
/**
|
package/dist/models/index.d.ts
CHANGED
|
@@ -155,6 +155,8 @@ export * from './symbols-quotes-inner';
|
|
|
155
155
|
export * from './take-profit';
|
|
156
156
|
export * from './tax-lot';
|
|
157
157
|
export * from './time-in-force-strict';
|
|
158
|
+
export * from './trade-detection-cancel-subscription-response';
|
|
159
|
+
export * from './trade-detection-subscription';
|
|
158
160
|
export * from './trading-instrument';
|
|
159
161
|
export * from './trading-search-cryptocurrency-pair-instruments200-response';
|
|
160
162
|
export * from './trading-session';
|
package/dist/models/index.js
CHANGED
|
@@ -171,6 +171,8 @@ __exportStar(require("./symbols-quotes-inner"), exports);
|
|
|
171
171
|
__exportStar(require("./take-profit"), exports);
|
|
172
172
|
__exportStar(require("./tax-lot"), exports);
|
|
173
173
|
__exportStar(require("./time-in-force-strict"), exports);
|
|
174
|
+
__exportStar(require("./trade-detection-cancel-subscription-response"), exports);
|
|
175
|
+
__exportStar(require("./trade-detection-subscription"), exports);
|
|
174
176
|
__exportStar(require("./trading-instrument"), exports);
|
|
175
177
|
__exportStar(require("./trading-search-cryptocurrency-pair-instruments200-response"), exports);
|
|
176
178
|
__exportStar(require("./trading-session"), exports);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @export
|
|
4
|
+
* @interface TradeDetectionCancelSubscriptionResponse
|
|
5
|
+
*/
|
|
6
|
+
export interface TradeDetectionCancelSubscriptionResponse {
|
|
7
|
+
[key: string]: any;
|
|
8
|
+
/**
|
|
9
|
+
*
|
|
10
|
+
* @type {boolean}
|
|
11
|
+
* @memberof TradeDetectionCancelSubscriptionResponse
|
|
12
|
+
*/
|
|
13
|
+
'success': boolean;
|
|
14
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An active Trade Detection subscription for a brokerage account.
|
|
3
|
+
* @export
|
|
4
|
+
* @interface TradeDetectionSubscription
|
|
5
|
+
*/
|
|
6
|
+
export interface TradeDetectionSubscription {
|
|
7
|
+
[key: string]: any;
|
|
8
|
+
/**
|
|
9
|
+
* Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
|
|
10
|
+
* @type {string}
|
|
11
|
+
* @memberof TradeDetectionSubscription
|
|
12
|
+
*/
|
|
13
|
+
'account_id': string;
|
|
14
|
+
/**
|
|
15
|
+
* Monthly subscription cost as a decimal string.
|
|
16
|
+
* @type {string}
|
|
17
|
+
* @memberof TradeDetectionSubscription
|
|
18
|
+
*/
|
|
19
|
+
'cost': string;
|
|
20
|
+
/**
|
|
21
|
+
* How often the subscribed account is checked for new trades.
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof TradeDetectionSubscription
|
|
24
|
+
*/
|
|
25
|
+
'check_interval_seconds': number;
|
|
26
|
+
}
|
|
@@ -392,70 +392,6 @@ exports.operationParameterMap = {
|
|
|
392
392
|
},
|
|
393
393
|
]
|
|
394
394
|
},
|
|
395
|
-
'/accounts/{accountId}/orders/details/v2/{brokerageOrderId}-GET': {
|
|
396
|
-
parameters: [
|
|
397
|
-
{
|
|
398
|
-
name: 'accountId'
|
|
399
|
-
},
|
|
400
|
-
{
|
|
401
|
-
name: 'brokerageOrderId'
|
|
402
|
-
},
|
|
403
|
-
{
|
|
404
|
-
name: 'userId'
|
|
405
|
-
},
|
|
406
|
-
{
|
|
407
|
-
name: 'userSecret'
|
|
408
|
-
},
|
|
409
|
-
]
|
|
410
|
-
},
|
|
411
|
-
'/accounts/{accountId}/orders/v2-GET': {
|
|
412
|
-
parameters: [
|
|
413
|
-
{
|
|
414
|
-
name: 'userId'
|
|
415
|
-
},
|
|
416
|
-
{
|
|
417
|
-
name: 'userSecret'
|
|
418
|
-
},
|
|
419
|
-
{
|
|
420
|
-
name: 'accountId'
|
|
421
|
-
},
|
|
422
|
-
{
|
|
423
|
-
name: 'state'
|
|
424
|
-
},
|
|
425
|
-
{
|
|
426
|
-
name: 'days'
|
|
427
|
-
},
|
|
428
|
-
]
|
|
429
|
-
},
|
|
430
|
-
'/accounts/{accountId}/recentOrders/v2-GET': {
|
|
431
|
-
parameters: [
|
|
432
|
-
{
|
|
433
|
-
name: 'userId'
|
|
434
|
-
},
|
|
435
|
-
{
|
|
436
|
-
name: 'userSecret'
|
|
437
|
-
},
|
|
438
|
-
{
|
|
439
|
-
name: 'accountId'
|
|
440
|
-
},
|
|
441
|
-
{
|
|
442
|
-
name: 'only_executed'
|
|
443
|
-
},
|
|
444
|
-
]
|
|
445
|
-
},
|
|
446
|
-
'/authorizations/{authorizationId}/transactions/sync-POST': {
|
|
447
|
-
parameters: [
|
|
448
|
-
{
|
|
449
|
-
name: 'authorizationId'
|
|
450
|
-
},
|
|
451
|
-
{
|
|
452
|
-
name: 'userId'
|
|
453
|
-
},
|
|
454
|
-
{
|
|
455
|
-
name: 'userSecret'
|
|
456
|
-
},
|
|
457
|
-
]
|
|
458
|
-
},
|
|
459
395
|
'/accounts/{accountId}/options-GET': {
|
|
460
396
|
parameters: [
|
|
461
397
|
{
|
package/package.json
CHANGED
|
@@ -1,300 +0,0 @@
|
|
|
1
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
2
|
-
import { Configuration } from '../configuration';
|
|
3
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
4
|
-
import { AccountOrderRecordV2 } from '../models';
|
|
5
|
-
import { AccountOrdersV2Response } from '../models';
|
|
6
|
-
import { BrokerageAuthorizationTransactionsSyncConfirmation } from '../models';
|
|
7
|
-
/**
|
|
8
|
-
* ExperimentalEndpointsApi - axios parameter creator
|
|
9
|
-
* @export
|
|
10
|
-
*/
|
|
11
|
-
export declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
12
|
-
/**
|
|
13
|
-
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
14
|
-
* @summary Get account order detail (V2)
|
|
15
|
-
* @param {string} accountId
|
|
16
|
-
* @param {string} brokerageOrderId
|
|
17
|
-
* @param {string} userId
|
|
18
|
-
* @param {string} userSecret
|
|
19
|
-
* @param {*} [options] Override http request option.
|
|
20
|
-
* @throws {RequiredError}
|
|
21
|
-
*/
|
|
22
|
-
getUserAccountOrderDetailV2: (accountId: string, brokerageOrderId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23
|
-
/**
|
|
24
|
-
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
25
|
-
* @summary List account orders v2
|
|
26
|
-
* @param {string} userId
|
|
27
|
-
* @param {string} userSecret
|
|
28
|
-
* @param {string} accountId
|
|
29
|
-
* @param {'all' | 'open' | 'executed'} [state] defaults value is set to \"all\"
|
|
30
|
-
* @param {number} [days] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
|
|
31
|
-
* @param {*} [options] Override http request option.
|
|
32
|
-
* @throws {RequiredError}
|
|
33
|
-
*/
|
|
34
|
-
getUserAccountOrdersV2: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
-
/**
|
|
36
|
-
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
37
|
-
* @summary List account recent orders (V2, last 24 hours only)
|
|
38
|
-
* @param {string} userId
|
|
39
|
-
* @param {string} userSecret
|
|
40
|
-
* @param {string} accountId
|
|
41
|
-
* @param {boolean} [onlyExecuted] Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
|
|
42
|
-
* @param {*} [options] Override http request option.
|
|
43
|
-
* @throws {RequiredError}
|
|
44
|
-
*/
|
|
45
|
-
getUserAccountRecentOrdersV2: (userId: string, userSecret: string, accountId: string, onlyExecuted?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
-
/**
|
|
47
|
-
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
48
|
-
* @summary Sync transactions for a connection
|
|
49
|
-
* @param {string} authorizationId
|
|
50
|
-
* @param {string} userId
|
|
51
|
-
* @param {string} userSecret
|
|
52
|
-
* @param {*} [options] Override http request option.
|
|
53
|
-
* @throws {RequiredError}
|
|
54
|
-
*/
|
|
55
|
-
syncBrokerageAuthorizationTransactions: (authorizationId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* ExperimentalEndpointsApi - functional programming interface
|
|
59
|
-
* @export
|
|
60
|
-
*/
|
|
61
|
-
export declare const ExperimentalEndpointsApiFp: (configuration?: Configuration) => {
|
|
62
|
-
/**
|
|
63
|
-
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
64
|
-
* @summary Get account order detail (V2)
|
|
65
|
-
* @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
|
|
66
|
-
* @param {*} [options] Override http request option.
|
|
67
|
-
* @throws {RequiredError}
|
|
68
|
-
*/
|
|
69
|
-
getUserAccountOrderDetailV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecordV2>>;
|
|
70
|
-
/**
|
|
71
|
-
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
72
|
-
* @summary List account orders v2
|
|
73
|
-
* @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
|
|
74
|
-
* @param {*} [options] Override http request option.
|
|
75
|
-
* @throws {RequiredError}
|
|
76
|
-
*/
|
|
77
|
-
getUserAccountOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
|
|
78
|
-
/**
|
|
79
|
-
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
80
|
-
* @summary List account recent orders (V2, last 24 hours only)
|
|
81
|
-
* @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
|
|
82
|
-
* @param {*} [options] Override http request option.
|
|
83
|
-
* @throws {RequiredError}
|
|
84
|
-
*/
|
|
85
|
-
getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
|
|
86
|
-
/**
|
|
87
|
-
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
88
|
-
* @summary Sync transactions for a connection
|
|
89
|
-
* @param {ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest} requestParameters Request parameters.
|
|
90
|
-
* @param {*} [options] Override http request option.
|
|
91
|
-
* @throws {RequiredError}
|
|
92
|
-
*/
|
|
93
|
-
syncBrokerageAuthorizationTransactions(requestParameters: ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorizationTransactionsSyncConfirmation>>;
|
|
94
|
-
};
|
|
95
|
-
/**
|
|
96
|
-
* ExperimentalEndpointsApi - factory interface
|
|
97
|
-
* @export
|
|
98
|
-
*/
|
|
99
|
-
export declare const ExperimentalEndpointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
|
-
/**
|
|
101
|
-
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
102
|
-
* @summary Get account order detail (V2)
|
|
103
|
-
* @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
|
|
104
|
-
* @param {*} [options] Override http request option.
|
|
105
|
-
* @throws {RequiredError}
|
|
106
|
-
*/
|
|
107
|
-
getUserAccountOrderDetailV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecordV2>;
|
|
108
|
-
/**
|
|
109
|
-
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
110
|
-
* @summary List account orders v2
|
|
111
|
-
* @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
|
|
112
|
-
* @param {*} [options] Override http request option.
|
|
113
|
-
* @throws {RequiredError}
|
|
114
|
-
*/
|
|
115
|
-
getUserAccountOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrdersV2Response>;
|
|
116
|
-
/**
|
|
117
|
-
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
118
|
-
* @summary List account recent orders (V2, last 24 hours only)
|
|
119
|
-
* @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
|
|
120
|
-
* @param {*} [options] Override http request option.
|
|
121
|
-
* @throws {RequiredError}
|
|
122
|
-
*/
|
|
123
|
-
getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrdersV2Response>;
|
|
124
|
-
/**
|
|
125
|
-
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
126
|
-
* @summary Sync transactions for a connection
|
|
127
|
-
* @param {ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest} requestParameters Request parameters.
|
|
128
|
-
* @param {*} [options] Override http request option.
|
|
129
|
-
* @throws {RequiredError}
|
|
130
|
-
*/
|
|
131
|
-
syncBrokerageAuthorizationTransactions(requestParameters: ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorizationTransactionsSyncConfirmation>;
|
|
132
|
-
};
|
|
133
|
-
/**
|
|
134
|
-
* Request parameters for getUserAccountOrderDetailV2 operation in ExperimentalEndpointsApi.
|
|
135
|
-
* @export
|
|
136
|
-
* @interface ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request
|
|
137
|
-
*/
|
|
138
|
-
export type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request = {
|
|
139
|
-
/**
|
|
140
|
-
*
|
|
141
|
-
* @type {string}
|
|
142
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
|
|
143
|
-
*/
|
|
144
|
-
readonly accountId: string;
|
|
145
|
-
/**
|
|
146
|
-
*
|
|
147
|
-
* @type {string}
|
|
148
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
|
|
149
|
-
*/
|
|
150
|
-
readonly brokerageOrderId: string;
|
|
151
|
-
/**
|
|
152
|
-
*
|
|
153
|
-
* @type {string}
|
|
154
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
|
|
155
|
-
*/
|
|
156
|
-
readonly userId: string;
|
|
157
|
-
/**
|
|
158
|
-
*
|
|
159
|
-
* @type {string}
|
|
160
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
|
|
161
|
-
*/
|
|
162
|
-
readonly userSecret: string;
|
|
163
|
-
};
|
|
164
|
-
/**
|
|
165
|
-
* Request parameters for getUserAccountOrdersV2 operation in ExperimentalEndpointsApi.
|
|
166
|
-
* @export
|
|
167
|
-
* @interface ExperimentalEndpointsApiGetUserAccountOrdersV2Request
|
|
168
|
-
*/
|
|
169
|
-
export type ExperimentalEndpointsApiGetUserAccountOrdersV2Request = {
|
|
170
|
-
/**
|
|
171
|
-
*
|
|
172
|
-
* @type {string}
|
|
173
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
|
|
174
|
-
*/
|
|
175
|
-
readonly userId: string;
|
|
176
|
-
/**
|
|
177
|
-
*
|
|
178
|
-
* @type {string}
|
|
179
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
|
|
180
|
-
*/
|
|
181
|
-
readonly userSecret: string;
|
|
182
|
-
/**
|
|
183
|
-
*
|
|
184
|
-
* @type {string}
|
|
185
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
|
|
186
|
-
*/
|
|
187
|
-
readonly accountId: string;
|
|
188
|
-
/**
|
|
189
|
-
* defaults value is set to \"all\"
|
|
190
|
-
* @type {'all' | 'open' | 'executed'}
|
|
191
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
|
|
192
|
-
*/
|
|
193
|
-
readonly state?: 'all' | 'open' | 'executed';
|
|
194
|
-
/**
|
|
195
|
-
* Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in. Values greater than 90 will be capped at 90.
|
|
196
|
-
* @type {number}
|
|
197
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
|
|
198
|
-
*/
|
|
199
|
-
readonly days?: number;
|
|
200
|
-
};
|
|
201
|
-
/**
|
|
202
|
-
* Request parameters for getUserAccountRecentOrdersV2 operation in ExperimentalEndpointsApi.
|
|
203
|
-
* @export
|
|
204
|
-
* @interface ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request
|
|
205
|
-
*/
|
|
206
|
-
export type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request = {
|
|
207
|
-
/**
|
|
208
|
-
*
|
|
209
|
-
* @type {string}
|
|
210
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
|
|
211
|
-
*/
|
|
212
|
-
readonly userId: string;
|
|
213
|
-
/**
|
|
214
|
-
*
|
|
215
|
-
* @type {string}
|
|
216
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
|
|
217
|
-
*/
|
|
218
|
-
readonly userSecret: string;
|
|
219
|
-
/**
|
|
220
|
-
*
|
|
221
|
-
* @type {string}
|
|
222
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
|
|
223
|
-
*/
|
|
224
|
-
readonly accountId: string;
|
|
225
|
-
/**
|
|
226
|
-
* Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
|
|
227
|
-
* @type {boolean}
|
|
228
|
-
* @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
|
|
229
|
-
*/
|
|
230
|
-
readonly onlyExecuted?: boolean;
|
|
231
|
-
};
|
|
232
|
-
/**
|
|
233
|
-
* Request parameters for syncBrokerageAuthorizationTransactions operation in ExperimentalEndpointsApi.
|
|
234
|
-
* @export
|
|
235
|
-
* @interface ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest
|
|
236
|
-
*/
|
|
237
|
-
export type ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest = {
|
|
238
|
-
/**
|
|
239
|
-
*
|
|
240
|
-
* @type {string}
|
|
241
|
-
* @memberof ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactions
|
|
242
|
-
*/
|
|
243
|
-
readonly authorizationId: string;
|
|
244
|
-
/**
|
|
245
|
-
*
|
|
246
|
-
* @type {string}
|
|
247
|
-
* @memberof ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactions
|
|
248
|
-
*/
|
|
249
|
-
readonly userId: string;
|
|
250
|
-
/**
|
|
251
|
-
*
|
|
252
|
-
* @type {string}
|
|
253
|
-
* @memberof ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactions
|
|
254
|
-
*/
|
|
255
|
-
readonly userSecret: string;
|
|
256
|
-
};
|
|
257
|
-
/**
|
|
258
|
-
* ExperimentalEndpointsApiGenerated - object-oriented interface
|
|
259
|
-
* @export
|
|
260
|
-
* @class ExperimentalEndpointsApiGenerated
|
|
261
|
-
* @extends {BaseAPI}
|
|
262
|
-
*/
|
|
263
|
-
export declare class ExperimentalEndpointsApiGenerated extends BaseAPI {
|
|
264
|
-
/**
|
|
265
|
-
* Returns the detail of a single order using the brokerage order ID provided as a path parameter. The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. This endpoint is always realtime and does not rely on cached data. This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
|
|
266
|
-
* @summary Get account order detail (V2)
|
|
267
|
-
* @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
|
|
268
|
-
* @param {*} [options] Override http request option.
|
|
269
|
-
* @throws {RequiredError}
|
|
270
|
-
* @memberof ExperimentalEndpointsApiGenerated
|
|
271
|
-
*/
|
|
272
|
-
getUserAccountOrderDetailV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecordV2, any, {}>>;
|
|
273
|
-
/**
|
|
274
|
-
* Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
|
|
275
|
-
* @summary List account orders v2
|
|
276
|
-
* @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
|
|
277
|
-
* @param {*} [options] Override http request option.
|
|
278
|
-
* @throws {RequiredError}
|
|
279
|
-
* @memberof ExperimentalEndpointsApiGenerated
|
|
280
|
-
*/
|
|
281
|
-
getUserAccountOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrdersV2Response, any, {}>>;
|
|
282
|
-
/**
|
|
283
|
-
* A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
|
|
284
|
-
* @summary List account recent orders (V2, last 24 hours only)
|
|
285
|
-
* @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
|
|
286
|
-
* @param {*} [options] Override http request option.
|
|
287
|
-
* @throws {RequiredError}
|
|
288
|
-
* @memberof ExperimentalEndpointsApiGenerated
|
|
289
|
-
*/
|
|
290
|
-
getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrdersV2Response, any, {}>>;
|
|
291
|
-
/**
|
|
292
|
-
* Trigger a transactions sync for all accounts under this connection. Updates will be queued asynchronously. Transactions are not updated intra-day, but calling this endpoint can ensure that the previous day\'s transactions have been synced. For more information on sync behaviour, see: https://docs.snaptrade.com/docs/syncing
|
|
293
|
-
* @summary Sync transactions for a connection
|
|
294
|
-
* @param {ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest} requestParameters Request parameters.
|
|
295
|
-
* @param {*} [options] Override http request option.
|
|
296
|
-
* @throws {RequiredError}
|
|
297
|
-
* @memberof ExperimentalEndpointsApiGenerated
|
|
298
|
-
*/
|
|
299
|
-
syncBrokerageAuthorizationTransactions(requestParameters: ExperimentalEndpointsApiSyncBrokerageAuthorizationTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTransactionsSyncConfirmation, any, {}>>;
|
|
300
|
-
}
|