snaptrade-typescript-sdk 9.0.31 → 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 +2 -6
- package/dist/api/account-information-api-generated.d.ts +10 -10
- package/dist/api/account-information-api-generated.js +9 -9
- 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/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>
|
|
@@ -386,9 +386,7 @@ The ID of the account to get positions.
|
|
|
386
386
|
|
|
387
387
|
### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
|
|
388
388
|
|
|
389
|
-
Lists balances, positions and orders for the specified account
|
|
390
|
-
option_positions and account metadata. The data returned is similar to the
|
|
391
|
-
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.__
|
|
392
390
|
|
|
393
391
|
|
|
394
392
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
|
@@ -406,8 +404,6 @@ const getUserHoldingsResponse =
|
|
|
406
404
|
|
|
407
405
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
408
406
|
|
|
409
|
-
The ID of the account to fetch holdings for.
|
|
410
|
-
|
|
411
407
|
##### userId: `string`<a id="userid-string"></a>
|
|
412
408
|
|
|
413
409
|
##### userSecret: `string`<a id="usersecret-string"></a>
|
|
@@ -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.
|
|
@@ -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}
|
|
@@ -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
|
*/
|
|
@@ -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}
|
|
@@ -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.
|
|
@@ -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}
|
|
@@ -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}
|
|
@@ -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}
|