snaptrade-typescript-sdk 9.0.30 → 9.0.32
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 +12 -14
- package/dist/api/account-information-api-generated.d.ts +14 -14
- package/dist/api/account-information-api-generated.js +13 -13
- package/dist/api/authentication-api-generated.d.ts +4 -4
- package/dist/api/authentication-api-generated.js +4 -4
- package/dist/api/connections-api-generated.d.ts +4 -4
- package/dist/api/connections-api-generated.js +4 -4
- 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-balance-total.d.ts +2 -2
- package/dist/models/account-balance.d.ts +1 -1
- package/dist/models/account-holdings-account.d.ts +5 -5
- package/dist/models/amount.d.ts +2 -2
- package/dist/models/balance.d.ts +3 -3
- package/dist/models/currency.d.ts +4 -4
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/options-position-currency.d.ts +3 -3
- package/dist/models/options-position.d.ts +4 -4
- package/dist/models/position.d.ts +7 -6
- package/dist/models/snap-trade-holdings-account-account-id.d.ts +13 -10
- package/dist/models/snap-trade-holdings-total-value.d.ts +3 -3
- package/dist/models/snap-trade-login-user-request-body.d.ts +2 -2
- package/package.json +1 -1
- package/dist/models/options-holdings.d.ts +0 -46
- package/dist/models/options-holdings.js +0 -2
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.32)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -180,8 +180,10 @@ main();
|
|
|
180
180
|
### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
|
|
181
181
|

