Retrieve Investment Holdings

POST /processor/investments/holdings/get

This endpoint returns the stock position data of the account associated with a given processor token.

Request Body

Required

ProcessorInvestmentsHoldingsGetRequest defines the request schema for /processor/investments/holdings/get

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
processor_token
required, string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Response

ProcessorInvestmentsHoldingsGetResponse defines the response schema for /processor/invesments/holdings/get

Response Properties

account
required, object
A single account at a financial institution.
account_id
required, string
Plaid’s unique identifier for the account. This value will not change unless Plaid can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new account_id will be assigned to the account. The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id. If an account with a specific account_id disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. When using a CRA endpoint (an endpoint associated with Plaid Check Consumer Report, i.e. any endpoint beginning with /cra/), the account_id returned will not match the account_id returned by a non-CRA endpoint. Like all Plaid identifiers, the account_id is case sensitive.
balances
required, object
A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by /accounts/balance/get.
available
required, number
The amount of funds available to be withdrawn from the account, as determined by the financial institution. For credit-type accounts, the available balance typically equals the limit less the current balance, less any pending outflows plus any pending inflows. For depository-type accounts, the available balance typically equals the current balance less any pending outflows plus any pending inflows. For depository-type accounts, the available balance does not include the overdraft limit. For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the available balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the available balance. In the event that available balance is unavailable, Plaid will return an available balance value of null. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /accounts/balance/get. If current is null this field is guaranteed not to be null.
current
required, number
The total amount of funds in or owed by the account. For credit-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For loan-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944). For Sallie Mae student loans, the account’s balance includes both principal and any outstanding interest. Similar to credit-type accounts, a positive balance is typically expected, while a negative amount indicates the lender owing the account holder. For investment-type accounts (or brokerage-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by /accounts/balance/get; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available balance as provided by /accounts/balance/get. When returned by /accounts/balance/get, this field may be null. When this happens, available is guaranteed not to be null.
limit
required, number
For credit-type accounts, this represents the credit limit. For depository-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for credit-type accounts.
iso_currency_code
required, string
The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
required, string
The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported unofficial_currency_codes.
last_updated_datetime
string
Timestamp in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time the balance was updated. This field is returned only when the institution is ins_128026 (Capital One).
mask
required, string
The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.
name
required, string
The name of the account, either assigned by the user or by the financial institution itself
official_name
required, string
The official name of the account as given by the financial institution
type
required, string
investment: Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage instead. credit: Credit card depository: Depository account loan: Loan account other: Non-specified account type See the Account type schema for a full listing of account types and corresponding subtypes.
subtype
required, string
See the Account type schema for a full listing of account types and corresponding subtypes.
verification_status
string
The current verification status of an Auth Item initiated through micro-deposits or database verification. Returned for Auth Items only. pending_automatic_verification: The Item is pending automatic verification pending_manual_verification: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit. automatically_verified: The Item has successfully been automatically verified manually_verified: The Item has successfully been manually verified verification_expired: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. verification_failed: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. unsent: The Item is pending micro-deposit verification, but Plaid has not yet sent the micro-deposit. database_matched: The Item has successfully been verified using Plaid’s data sources. Only returned for Auth Items created via Database Match. database_insights_pass: The Item’s numbers have been verified using Plaid’s data sources: the routing and account number match a routing and account number of an account recognized on the Plaid network, and the account is not known by Plaid to be frozen or closed. Only returned for Auth Items created via Database Auth. database_insights_pass_with_caution:The Item’s numbers have been verified using Plaid’s data sources and have some signal for being valid: the routing and account number were not recognized on the Plaid network, but the routing number is valid and the account number is a potential valid account number for that routing number. Only returned for Auth Items created via Database Auth. database_insights_fail: The Item’s numbers have been verified using Plaid’s data sources and have signal for being invalid and/or have no signal for being valid. Typically this indicates that the routing number is invalid, the account number does not match the account number format associated with the routing number, or the account has been reported as closed or frozen. Only returned for Auth Items created via Database Auth.
verification_name
string
The account holder name that was used for micro-deposit and/or database verification. Only returned for Auth Items created via micro-deposit or database verification. This name was manually-entered by the user during Link, unless it was otherwise provided via the user.legal_name request field in /link/token/create for the Link session that created the Item.
verification_insights
object
Insights from performing database verification for the account. Only returned for Auth Items using Database Auth.
name_match_score
integer
Indicates the score of the name match between the given name provided during database verification (available in the verification_name field) and matched Plaid network accounts. If defined, will be a value between 0 and 100. Will be undefined if name matching was not enabled for the database verification session or if there were no eligible Plaid network matches to compare the given name with.
network_status
required, object
Status information about the account and routing number in the Plaid network.
has_numbers_match
required, boolean
Indicates whether we found at least one matching account for the ACH account and routing number.
is_numbers_match_verified
required, boolean
Indicates if at least one matching account for the ACH account and routing number is already verified.
previous_returns
object
Information about known ACH returns for the account and routing number.
has_previous_administrative_return
required, boolean
Indicates whether Plaid’s data sources include a known administrative ACH return for account and routing number.
account_number_format
required, string
Indicator of account number format validity for institution. valid: indicates that the account number has a correct format for the institution. invalid: indicates that the account number has an incorrect format for the institution. unknown: indicates that there was not enough information to determine whether the format is correct for the institution.
persistent_account_id
string
A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This field is currently supported only for Items at institutions that use Tokenized Account Numbers (i.e., Chase and PNC, and in May 2025 US Bank). Because these accounts have a different account number each time they are linked, this field may be used instead of the account number to uniquely identify an account across multiple Items for payments use cases, helping to reduce duplicate Items or attempted fraud. In Sandbox, this field is populated for TAN-based institutions (ins_56, ins_13) as well as the OAuth Sandbox institution (ins_127287); in Production, it will only be populated for accounts at applicable institutions.
holder_category
string
Indicates the account’s categorization as either a personal or a business account. This field is currently in beta; to request access, contact your account manager.
holdings
required, array[object]
The holdings belonging to investment accounts associated with the Item. Details of the securities in the holdings are provided in the securities field.
account_id
required, string
The Plaid account_id associated with the holding.
security_id
required, string
The Plaid security_id associated with the holding. Security data is not specific to a user’s account; any user who held the same security at the same financial institution at the same time would have identical security data. The security_id for the same security will typically be the same across different institutions, but this is not guaranteed. The security_id does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
institution_price
required, number
The last price given by the institution for this security.
institution_price_as_of
string
The date at which institution_price was current.
institution_price_datetime
string
Date and time at which institution_price was current, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).
institution_value
required, number
The value of the holding, as reported by the institution.
cost_basis
required, number
The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding).
quantity
required, number
The total quantity of the asset held, as reported by the financial institution. If the security is an option, quantity will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.
iso_currency_code
required, string
The ISO-4217 currency code of the holding. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
required, string
The unofficial currency code associated with the holding. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported iso_currency_codes.
vested_quantity
number
The total quantity of vested assets held, as reported by the financial institution. Vested assets are only associated with equities.
vested_value
number
The value of the vested holdings as reported by the institution.
securities
required, array[object]
Objects describing the securities held in the account.
security_id
required, string
A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the security_id is case sensitive. The security_id may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
isin
required, string
12-character ISIN, a globally unique securities identifier. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here.
cusip
required, string
9-character CUSIP, an identifier assigned to North American securities. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here.
sedol
required, string
(Deprecated) 7-character SEDOL, an identifier assigned to securities in the UK.
institution_security_id
required, string
An identifier given to the security by the institution
institution_id
required, string
If institution_security_id is present, this field indicates the Plaid institution_id of the institution to whom the identifier belongs.
proxy_security_id
required, string
In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security.
name
required, string
A descriptive name for the security, suitable for display.
ticker_symbol
required, string
The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
is_cash_equivalent
required, boolean
Indicates that a security is a highly liquid asset and can be treated like cash.
type
required, string
The security type of the holding. In rare instances, a null value is returned when institutional data is insufficient to determine the security type. Valid security types are: cash: Cash, currency, and money market funds cryptocurrency: Digital or virtual currencies derivative: Options, warrants, and other derivative instruments equity: Domestic and foreign equities etf: Multi-asset exchange-traded investment funds fixed income: Bonds and certificates of deposit (CDs) loan: Loans and loan receivables mutual fund: Open- and closed-end vehicles pooling funds of multiple investors other: Unknown or other investment types
subtype
string
The security subtype of the holding. In rare instances, a null value is returned when institutional data is insufficient to determine the security subtype. Possible values: asset backed security, bill, bond, bond with warrants, cash, cash management bill, common stock, convertible bond, convertible equity, cryptocurrency, depositary receipt, depositary receipt on debt, etf, float rating note, fund of funds, hedge fund, limited partnership unit, medium term note, money market debt, mortgage backed security, municipal bond, mutual fund, note, option, other, preferred convertible, preferred equity, private equity fund, real estate investment trust, structured equity product, treasury inflation protected securities, unit, warrant.
close_price
required, number
Price of the security at the close of the previous trading session. Null for non-public securities. If the security is a foreign currency this field will be updated daily and will be priced in USD. If the security is a cryptocurrency, this field will be updated multiple times a day. As crypto prices can fluctuate quickly and data may become stale sooner than other asset classes, refer to update_datetime with the time when the price was last updated.
close_price_as_of
required, string
Date for which close_price is accurate. Always null if close_price is null.
update_datetime
string
Date and time at which close_price is accurate, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Always null if close_price is null.
iso_currency_code
required, string
The ISO-4217 currency code of the price given. Always null if unofficial_currency_code is non-null.
unofficial_currency_code
required, string
The unofficial currency code associated with the security. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the currency code schema for a full listing of supported iso_currency_codes.
market_identifier_code
required, string
The ISO-10383 Market Identifier Code of the exchange or market in which the security is being traded.
sector
required, string
The sector classification of the security, such as Finance, Health Technology, etc. For a complete list of possible values, please refer to the “Sectors and Industries” spreadsheet.
industry
required, string
The industry classification of the security, such as Biotechnology, Airlines, etc. For a complete list of possible values, please refer to the “Sectors and Industries” spreadsheet.
option_contract
required, object
Details about the option security. For the Sandbox environment, this data is currently only available if the Item is using a custom Sandbox user and the ticker field of the custom security follows the OCC Option Symbol standard with no spaces. For an example of simulating this in Sandbox, see the custom Sandbox GitHub.
contract_type
required, string
The type of this option contract. It is one of: put: for Put option contracts call: for Call option contracts
expiration_date
required, string
The expiration date for this option contract, in ISO 8601 format.
strike_price
required, number
The strike price for this option contract, per share of security.
underlying_security_ticker
required, string
The ticker of the underlying security for this option contract.
fixed_income
required, object
Details about the fixed income security.
yield_rate
required, object
Details about a fixed income security’s expected rate of return.
percentage
required, number
The fixed income security’s expected rate of return.
type
required, string
The type of rate which indicates how the predicted yield was calculated. It is one of: coupon: the annualized interest rate for securities with a one-year term or longer, such as treasury notes and bonds. coupon_equivalent: the calculated equivalent for the annualized interest rate factoring in the discount rate and time to maturity, for shorter term, non-interest-bearing securities such as treasury bills. discount: the rate at which the present value or cost is discounted from the future value upon maturity, also known as the face value. yield: the total predicted rate of return factoring in both the discount rate and the coupon rate, applicable to securities such as exchange-traded bonds which can both be interest-bearing as well as sold at a discount off its face value.
maturity_date
required, string
The maturity date for this fixed income security, in ISO 8601 format.
issue_date
required, string
The issue date for this fixed income security, in ISO 8601 format.
face_value
required, number
The face value that is paid upon maturity of the fixed income security, per unit of security.
is_investments_fallback_item
required, boolean
When true, this field indicates that the Item’s portfolio was manually created with the Investments Fallback flow.
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.