List account positions / SnapTrade

List account positions

get

https://api.snaptrade.com/api/v1/accounts/{accountId}/positions

Returns a list of stock/ETF/crypto/mutual fund positions in the specified account. For option positions, please use the options endpoint.

The data returned here is cached. How long the data is cached for varies by brokerage. Check the brokerage integrations doc and look for "Cache Expiry Time" to see the exact value for a specific brokerage. If you need real-time data, please use the manual refresh endpoint.

Execute an API Request

Path

accountIdstring (format: uuid)required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

Query

userIdstringrequired

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

userSecretstringrequired

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Authorization

clientId

consumerKey

Request

Installation

GitHub npm

npm install snaptrade-typescript-sdk

1
Loading...

Response fields

array of objects

object

Describes a single stock/ETF/crypto/mutual fund position in an account.

symbolobject

Uniquely describes a security for the position within an account. The distinction between this and the symbol child property is that this object is specific to a position within an account, while the symbol child property is universal across all brokerage accounts. The caller should rely on the symbol child property for most use cases.

symbolobject

Uniquely describes a single security + exchange combination across all brokerages.

idstring (format: uuid)

Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.

symbolstring

The security's trading ticker symbol. For example "AAPL" for Apple Inc. We largely follow the Yahoo Finance ticker format(click on "Yahoo Finance Market Coverage and Data Delays"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a '.TO' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.

raw_symbolstring

The raw symbol is symbol with the exchange suffix removed. For example, if symbol is "VAB.TO", then raw_symbol is "VAB".

descriptionstring or null

A human-readable description of the security. This is usually the company name or ETF name.

currencyobject

The currency in which the security is traded.

exchangeobject

The exchange on which the security is listed and traded.

typeobject

The type of security. For example, "Common Stock" or "ETF".

figi_codestring or null

This identifier is unique per security per trading venue. See section 1.4.1 of the FIGI Standard for more information. This value should be the same as the figi_code in the figi_instrument child property.

figi_instrumentobject or null

Financial Instrument Global Identifier (FIGI) information for the security. See OpenFIGI for more information.

currenciesarray of objects

Deprecated

Refrain from usage of this field

This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.

idstring (format: uuid)

Deprecated

Refrain from usage of this field

A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.

descriptionstring

Deprecated

Refrain from usage of this field

This field is deprecated and the caller should use the symbol child property's description instead.

local_idstring or null

Deprecated

Refrain from usage of this field

This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.

is_quotableboolean

Deprecated

Refrain from usage of this field

This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.

is_tradableboolean

Deprecated

Refrain from usage of this field

This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid usecase for this.

unitsnumber or null

The number of shares of the position. This can be fractional or integer units.

pricenumber or null

Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.

open_pnlnumber or null

The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.

average_purchase_pricenumber or null

Cost basis per share of this position.

fractional_unitsnumber or null

Deprecated

Refrain from usage of this field

Deprecated, use the units field for both fractional and integer units going forward

1
[
2
  {
3
    "symbol": {
4
      "symbol": {
5
        "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
6
        "symbol": "VAB.TO",
7
        "raw_symbol": "VAB",
8
        "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
9
        "currency": {
10
          "id": "87b24961-b51e-4db8-9226-f198f6518a89",
11
          "code": "USD",
12
          "name": "US Dollar"
13
        },
14
        "exchange": {
15
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
16
          "code": "TSX",
17
          "mic_code": "XTSE",
18
          "name": "Toronto Stock Exchange",
19
          "timezone": "America/New_York",
20
          "start_time": "09:30:00",
21
          "close_time": "16:00:00",
22
          "suffix": ".TO"
23
        },
24
        "type": {
25
          "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
26
          "code": "cs",
27
          "description": "Common Stock",
28
          "is_supported": true
29
        },
30
        "figi_code": "BBG000B9XRY4",
31
        "figi_instrument": {
32
          "figi_code": "BBG000B9Y5X2",
33
          "figi_share_class": "BBG001S5N8V8"
34
        },
35
        "currencies": [
36
          {
37
            "id": "87b24961-b51e-4db8-9226-f198f6518a89",
38
            "code": "USD",
39
            "name": "US Dollar"
40
          }
41
        ]
42
      },
43
      "id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
44
      "description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
45
      "local_id": "3291231",
46
      "is_quotable": true,
47
      "is_tradable": true
48
    },
49
    "units": 40,
50
    "price": 113.15,
51
    "open_pnl": 0.44,
52
    "average_purchase_price": 108.3353,
53
    "fractional_units": 1.44
54
  }
55
]

Made with Konfig