snaptrade-typescript-sdk 9.0.194 → 9.0.196
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 +7 -5
- package/dist/api/account-information-api-generated.d.ts +12 -8
- package/dist/api/account-information-api-generated.js +12 -8
- package/dist/api/trading-api-generated.d.ts +6 -6
- package/dist/api/trading-api-generated.js +5 -5
- package/dist/browser.js +1 -1
- package/dist/configuration.js +1 -1
- package/dist/models/account-position.d.ts +1 -1
- package/dist/models/future-instrument.d.ts +1 -1
- package/dist/models/option-instrument.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Connect brokerage accounts to your app for live positions and trading
|
|
8
8
|
|
|
9
|
-
[](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.196)
|
|
10
10
|
[](https://snaptrade.com/)
|
|
11
11
|
|
|
12
12
|
</div>
|
|
@@ -309,7 +309,7 @@ Returns a list of all positions in the specified account.
|
|
|
309
309
|
|
|
310
310
|
The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position's `instrument`.
|
|
311
311
|
|
|
312
|
-
|
|
312
|
+
`mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account.
|
|
313
313
|
|
|
314
314
|
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.
|
|
315
315
|
|
|
@@ -710,8 +710,10 @@ Optional comma separated list of rate-of-return timeframes to return. Supported
|
|
|
710
710
|
|
|
711
711
|
|
|
712
712
|
### `snaptrade.accountInformation.getUserHoldings`<a id="snaptradeaccountinformationgetuserholdings"></a>
|
|
713
|
+
|
|
713
714
|
|
|
714
|
-
|
|
715
|
+
**Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders).
|
|
716
|
+
Returns a list of balances, positions, and recent orders for the specified account.
|
|
715
717
|
|
|
716
718
|
Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access:
|
|
717
719
|
- If you do, this endpoint returns real-time data.
|
|
@@ -2281,7 +2283,7 @@ The OCC-formatted option symbol.
|
|
|
2281
2283
|
|
|
2282
2284
|
### `snaptrade.trading.getUserAccountQuotes`<a id="snaptradetradinggetuseraccountquotes"></a>
|
|
2283
2285
|
|
|
2284
|
-
Returns quotes from the brokerage for the specified symbols and account.
|
|
2286
|
+
Returns a maximum of 10 quotes from the brokerage for the specified symbols and account.
|
|
2285
2287
|
|
|
2286
2288
|
The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint.
|
|
2287
2289
|
|
|
@@ -2312,7 +2314,7 @@ const getUserAccountQuotesResponse =
|
|
|
2312
2314
|
|
|
2313
2315
|
##### symbols: `string`<a id="symbols-string"></a>
|
|
2314
2316
|
|
|
2315
|
-
List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
|
2317
|
+
List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
2316
2318
|
|
|
2317
2319
|
##### accountId: `string`<a id="accountid-string"></a>
|
|
2318
2320
|
|
|
@@ -44,7 +44,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
44
44
|
*/
|
|
45
45
|
getAccountBalanceHistory: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
47
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
48
48
|
* @summary List all account positions
|
|
49
49
|
* @param {string} userId
|
|
50
50
|
* @param {string} userSecret
|
|
@@ -140,12 +140,13 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
|
|
|
140
140
|
*/
|
|
141
141
|
getUserAccountReturnRates: (userId: string, userSecret: string, accountId: string, timeframes?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
142
|
/**
|
|
143
|
-
*
|
|
143
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
144
144
|
* @summary List account holdings
|
|
145
145
|
* @param {string} accountId
|
|
146
146
|
* @param {string} userId
|
|
147
147
|
* @param {string} userSecret
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
|
+
* @deprecated
|
|
149
150
|
* @throws {RequiredError}
|
|
150
151
|
*/
|
|
151
152
|
getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -192,7 +193,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
192
193
|
*/
|
|
193
194
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountValueHistoryResponse>>;
|
|
194
195
|
/**
|
|
195
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
196
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
196
197
|
* @summary List all account positions
|
|
197
198
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
198
199
|
* @param {*} [options] Override http request option.
|
|
@@ -265,10 +266,11 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
|
|
|
265
266
|
*/
|
|
266
267
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RateOfReturnResponse>>;
|
|
267
268
|
/**
|
|
268
|
-
*
|
|
269
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
269
270
|
* @summary List account holdings
|
|
270
271
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
271
272
|
* @param {*} [options] Override http request option.
|
|
273
|
+
* @deprecated
|
|
272
274
|
* @throws {RequiredError}
|
|
273
275
|
*/
|
|
274
276
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
|
|
@@ -312,7 +314,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
312
314
|
*/
|
|
313
315
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<AccountValueHistoryResponse>;
|
|
314
316
|
/**
|
|
315
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
317
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
316
318
|
* @summary List all account positions
|
|
317
319
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
318
320
|
* @param {*} [options] Override http request option.
|
|
@@ -385,10 +387,11 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
|
|
|
385
387
|
*/
|
|
386
388
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): AxiosPromise<RateOfReturnResponse>;
|
|
387
389
|
/**
|
|
388
|
-
*
|
|
390
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
389
391
|
* @summary List account holdings
|
|
390
392
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
391
393
|
* @param {*} [options] Override http request option.
|
|
394
|
+
* @deprecated
|
|
392
395
|
* @throws {RequiredError}
|
|
393
396
|
*/
|
|
394
397
|
getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
|
|
@@ -834,7 +837,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
834
837
|
*/
|
|
835
838
|
getAccountBalanceHistory(requestParameters: AccountInformationApiGetAccountBalanceHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountValueHistoryResponse, any, {}>>;
|
|
836
839
|
/**
|
|
837
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
840
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
838
841
|
* @summary List all account positions
|
|
839
842
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
840
843
|
* @param {*} [options] Override http request option.
|
|
@@ -916,10 +919,11 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
|
|
|
916
919
|
*/
|
|
917
920
|
getUserAccountReturnRates(requestParameters: AccountInformationApiGetUserAccountReturnRatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RateOfReturnResponse, any, {}>>;
|
|
918
921
|
/**
|
|
919
|
-
*
|
|
922
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
920
923
|
* @summary List account holdings
|
|
921
924
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
922
925
|
* @param {*} [options] Override http request option.
|
|
926
|
+
* @deprecated
|
|
923
927
|
* @throws {RequiredError}
|
|
924
928
|
* @memberof AccountInformationApiGenerated
|
|
925
929
|
*/
|
|
@@ -170,7 +170,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
170
170
|
};
|
|
171
171
|
}),
|
|
172
172
|
/**
|
|
173
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
173
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
174
174
|
* @summary List all account positions
|
|
175
175
|
* @param {string} userId
|
|
176
176
|
* @param {string} userSecret
|
|
@@ -688,12 +688,13 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
|
|
|
688
688
|
};
|
|
689
689
|
}),
|
|
690
690
|
/**
|
|
691
|
-
*
|
|
691
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
692
692
|
* @summary List account holdings
|
|
693
693
|
* @param {string} accountId
|
|
694
694
|
* @param {string} userId
|
|
695
695
|
* @param {string} userSecret
|
|
696
696
|
* @param {*} [options] Override http request option.
|
|
697
|
+
* @deprecated
|
|
697
698
|
* @throws {RequiredError}
|
|
698
699
|
*/
|
|
699
700
|
getUserHoldings: (accountId, userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
@@ -886,7 +887,7 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
886
887
|
});
|
|
887
888
|
},
|
|
888
889
|
/**
|
|
889
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
890
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
890
891
|
* @summary List all account positions
|
|
891
892
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
892
893
|
* @param {*} [options] Override http request option.
|
|
@@ -1007,10 +1008,11 @@ const AccountInformationApiFp = function (configuration) {
|
|
|
1007
1008
|
});
|
|
1008
1009
|
},
|
|
1009
1010
|
/**
|
|
1010
|
-
*
|
|
1011
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
1011
1012
|
* @summary List account holdings
|
|
1012
1013
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
1013
1014
|
* @param {*} [options] Override http request option.
|
|
1015
|
+
* @deprecated
|
|
1014
1016
|
* @throws {RequiredError}
|
|
1015
1017
|
*/
|
|
1016
1018
|
getUserHoldings(requestParameters, options) {
|
|
@@ -1077,7 +1079,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1077
1079
|
return localVarFp.getAccountBalanceHistory(requestParameters, options).then((request) => request(axios, basePath));
|
|
1078
1080
|
},
|
|
1079
1081
|
/**
|
|
1080
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
1082
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
1081
1083
|
* @summary List all account positions
|
|
1082
1084
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
1083
1085
|
* @param {*} [options] Override http request option.
|
|
@@ -1168,10 +1170,11 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
|
|
|
1168
1170
|
return localVarFp.getUserAccountReturnRates(requestParameters, options).then((request) => request(axios, basePath));
|
|
1169
1171
|
},
|
|
1170
1172
|
/**
|
|
1171
|
-
*
|
|
1173
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
1172
1174
|
* @summary List account holdings
|
|
1173
1175
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
1174
1176
|
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @deprecated
|
|
1175
1178
|
* @throws {RequiredError}
|
|
1176
1179
|
*/
|
|
1177
1180
|
getUserHoldings(requestParameters, options) {
|
|
@@ -1231,7 +1234,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1231
1234
|
return (0, exports.AccountInformationApiFp)(this.configuration).getAccountBalanceHistory(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1232
1235
|
}
|
|
1233
1236
|
/**
|
|
1234
|
-
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`.
|
|
1237
|
+
* Returns a list of all positions in the specified account. The `results` list can contain multiple instrument types in the same response, including stocks, ADRs, ETFs, mutual funds, closed-end funds, crypto, futures, and option positions. Use the `instrument.kind` discriminator to determine the schema for each position\'s `instrument`. `mutualfund` positions may also include `cash_equivalent`. `stock` positions may include `tax_lots` when tax lot data is enabled for the account. 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.
|
|
1235
1238
|
* @summary List all account positions
|
|
1236
1239
|
* @param {AccountInformationApiGetAllAccountPositionsRequest} requestParameters Request parameters.
|
|
1237
1240
|
* @param {*} [options] Override http request option.
|
|
@@ -1331,10 +1334,11 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
|
|
|
1331
1334
|
return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountReturnRates(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1332
1335
|
}
|
|
1333
1336
|
/**
|
|
1334
|
-
*
|
|
1337
|
+
* **Deprecated.** Use the finer-grained account data endpoints instead: [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getAllAccountPositions), and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders). Returns a list of balances, positions, and recent orders for the specified account. Check your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing) to see if you have real-time data access: - If you do, this endpoint returns real-time data. - If you don\'t, the data is cached and refreshed once a day. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://support.snaptrade.com/brokerages-table?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. If you need real-time, use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint. 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.
|
|
1335
1338
|
* @summary List account holdings
|
|
1336
1339
|
* @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
|
|
1337
1340
|
* @param {*} [options] Override http request option.
|
|
1341
|
+
* @deprecated
|
|
1338
1342
|
* @throws {RequiredError}
|
|
1339
1343
|
* @memberof AccountInformationApiGenerated
|
|
1340
1344
|
*/
|
|
@@ -94,11 +94,11 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
|
|
|
94
94
|
*/
|
|
95
95
|
getUserAccountOptionQuotes: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
96
|
/**
|
|
97
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
97
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
98
98
|
* @summary Get equity symbol quotes
|
|
99
99
|
* @param {string} userId
|
|
100
100
|
* @param {string} userSecret
|
|
101
|
-
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
|
101
|
+
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
102
102
|
* @param {string} accountId
|
|
103
103
|
* @param {boolean} [useTicker] Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
@@ -260,7 +260,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
|
|
|
260
260
|
*/
|
|
261
261
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionQuote>>;
|
|
262
262
|
/**
|
|
263
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
263
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
264
264
|
* @summary Get equity symbol quotes
|
|
265
265
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
266
266
|
* @param {*} [options] Override http request option.
|
|
@@ -395,7 +395,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
|
|
|
395
395
|
*/
|
|
396
396
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<OptionQuote>;
|
|
397
397
|
/**
|
|
398
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
398
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
399
399
|
* @summary Get equity symbol quotes
|
|
400
400
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
401
401
|
* @param {*} [options] Override http request option.
|
|
@@ -650,7 +650,7 @@ export type TradingApiGetUserAccountQuotesRequest = {
|
|
|
650
650
|
*/
|
|
651
651
|
readonly userSecret: string;
|
|
652
652
|
/**
|
|
653
|
-
* List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
|
653
|
+
* List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
654
654
|
* @type {string}
|
|
655
655
|
* @memberof TradingApiGetUserAccountQuotes
|
|
656
656
|
*/
|
|
@@ -962,7 +962,7 @@ export declare class TradingApiGenerated extends BaseAPI {
|
|
|
962
962
|
*/
|
|
963
963
|
getUserAccountOptionQuotes(requestParameters: TradingApiGetUserAccountOptionQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionQuote, any, {}>>;
|
|
964
964
|
/**
|
|
965
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
965
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
966
966
|
* @summary Get equity symbol quotes
|
|
967
967
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
968
968
|
* @param {*} [options] Override http request option.
|
|
@@ -397,11 +397,11 @@ const TradingApiAxiosParamCreator = function (configuration) {
|
|
|
397
397
|
};
|
|
398
398
|
}),
|
|
399
399
|
/**
|
|
400
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
400
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
401
401
|
* @summary Get equity symbol quotes
|
|
402
402
|
* @param {string} userId
|
|
403
403
|
* @param {string} userSecret
|
|
404
|
-
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator
|
|
404
|
+
* @param {string} symbols List of Universal Symbol IDs or tickers to get quotes for. When providing multiple values, use a comma as separator. Maximum of 10 values allowed
|
|
405
405
|
* @param {string} accountId
|
|
406
406
|
* @param {boolean} [useTicker] Should be set to `True` if `symbols` are comprised of tickers. Defaults to `False` if not provided.
|
|
407
407
|
* @param {*} [options] Override http request option.
|
|
@@ -1121,7 +1121,7 @@ const TradingApiFp = function (configuration) {
|
|
|
1121
1121
|
});
|
|
1122
1122
|
},
|
|
1123
1123
|
/**
|
|
1124
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1124
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1125
1125
|
* @summary Get equity symbol quotes
|
|
1126
1126
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
1127
1127
|
* @param {*} [options] Override http request option.
|
|
@@ -1394,7 +1394,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
|
|
|
1394
1394
|
return localVarFp.getUserAccountOptionQuotes(requestParameters, options).then((request) => request(axios, basePath));
|
|
1395
1395
|
},
|
|
1396
1396
|
/**
|
|
1397
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1397
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1398
1398
|
* @summary Get equity symbol quotes
|
|
1399
1399
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
1400
1400
|
* @param {*} [options] Override http request option.
|
|
@@ -1571,7 +1571,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
|
|
|
1571
1571
|
return (0, exports.TradingApiFp)(this.configuration).getUserAccountOptionQuotes(requestParameters, options).then((request) => request(this.axios, this.basePath));
|
|
1572
1572
|
}
|
|
1573
1573
|
/**
|
|
1574
|
-
* Returns quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1574
|
+
* Returns a maximum of 10 quotes from the brokerage for the specified symbols and account. The quotes returned can be delayed depending on the brokerage the account belongs to. It is highly recommended that you use your own market data provider for real-time quotes instead of relying on this endpoint. **This endpoint is not a substitute for a market data provider. Frequent polling of this endpoint may result in the disabling of your keys** This endpoint does not work for options quotes. This endpoint is disabled for free plans by default. Please contact support to enable this endpoint if needed.
|
|
1575
1575
|
* @summary Get equity symbol quotes
|
|
1576
1576
|
* @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
|
|
1577
1577
|
* @param {*} [options] Override http request option.
|