|
|
182
182
|
|
|
183
|
-
|
|
184
|
-
|
|
183
|
+
**Deprecated, please use the account-specific holdings endpoint instead.**
|
|
184
|
+
|
|
185
|
+
List all accounts for the user, plus balances, positions, and orders for each
|
|
186
|
+
account.
|
|
185
187
|
|
|
186
188
|
|
|
187
189
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -384,9 +386,7 @@ The ID of the account to get positions.
|
|
|
384
386
|
|
|
385
387
|
### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
|
|
386
388
|
|
|
387
|
-
Lists balances, positions and orders for the specified account
|
|
388
|
-
option_positions and account metadata. The data returned is similar to the
|
|
389
|
-
data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
|
|
389
|
+
Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
390
390
|
|
|
391
391
|
|
|
392
392
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -404,8 +404,6 @@ const getUserHoldingsResponse =
|
|
|
404
404
|
|
|
405
405
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
406
406
|
|
|
407
|
-
The ID of the account to fetch holdings for.
|
|
408
|
-
|
|
409
407
|
##### userId: `string`<a id="userid-string"></a>
|
|
410
408
|
|
|
411
409
|
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
@@ -595,7 +593,7 @@ const loginSnapTradeUserResponse =
|
|
|
595
593
|
|
|
596
594
|
##### broker: `string`<a id="broker-string"></a>
|
|
597
595
|
|
|
598
|
-
Slug of the brokerage to connect the user to
|
|
596
|
+
Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
|
|
599
597
|
|
|
600
598
|
##### immediateRedirect: `boolean`<a id="immediateredirect-boolean"></a>
|
|
601
599
|
|
|
@@ -615,7 +613,7 @@ Sets whether the connection should be read or trade
|
|
|
615
613
|
|
|
616
614
|
##### connectionPortalVersion: `string`<a id="connectionportalversion-string"></a>
|
|
617
615
|
|
|
618
|
-
Sets the version of the connection portal to render, with a default to \\\'
|
|
616
|
+
Sets the version of the connection portal to render, with a default to \\\'v3\\\'
|
|
619
617
|
|
|
620
618
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
621
619
|
|
|
@@ -632,8 +630,8 @@ Sets the version of the connection portal to render, with a default to \\\'v2\\\
|
|
|
632
630
|
|
|
633
631
|
### `snaptrade.authentication.registerSnapTradeUser`<a id="snaptradeauthenticationregistersnaptradeuser"></a>
|
|
634
632
|
|
|
635
|
-
Registers a new SnapTrade user under your ClientID.
|
|
636
|
-
Most SnapTrade operations require a user to be passed as a parameter.
|
|
633
|
+
Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
|
|
634
|
+
Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
637
635
|
|
|
638
636
|
|
|
639
637
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -814,7 +812,7 @@ const listBrokerageAuthorizationsResponse =
|
|
|
814
812
|
|
|
815
813
|
### `snaptrade.connections.refreshBrokerageAuthorization`<a id="snaptradeconnectionsrefreshbrokerageauthorization"></a>
|
|
816
814
|
|
|
817
|
-
Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
815
|
+
Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
818
816
|
|
|
819
817
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
820
818
|
|
|
@@ -1588,7 +1586,7 @@ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Goo
|
|
|
1588
1586
|
|
|
1589
1587
|
### `snaptrade.trading.getUserAccountQuotes`<a id="snaptradetradinggetuseraccountquotes"></a>
|
|
1590
1588
|
|
|
1591
|
-
Returns
|
|
1589
|
+
Returns quote(s) from the brokerage for the specified symbol(s).
|
|
1592
1590
|
|
|
1593
1591
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
1594
1592
|
|
|
@@ -13,7 +13,7 @@ import { Position } from '../models';
|
|
|
13
13
|
*/
|
|
14
14
|
export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
17
17
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
18
18
|
* @param {string} userId
|
|
19
19
|
* @param {string} userSecret
|
|
@@ -66,9 +66,9 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
66
66
|
*/
|
|
67
67
|
getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
* Lists balances, positions and orders for the specified account
|
|
70
|
-
* @summary List
|
|
71
|
-
* @param {string} accountId
|
|
69
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
70
|
+
* @summary List account holdings
|
|
71
|
+
* @param {string} accountId
|
|
72
72
|
* @param {string} userId
|
|
73
73
|
* @param {string} userSecret
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
@@ -101,7 +101,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
101
101
|
*/
|
|
102
102
|
export declare const AccountInformationApiFp: (configuration?: Configuration) => {
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
105
105
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
106
106
|
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
@@ -142,8 +142,8 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
142
142
|
*/
|
|
143
143
|
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
|
|
144
144
|
/**
|
|
145
|
-
* Lists balances, positions and orders for the specified account
|
|
146
|
-
* @summary List
|
|
145
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
146
|
+
* @summary List account holdings
|
|
147
147
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
149
|
* @throws {RequiredError}
|
|
@@ -172,7 +172,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
172
172
|
*/
|
|
173
173
|
export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
174
174
|
/**
|
|
175
|
-
*
|
|
175
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
176
176
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
177
177
|
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
178
178
|
* @param {*} [options] Override http request option.
|
|
@@ -213,8 +213,8 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
213
213
|
*/
|
|
214
214
|
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
|
|
215
215
|
/**
|
|
216
|
-
* Lists balances, positions and orders for the specified account
|
|
217
|
-
* @summary List
|
|
216
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
217
|
+
* @summary List account holdings
|
|
218
218
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
220
220
|
* @throws {RequiredError}
|
|
@@ -381,7 +381,7 @@ export type AccountInformationApiGetUserAccountPositionsRequest = {
|
|
|
381
381
|
*/
|
|
382
382
|
export type AccountInformationApiGetUserHoldingsRequest = {
|
|
383
383
|
/**
|
|
384
|
-
*
|
|
384
|
+
*
|
|
385
385
|
* @type {string}
|
|
386
386
|
* @memberof AccountInformationApiGetUserHoldings
|
|
387
387
|
*/
|
|
@@ -451,7 +451,7 @@ export type AccountInformationApiUpdateUserAccountRequest = {
|
|
|
451
451
|
*/
|
|
452
452
|
export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
453
453
|
/**
|
|
454
|
-
*
|
|
454
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
455
455
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
456
456
|
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
457
457
|
* @param {*} [options] Override http request option.
|
|
@@ -497,8 +497,8 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
497
497
|
*/
|
|
498
498
|
getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
|
|
499
499
|
/**
|
|
500
|
-
* Lists balances, positions and orders for the specified account
|
|
501
|
-
* @summary List
|
|
500
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
501
|
+
* @summary List account holdings
|
|
502
502
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
503
503
|
* @param {*} [options] Override http request option.
|
|
504
504
|
* @throws {RequiredError}
|
|
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
|
|
|
36
36
|
const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
37
37
|
return {
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
40
40
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
41
41
|
* @param {string} userId
|
|
42
42
|
* @param {string} userSecret
|
|
@@ -320,9 +320,9 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
320
320
|
};
|
|
321
321
|
}),
|
|
322
322
|
/**
|
|
323
|
-
* Lists balances, positions and orders for the specified account
|
|
324
|
-
* @summary List
|
|
325
|
-
* @param {string} accountId
|
|
323
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
324
|
+
* @summary List account holdings
|
|
325
|
+
* @param {string} accountId
|
|
326
326
|
* @param {string} userId
|
|
327
327
|
* @param {string} userSecret
|
|
328
328
|
* @param {*} [options] Override http request option.
|
|
@@ -491,7 +491,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
491
491
|
const localVarAxiosParamCreator = (0, exports.AccountInformationApiAxiosParamCreator)(configuration);
|
|
492
492
|
return {
|
|
493
493
|
/**
|
|
494
|
-
*
|
|
494
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
495
495
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
496
496
|
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
497
497
|
* @param {*} [options] Override http request option.
|
|
@@ -557,8 +557,8 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
557
557
|
});
|
|
558
558
|
},
|
|
559
559
|
/**
|
|
560
|
-
* Lists balances, positions and orders for the specified account
|
|
561
|
-
* @summary List
|
|
560
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
561
|
+
* @summary List account holdings
|
|
562
562
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
563
563
|
* @param {*} [options] Override http request option.
|
|
564
564
|
* @throws {RequiredError}
|
|
@@ -606,7 +606,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
606
606
|
const localVarFp = (0, exports.AccountInformationApiFp)(configuration);
|
|
607
607
|
return {
|
|
608
608
|
/**
|
|
609
|
-
*
|
|
609
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
610
610
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
611
611
|
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
612
612
|
* @param {*} [options] Override http request option.
|
|
@@ -657,8 +657,8 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
657
657
|
return localVarFp.getUserAccountPositions(requestParameters, options).then((request) => request(axios, basePath));
|
|
658
658
|
},
|
|
659
659
|
/**
|
|
660
|
-
* Lists balances, positions and orders for the specified account
|
|
661
|
-
* @summary List
|
|
660
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
661
|
+
* @summary List account holdings
|
|
662
662
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
663
663
|
* @param {*} [options] Override http request option.
|
|
664
664
|
* @throws {RequiredError}
|
|
@@ -697,7 +697,7 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
|
|
|
697
697
|
*/
|
|
698
698
|
class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
699
699
|
/**
|
|
700
|
-
*
|
|
700
|
+
* **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
|
|
701
701
|
* @summary List all accounts for the user, plus balances, positions, and orders for each account.
|
|
702
702
|
* @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
|
|
703
703
|
* @param {*} [options] Override http request option.
|
|
@@ -753,8 +753,8 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
753
753
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountPositions(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
754
754
|
}
|
|
755
755
|
/**
|
|
756
|
-
* Lists balances, positions and orders for the specified account
|
|
757
|
-
* @summary List
|
|
756
|
+
* Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
|
|
757
|
+
* @summary List account holdings
|
|
758
758
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
759
759
|
* @param {*} [options] Override http request option.
|
|
760
760
|
* @throws {RequiredError}
|
|
@@ -37,7 +37,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
|
|
|
37
37
|
*/
|
|
38
38
|
loginSnapTradeUser: (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
39
|
/**
|
|
40
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
40
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
41
41
|
* @summary Create SnapTrade user
|
|
42
42
|
* @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
|
|
43
43
|
* @param {*} [options] Override http request option.
|
|
@@ -82,7 +82,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
|
82
82
|
*/
|
|
83
83
|
loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
|
|
84
84
|
/**
|
|
85
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
85
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
86
86
|
* @summary Create SnapTrade user
|
|
87
87
|
* @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
|
|
88
88
|
* @param {*} [options] Override http request option.
|
|
@@ -127,7 +127,7 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
127
127
|
*/
|
|
128
128
|
loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
|
|
129
129
|
/**
|
|
130
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
130
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
131
131
|
* @summary Create SnapTrade user
|
|
132
132
|
* @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
@@ -221,7 +221,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
|
|
|
221
221
|
*/
|
|
222
222
|
loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
|
|
223
223
|
/**
|
|
224
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
224
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
225
225
|
* @summary Create SnapTrade user
|
|
226
226
|
* @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
|
|
227
227
|
* @param {*} [options] Override http request option.
|
|
@@ -175,7 +175,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
|
|
|
175
175
|
};
|
|
176
176
|
}),
|
|
177
177
|
/**
|
|
178
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
178
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
179
179
|
* @summary Create SnapTrade user
|
|
180
180
|
* @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
|
|
181
181
|
* @param {*} [options] Override http request option.
|
|
@@ -321,7 +321,7 @@ const AuthenticationApiFp = function (configuration) {
|
|
|
321
321
|
});
|
|
322
322
|
},
|
|
323
323
|
/**
|
|
324
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
324
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
325
325
|
* @summary Create SnapTrade user
|
|
326
326
|
* @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
|
|
327
327
|
* @param {*} [options] Override http request option.
|
|
@@ -393,7 +393,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
|
|
|
393
393
|
return localVarFp.loginSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
|
|
394
394
|
},
|
|
395
395
|
/**
|
|
396
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
396
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
397
397
|
* @summary Create SnapTrade user
|
|
398
398
|
* @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
|
|
399
399
|
* @param {*} [options] Override http request option.
|
|
@@ -455,7 +455,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
|
|
|
455
455
|
return (0, exports.AuthenticationApiFp)(this.configuration).loginSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
456
456
|
}
|
|
457
457
|
/**
|
|
458
|
-
* Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
|
|
458
|
+
* Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
|
|
459
459
|
* @summary Create SnapTrade user
|
|
460
460
|
* @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
|
|
461
461
|
* @param {*} [options] Override http request option.
|
|
@@ -40,7 +40,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
40
40
|
*/
|
|
41
41
|
listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
43
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
44
44
|
* @summary Refresh holdings for a connection
|
|
45
45
|
* @param {string} authorizationId The ID of a brokerage authorization object.
|
|
46
46
|
* @param {string} userId
|
|
@@ -100,7 +100,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
|
|
|
100
100
|
*/
|
|
101
101
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
|
|
102
102
|
/**
|
|
103
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
103
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
104
104
|
* @summary Refresh holdings for a connection
|
|
105
105
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
106
106
|
* @param {*} [options] Override http request option.
|
|
@@ -154,7 +154,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
|
|
|
154
154
|
*/
|
|
155
155
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
|
|
156
156
|
/**
|
|
157
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
157
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
158
158
|
* @summary Refresh holdings for a connection
|
|
159
159
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
160
160
|
* @param {*} [options] Override http request option.
|
|
@@ -357,7 +357,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
|
|
|
357
357
|
*/
|
|
358
358
|
listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
|
|
359
359
|
/**
|
|
360
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
360
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
361
361
|
* @summary Refresh holdings for a connection
|
|
362
362
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
363
363
|
* @param {*} [options] Override http request option.
|
|
@@ -197,7 +197,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
|
|
|
197
197
|
};
|
|
198
198
|
}),
|
|
199
199
|
/**
|
|
200
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
200
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
201
201
|
* @summary Refresh holdings for a connection
|
|
202
202
|
* @param {string} authorizationId The ID of a brokerage authorization object.
|
|
203
203
|
* @param {string} userId
|
|
@@ -409,7 +409,7 @@ const ConnectionsApiFp = function (configuration) {
|
|
|
409
409
|
});
|
|
410
410
|
},
|
|
411
411
|
/**
|
|
412
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
412
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
413
413
|
* @summary Refresh holdings for a connection
|
|
414
414
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
415
415
|
* @param {*} [options] Override http request option.
|
|
@@ -488,7 +488,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
|
|
|
488
488
|
return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
|
|
489
489
|
},
|
|
490
490
|
/**
|
|
491
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
491
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
492
492
|
* @summary Refresh holdings for a connection
|
|
493
493
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
494
494
|
* @param {*} [options] Override http request option.
|
|
@@ -561,7 +561,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
|
|
|
561
561
|
return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
562
562
|
}
|
|
563
563
|
/**
|
|
564
|
-
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
|
|
564
|
+
* Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
|
|
565
565
|
* @summary Refresh holdings for a connection
|
|
566
566
|
* @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
|
|
567
567
|
* @param {*} [options] Override http request option.
|
|
@@ -34,7 +34,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
34
34
|
*/
|
|
35
35
|
getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* Returns
|
|
37
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
38
38
|
* @summary Get symbol quotes
|
|
39
39
|
* @param {string} userId
|
|
40
40
|
* @param {string} userSecret
|
|
@@ -89,7 +89,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
|
|
|
89
89
|
*/
|
|
90
90
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
|
|
91
91
|
/**
|
|
92
|
-
* Returns
|
|
92
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
93
93
|
* @summary Get symbol quotes
|
|
94
94
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -135,7 +135,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
|
|
|
135
135
|
*/
|
|
136
136
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
|
|
137
137
|
/**
|
|
138
|
-
* Returns
|
|
138
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
139
139
|
* @summary Get symbol quotes
|
|
140
140
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
141
141
|
* @param {*} [options] Override http request option.
|
|
@@ -310,7 +310,7 @@ export declare class TradingApiGenerated extends BaseAPI {
|
|
|
310
310
|
*/
|
|
311
311
|
getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
|
|
312
312
|
/**
|
|
313
|
-
* Returns
|
|
313
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
314
314
|
* @summary Get symbol quotes
|
|
315
315
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
@@ -154,7 +154,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
|
|
|
154
154
|
};
|
|
155
155
|
}),
|
|
156
156
|
/**
|
|
157
|
-
* Returns
|
|
157
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
158
158
|
* @summary Get symbol quotes
|
|
159
159
|
* @param {string} userId
|
|
160
160
|
* @param {string} userSecret
|
|
@@ -385,7 +385,7 @@ const TradingApiFp = function (configuration) {
|
|
|
385
385
|
});
|
|
386
386
|
},
|
|
387
387
|
/**
|
|
388
|
-
* Returns
|
|
388
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
389
389
|
* @summary Get symbol quotes
|
|
390
390
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
391
391
|
* @param {*} [options] Override http request option.
|
|
@@ -468,7 +468,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
|
|
|
468
468
|
return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios, basePath));
|
|
469
469
|
},
|
|
470
470
|
/**
|
|
471
|
-
* Returns
|
|
471
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
472
472
|
* @summary Get symbol quotes
|
|
473
473
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
474
474
|
* @param {*} [options] Override http request option.
|
|
@@ -530,7 +530,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
|
|
|
530
530
|
return (0, exports.TradingApiFp)(this.configuration).getOrderImpact(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
531
531
|
}
|
|
532
532
|
/**
|
|
533
|
-
* Returns
|
|
533
|
+
* Returns quote(s) from the brokerage for the specified symbol(s).
|
|
534
534
|
* @summary Get symbol quotes
|
|
535
535
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
536
536
|
* @param {*} [options] Override http request option.
|