Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .konfig/generate-id.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
abbb8013-12ad-463f-8d0f-bf12ddab20dd
39c44306-5966-45e8-a0fd-720c44d87ab5
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,13 +309,13 @@ $result = $snaptrade->accountInformation->getAllAccountPositions(
### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

**Deprecated, please use the account-specific holdings endpoint instead.**
**Deprecated.** Use the account-specific holdings endpoint instead.

This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.

List all accounts for the user, plus balances, positions, and orders for each
account.

**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.



#### 🛠️ Usage<a id="🛠️-usage"></a>
Expand Down Expand Up @@ -546,9 +546,9 @@ Number of days in the past to fetch the most recent orders. Defaults to the last
### `snaptrade.accountInformation.getUserAccountPositions`<a id="snaptradeaccountinformationgetuseraccountpositions"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).
**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.

This endpoint is deprecated. Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the [options endpoint](/reference/Options/Options_listOptionHoldings).

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.
Expand Down Expand Up @@ -683,6 +683,9 @@ Optional comma separated list of rate-of-return timeframes to return. Supported
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

**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).

This endpoint will return HTTP 410 Gone for all customers that sign up after May 11, 2026.

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:
Expand Down Expand Up @@ -1688,9 +1691,9 @@ $result = $snaptrade->experimentalEndpoints->listSubscriptions();
### `snaptrade.options.listOptionHoldings`<a id="snaptradeoptionslistoptionholdings"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).
**Deprecated.** Use the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions) instead. This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.

This endpoint is deprecated. Consider using the newer [unified positions endpoint](/reference/Account%20Information/AccountInformation_getAllAccountPositions). This will allow you to get both equity and option positions in a single call, as well as additional asset classes such as futures.
Returns a list of option positions in the specified account. For stock/ETF/crypto/mutual fund positions, please use the [positions endpoint](/reference/Account%20Information/AccountInformation_getUserAccountPositions).

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.
Expand Down Expand Up @@ -2138,7 +2141,8 @@ Order ID returned by brokerage. This is the unique identifier for the order in t
### `snaptrade.trading.cancelUserAccountOrder`<a id="snaptradetradingcanceluseraccountorder"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

**This endpoint is deprecated. Please switch to [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) **
**Deprecated.** Use [the new cancel order endpoint](/reference/Trading/Trading_cancelOrder) instead.

Attempts to cancel an open order with the brokerage. If the order is no longer cancellable, the request will be rejected.


Expand Down Expand Up @@ -2414,8 +2418,6 @@ The quotes returned can be delayed depending on the brokerage the account belong

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.



#### 🛠️ Usage<a id="🛠️-usage"></a>
Expand Down Expand Up @@ -2463,7 +2465,8 @@ Should be set to `True` if `symbols` are comprised of tickers. Defaults to `Fals
### `snaptrade.trading.placeBracketOrder`<a id="snaptradetradingplacebracketorder"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

**This endpoint is deprecated. Please switch to [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) **
**Deprecated.** Use [the new complex order endpoint](/reference/Trading/Trading_placeComplexOrder) instead.

Places a bracket order (entry order + OCO of stop loss and take profit). Disabled by default please contact support for
use. Only supported on certain brokerages

Expand Down Expand Up @@ -3111,16 +3114,16 @@ $result = $snaptrade->trading->searchCryptocurrencyPairInstruments(
### `snaptrade.transactionsAndReporting.getActivities`<a id="snaptradetransactionsandreportinggetactivities"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

This endpoint is being deprecated but will continue to be available for use via SDKs, please use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) if possible
**Deprecated.** Use [the account level endpoint](/reference/Account%20Information/AccountInformation_getAccountActivities) instead, if possible.

This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.

Returns all historical transactions for the specified user and filtering criteria. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.

There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.

This endpoint returns Daily data. Daily data is cached and refreshed once a day. Exact refresh timing may vary by brokerage.

**Note:** This endpoint will return HTTP 410 Gone for all customers that sign up after April 25, 2026.



#### 🛠️ Usage<a id="🛠️-usage"></a>
Expand Down Expand Up @@ -3180,7 +3183,8 @@ Optional comma separated list of transaction types to filter by. SnapTrade does
### `snaptrade.transactionsAndReporting.getReportingCustomRange`<a id="snaptradetransactionsandreportinggetreportingcustomrange"></a>
![Deprecated](https://img.shields.io/badge/deprecated-yellow)

Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
**Deprecated.** Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.



#### 🛠️ Usage<a id="🛠️-usage"></a>
Expand Down
Loading