Investments
API reference for Investments endpoints and webhooks
Endpoints | |
---|---|
/investments/holdings/get | Fetch investment holdings |
/investments/transactions/get | Fetch investment transactions |
/investments/refresh | Refresh investment transactions |
Webhooks | |
---|---|
HOLDINGS: DEFAULT_UPDATE | New holdings available |
INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE | New transactions available |
INVESTMENTS_TRANSACTIONS: HISTORICAL_UPDATE | Investments data ready |
Endpoints
/investments/holdings/get
Get Investment holdings
The /investments/holdings/get
endpoint allows developers to receive user-authorized stock position data for investment
-type accounts.
client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.access_token
options
/investments/holdings/get
results. If provided, must not be null
.account_ids
account_id
s to retrieve for the Item. An error will be returned if a provided account_id
is not associated with the Item.1// Pull Holdings for an Item2const request: InvestmentsHoldingsGetRequest = {3 access_token: accessToken,4};5try {6 const response = await plaidClient.investmentsHoldingsGet(request);7 const holdings = response.data.holdings;8 const securities = response.data.securities;9} catch (error) {10 // handle error11}
Response fields and example
accounts
account_id
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.Like all Plaid identifiers, the
account_id
is case sensitive.balances
/accounts/balance/get
.available
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
.double
current
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.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
.double
limit
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.double
iso_currency_code
unofficial_currency_code
is non-null.unofficial_currency _code
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_code
s.last_updated_datetime
YYYY-MM-DDTHH:mm:ssZ
) indicating the oldest acceptable balance when making a request to /accounts/balance/get
.This field is only used and expected when the institution is
ins_128026
(Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST
error with the code of INVALID_FIELD
will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST
error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE
will be returned with the most recent timestamp for the requested account contained in the response.date-time
mask
name
official_name
type
investment:
Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage
instead.credit:
Credit carddepository:
Depository accountloan:
Loan accountother:
Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
investment
, credit
, depository
, loan
, brokerage
, other
subtype
401a
, 401k
, 403B
, 457b
, 529
, auto
, brokerage
, business
, cash isa
, cash management
, cd
, checking
, commercial
, construction
, consumer
, credit card
, crypto exchange
, ebt
, education savings account
, fixed annuity
, gic
, health reimbursement arrangement
, home equity
, hsa
, isa
, ira
, keogh
, lif
, life insurance
, line of credit
, lira
, loan
, lrif
, lrsp
, money market
, mortgage
, mutual fund
, non-custodial wallet
, non-taxable brokerage account
, other
, other insurance
, other annuity
, overdraft
, paypal
, payroll
, pension
, prepaid
, prif
, profit sharing plan
, rdsp
, resp
, retirement
, rlif
, roth
, roth 401k
, rrif
, rrsp
, sarsep
, savings
, sep ira
, simple ira
, sipp
, stock plan
, student
, thrift savings plan
, tfsa
, trust
, ugma
, utma
, variable annuity
verification_status
pending_automatic_verification
: The Item is pending automatic verificationpending_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 verifiedverification_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.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 and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution
: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.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. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.automatically_verified
, pending_automatic_verification
, pending_manual_verification
, manually_verified
, verification_expired
, verification_failed
, database_matched
, database_insights_pass
, database_insights_pass_with_caution
, database_insights_fail
verification_insights
network_status
has_numbers_match
is_numbers_match _verified
previous_returns
has_previous _administrative_return
account_number_format
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.valid
, invalid
, unknown
persistent_account_id
holder_category
business
, personal
, unrecognized
holdings
securities
field.account_id
account_id
associated with the holding.security_id
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
double
institution_price_as _of
institution_price
was current.date
institution_price _datetime
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).
date-time
institution_value
double
cost_basis
double
quantity
quantity
will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.double
iso_currency_code
null
if unofficial_currency_code
is non-null
.unofficial_currency _code
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_code
s.vested_quantity
double
vested_value
double
securities
security_id
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
cusip
sedol
institution_security _id
institution_id
institution_security_id
is present, this field indicates the Plaid institution_id
of the institution to whom the identifier belongs.proxy_security_id
name
ticker_symbol
is_cash_equivalent
type
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 fundscryptocurrency
: Digital or virtual currenciesderivative
: Options, warrants, and other derivative instrumentsequity
: Domestic and foreign equitiesetf
: Multi-asset exchange-traded investment fundsfixed income
: Bonds and certificates of deposit (CDs)loan
: Loans and loan receivablesmutual fund
: Open- and closed-end vehicles pooling funds of multiple investorsother
: Unknown or other investment typesclose_price
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.double
close_price_as_of
close_price
is accurate. Always null
if close_price
is null
.date
update_datetime
close_price
is accurate, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Always null
if close_price
is null
.date-time
iso_currency_code
null
if unofficial_currency_code
is non-null
.unofficial_currency _code
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_code
s.market_identifier_code
sector
For a complete list of possible values, please refer to the "Sectors and Industries" spreadsheet.
industry
For a complete list of possible values, please refer to the "Sectors and Industries" spreadsheet.
option_contract
For the Sandbox environment, this data is currently only available if the item is using a custom configuration object, and the
ticker
field of the custom security follows the OCC Option Symbol standard with no spaces.contract_type
put
: for Put option contractscall
: for Call option contractsexpiration_date
strike_price
double
underlying_security _ticker
item
item_id
item_id
is always unique; linking the same account at the same institution twice will result in two Items with different item_id
values. Like all Plaid identifiers, the item_id
is case-sensitive.institution_id
null
for Items created without an institution connection, such as Items created via Same Day Micro-deposits.institution_name
null
for Items created without an institution connection, such as Items created via Same Day Micro-deposits.webhook
error
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
available_products
billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
billed_products
available_products
. Note - billed_products
is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance
, will not appear here.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
products
billed_products
field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create
has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products
but not in billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
consented_products
assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, transactions
, income
, income_verification
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_cashflow_insights
, layer
consent_expiration _time
date-time
update_type
background
- Item can be updated in the backgrounduser_present_required
- Item requires user interaction to be updatedbackground
, user_present_required
request_id
is_investments _fallback_item
1{2 "accounts": [3 {4 "account_id": "5Bvpj4QknlhVWk7GygpwfVKdd133GoCxB814g",5 "balances": {6 "available": 43200,7 "current": 43200,8 "iso_currency_code": "USD",9 "limit": null,10 "unofficial_currency_code": null11 },12 "mask": "4444",13 "name": "Plaid Money Market",14 "official_name": "Plaid Platinum Standard 1.85% Interest Money Market",15 "subtype": "money market",16 "type": "depository"17 },18 {19 "account_id": "JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1",20 "balances": {21 "available": null,22 "current": 110.01,23 "iso_currency_code": "USD",24 "limit": null,25 "unofficial_currency_code": null26 },27 "mask": "5555",28 "name": "Plaid IRA",29 "official_name": null,30 "subtype": "ira",31 "type": "investment"32 },33 {34 "account_id": "k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm",35 "balances": {36 "available": null,37 "current": 23631.9805,38 "iso_currency_code": "USD",39 "limit": null,40 "unofficial_currency_code": null41 },42 "mask": "6666",43 "name": "Plaid 401k",44 "official_name": null,45 "subtype": "401k",46 "type": "investment"47 },48 {49 "account_id": "ax0xgOBYRAIqOOjeLZr0iZBb8r6K88HZXpvmq",50 "balances": {51 "available": 48200.03,52 "current": 48200.03,53 "iso_currency_code": "USD",54 "limit": null,55 "unofficial_currency_code": null56 },57 "mask": "4092",58 "name": "Plaid Crypto Exchange Account",59 "official_name": null,60 "subtype": "crypto exchange",61 "type": "investment"62 }63 ],64 "holdings": [65 {66 "account_id": "JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1",67 "cost_basis": 1,68 "institution_price": 1,69 "institution_price_as_of": "2021-04-13",70 "institution_price_datetime": null,71 "institution_value": 0.01,72 "iso_currency_code": "USD",73 "quantity": 0.01,74 "security_id": "d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are",75 "unofficial_currency_code": null76 },77 {78 "account_id": "k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm",79 "cost_basis": 1.5,80 "institution_price": 2.11,81 "institution_price_as_of": "2021-04-13",82 "institution_price_datetime": null,83 "institution_value": 2.11,84 "iso_currency_code": "USD",85 "quantity": 1,86 "security_id": "KDwjlXj1Rqt58dVvmzRguxJybmyQL8FgeWWAy",87 "unofficial_currency_code": null88 },89 {90 "account_id": "k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm",91 "cost_basis": 10,92 "institution_price": 10.42,93 "institution_price_as_of": "2021-04-13",94 "institution_price_datetime": null,95 "institution_value": 20.84,96 "iso_currency_code": "USD",97 "quantity": 2,98 "security_id": "NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk",99 "unofficial_currency_code": null100 },101 {102 "account_id": "JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1",103 "cost_basis": 0.01,104 "institution_price": 0.011,105 "institution_price_as_of": "2021-04-13",106 "institution_price_datetime": null,107 "institution_value": 110,108 "iso_currency_code": "USD",109 "quantity": 10000,110 "security_id": "8E4L9XLl6MudjEpwPAAgivmdZRdBPJuvMPlPb",111 "unofficial_currency_code": null112 },113 {114 "account_id": "k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm",115 "cost_basis": 23,116 "institution_price": 27,117 "institution_price_as_of": "2021-04-13",118 "institution_price_datetime": null,119 "institution_value": 636.309,120 "iso_currency_code": "USD",121 "quantity": 23.567,122 "security_id": "JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP",123 "unofficial_currency_code": null124 },125 {126 "account_id": "k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm",127 "cost_basis": 15,128 "institution_price": 13.73,129 "institution_price_as_of": "2021-04-13",130 "institution_price_datetime": null,131 "institution_value": 1373.6865,132 "iso_currency_code": "USD",133 "quantity": 100.05,134 "security_id": "nnmo8doZ4lfKNEDe3mPJipLGkaGw3jfPrpxoN",135 "unofficial_currency_code": null136 },137 {138 "account_id": "k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm",139 "cost_basis": 1,140 "institution_price": 1,141 "institution_price_as_of": "2021-04-13",142 "institution_price_datetime": null,143 "institution_value": 12345.67,144 "iso_currency_code": "USD",145 "quantity": 12345.67,146 "security_id": "d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are",147 "unofficial_currency_code": null148 },149 {150 "account_id": "ax0xgOBYRAIqOOjeLZr0iZBb8r6K88HZXpvmq",151 "cost_basis": 92.47,152 "institution_price": 0.177494362,153 "institution_price_as_of": "2022-01-14",154 "institution_price_datetime": "2022-06-07T23:01:00Z",155 "institution_value": 4437.35905,156 "iso_currency_code": "USD",157 "quantity": 25000,158 "security_id": "vLRMV3MvY1FYNP91on35CJD5QN5rw9Fpa9qOL",159 "unofficial_currency_code": null160 }161 ],162 "item": {163 "available_products": [164 "balance",165 "identity",166 "liabilities",167 "transactions"168 ],169 "billed_products": [170 "assets",171 "auth",172 "investments"173 ],174 "consent_expiration_time": null,175 "error": null,176 "institution_id": "ins_3",177 "institution_name": "Chase",178 "item_id": "4z9LPae1nRHWy8pvg9jrsgbRP4ZNQvIdbLq7g",179 "update_type": "background",180 "webhook": "https://www.genericwebhookurl.com/webhook"181 },182 "request_id": "l68wb8zpS0hqmsJ",183 "securities": [184 {185 "close_price": 0.011,186 "close_price_as_of": "2021-04-13",187 "cusip": null,188 "institution_id": null,189 "institution_security_id": null,190 "is_cash_equivalent": false,191 "isin": null,192 "iso_currency_code": "USD",193 "name": "Nflx Feb 01'18 $355 Call",194 "proxy_security_id": null,195 "security_id": "8E4L9XLl6MudjEpwPAAgivmdZRdBPJuvMPlPb",196 "sedol": null,197 "ticker_symbol": "NFLX180201C00355000",198 "type": "derivative",199 "unofficial_currency_code": null,200 "update_datetime": null,201 "market_identifier_code": "XNAS",202 "sector": "Technology Services",203 "industry": "Internet Software or Services",204 "option_contract": {205 "contract_type": "call",206 "expiration_date": "2018-02-01",207 "strike_price": 355,208 "underlying_security_ticker": "NFLX"209 }210 },211 {212 "close_price": 27,213 "close_price_as_of": null,214 "cusip": "577130834",215 "institution_id": null,216 "institution_security_id": null,217 "is_cash_equivalent": false,218 "isin": "US5771308344",219 "iso_currency_code": "USD",220 "name": "Matthews Pacific Tiger Fund Insti Class",221 "proxy_security_id": null,222 "security_id": "JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP",223 "sedol": null,224 "ticker_symbol": "MIPTX",225 "type": "mutual fund",226 "unofficial_currency_code": null,227 "update_datetime": null,228 "market_identifier_code": "XNAS",229 "sector": "Miscellaneous",230 "industry": "Investment Trusts or Mutual Funds",231 "option_contract": null232 },233 {234 "close_price": 2.11,235 "close_price_as_of": null,236 "cusip": "00448Q201",237 "institution_id": null,238 "institution_security_id": null,239 "is_cash_equivalent": false,240 "isin": "US00448Q2012",241 "iso_currency_code": "USD",242 "name": "Achillion Pharmaceuticals Inc.",243 "proxy_security_id": null,244 "security_id": "KDwjlXj1Rqt58dVvmzRguxJybmyQL8FgeWWAy",245 "sedol": null,246 "ticker_symbol": "ACHN",247 "type": "equity",248 "unofficial_currency_code": null,249 "update_datetime": null,250 "market_identifier_code": "XNAS",251 "sector": "Health Technology",252 "industry": "Major Pharmaceuticals",253 "option_contract": null254 },255 {256 "close_price": 10.42,257 "close_price_as_of": null,258 "cusip": "258620103",259 "institution_id": null,260 "institution_security_id": null,261 "is_cash_equivalent": false,262 "isin": "US2586201038",263 "iso_currency_code": "USD",264 "name": "DoubleLine Total Return Bond Fund",265 "proxy_security_id": null,266 "security_id": "NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk",267 "sedol": null,268 "ticker_symbol": "DBLTX",269 "type": "mutual fund",270 "unofficial_currency_code": null,271 "update_datetime": null,272 "market_identifier_code": "XNAS",273 "sector": null,274 "industry": null,275 "option_contract": null276 },277 {278 "close_price": 1,279 "close_price_as_of": null,280 "cusip": null,281 "institution_id": null,282 "institution_security_id": null,283 "is_cash_equivalent": true,284 "isin": null,285 "iso_currency_code": "USD",286 "name": "U S Dollar",287 "proxy_security_id": null,288 "security_id": "d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are",289 "sedol": null,290 "ticker_symbol": "USD",291 "type": "cash",292 "unofficial_currency_code": null,293 "update_datetime": null,294 "market_identifier_code": null,295 "sector": null,296 "industry": null,297 "option_contract": null298 },299 {300 "close_price": 13.73,301 "close_price_as_of": null,302 "cusip": null,303 "institution_id": "ins_3",304 "institution_security_id": "NHX105509",305 "is_cash_equivalent": false,306 "isin": null,307 "iso_currency_code": "USD",308 "name": "NH PORTFOLIO 1055 (FIDELITY INDEX)",309 "proxy_security_id": null,310 "security_id": "nnmo8doZ4lfKNEDe3mPJipLGkaGw3jfPrpxoN",311 "sedol": null,312 "ticker_symbol": "NHX105509",313 "type": "etf",314 "unofficial_currency_code": null,315 "update_datetime": null,316 "market_identifier_code": "XNAS",317 "sector": null,318 "industry": null,319 "option_contract": null320 },321 {322 "close_price": 0.140034616,323 "close_price_as_of": "2022-01-24",324 "cusip": null,325 "institution_id": "ins_3",326 "institution_security_id": null,327 "is_cash_equivalent": true,328 "isin": null,329 "iso_currency_code": "USD",330 "name": "Dogecoin",331 "proxy_security_id": null,332 "security_id": "vLRMV3MvY1FYNP91on35CJD5QN5rw9Fpa9qOL",333 "sedol": null,334 "ticker_symbol": "DOGE",335 "type": "cryptocurrency",336 "unofficial_currency_code": null,337 "update_datetime": "2022-06-07T23:01:00Z",338 "market_identifier_code": "XNAS",339 "sector": null,340 "industry": null,341 "option_contract": null342 }343 ]344}
Was this helpful?
/investments/transactions/get
Get investment transactions
The /investments/transactions/get
endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift.
Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_investment_transactions
response body field to fetch all available investment transactions.
Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the async_update
option). Instead, if transactions data is not ready when /investments/transactions/get
is first called, Plaid will wait for the data. For this reason, calling /investments/transactions/get
immediately after Link may take up to one to two minutes to return.
Data returned by the asynchronous investments extraction flow (when async_update
is set to true) may not be immediately available to /investments/transactions/get
. To be alerted when the data is ready to be fetched, listen for the HISTORICAL_UPDATE
webhook. If no investments history is ready when /investments/transactions/get
is called, it will return a PRODUCT_NOT_READY
error.
client_id
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.secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.access_token
start_date
date
end_date
date
options
/investments/transactions/get
results. If provided, must be non-null
.account_ids
account_ids
to retrieve for the Item.count
100
1
500
offset
0
0
async_update
products
, required_if_supported_products
, or optional_products
array when calling /link/token/create
, and async_update
is set to true, the initial Investments extraction will happen asynchronously. Plaid will subsequently fire a HISTORICAL_UPDATE
webhook when the extraction completes. When false
, Plaid will wait to return a response until extraction completion and no HISTORICAL_UPDATE
webhook will fire. Note that while the extraction is happening asynchronously, calls to /investments/transactions/get
and /investments/refresh
will return PRODUCT_NOT_READY
errors until the extraction completes.false
1const request: InvestmentsTransactionsGetRequest = {2 access_token: accessToken,3 start_date: '2019-01-01',4 end_date: '2019-06-10',5};6try {7 const response = await plaidClient.investmentsTransactionsGet(request);8 const investmentTransactions = response.data.investment_transactions;9} catch (error) {10 // handle error11}
Response fields and example
item
item_id
item_id
is always unique; linking the same account at the same institution twice will result in two Items with different item_id
values. Like all Plaid identifiers, the item_id
is case-sensitive.institution_id
null
for Items created without an institution connection, such as Items created via Same Day Micro-deposits.institution_name
null
for Items created without an institution connection, such as Items created via Same Day Micro-deposits.webhook
error
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
available_products
billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
billed_products
available_products
. Note - billed_products
is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance
, will not appear here.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
products
billed_products
field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create
has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products
but not in billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
consented_products
assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, transactions
, income
, income_verification
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_cashflow_insights
, layer
consent_expiration _time
date-time
update_type
background
- Item can be updated in the backgrounduser_present_required
- Item requires user interaction to be updatedbackground
, user_present_required
accounts
account_id
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.Like all Plaid identifiers, the
account_id
is case sensitive.balances
/accounts/balance/get
.available
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
.double
current
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.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
.double
limit
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.double
iso_currency_code
unofficial_currency_code
is non-null.unofficial_currency _code
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_code
s.last_updated_datetime
YYYY-MM-DDTHH:mm:ssZ
) indicating the oldest acceptable balance when making a request to /accounts/balance/get
.This field is only used and expected when the institution is
ins_128026
(Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST
error with the code of INVALID_FIELD
will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST
error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE
will be returned with the most recent timestamp for the requested account contained in the response.date-time
mask
name
official_name
type
investment:
Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage
instead.credit:
Credit carddepository:
Depository accountloan:
Loan accountother:
Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
investment
, credit
, depository
, loan
, brokerage
, other
subtype
401a
, 401k
, 403B
, 457b
, 529
, auto
, brokerage
, business
, cash isa
, cash management
, cd
, checking
, commercial
, construction
, consumer
, credit card
, crypto exchange
, ebt
, education savings account
, fixed annuity
, gic
, health reimbursement arrangement
, home equity
, hsa
, isa
, ira
, keogh
, lif
, life insurance
, line of credit
, lira
, loan
, lrif
, lrsp
, money market
, mortgage
, mutual fund
, non-custodial wallet
, non-taxable brokerage account
, other
, other insurance
, other annuity
, overdraft
, paypal
, payroll
, pension
, prepaid
, prif
, profit sharing plan
, rdsp
, resp
, retirement
, rlif
, roth
, roth 401k
, rrif
, rrsp
, sarsep
, savings
, sep ira
, simple ira
, sipp
, stock plan
, student
, thrift savings plan
, tfsa
, trust
, ugma
, utma
, variable annuity
verification_status
pending_automatic_verification
: The Item is pending automatic verificationpending_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 verifiedverification_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.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 and have strong signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution
: The Item's numbers have been verified using Plaid's data sources and have some signal for being valid. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.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. Only returned for Auth Items created via Database Insights. Note: Database Insights is currently a beta feature, please contact your account manager for more information.automatically_verified
, pending_automatic_verification
, pending_manual_verification
, manually_verified
, verification_expired
, verification_failed
, database_matched
, database_insights_pass
, database_insights_pass_with_caution
, database_insights_fail
verification_insights
network_status
has_numbers_match
is_numbers_match _verified
previous_returns
has_previous _administrative_return
account_number_format
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.valid
, invalid
, unknown
persistent_account_id
holder_category
business
, personal
, unrecognized
securities
security_id
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
cusip
sedol
institution_security _id
institution_id
institution_security_id
is present, this field indicates the Plaid institution_id
of the institution to whom the identifier belongs.proxy_security_id
name
ticker_symbol
is_cash_equivalent
type
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 fundscryptocurrency
: Digital or virtual currenciesderivative
: Options, warrants, and other derivative instrumentsequity
: Domestic and foreign equitiesetf
: Multi-asset exchange-traded investment fundsfixed income
: Bonds and certificates of deposit (CDs)loan
: Loans and loan receivablesmutual fund
: Open- and closed-end vehicles pooling funds of multiple investorsother
: Unknown or other investment typesclose_price
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.double
close_price_as_of
close_price
is accurate. Always null
if close_price
is null
.date
update_datetime
close_price
is accurate, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Always null
if close_price
is null
.date-time
iso_currency_code
null
if unofficial_currency_code
is non-null
.unofficial_currency _code
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_code
s.market_identifier_code
sector
For a complete list of possible values, please refer to the "Sectors and Industries" spreadsheet.
industry
For a complete list of possible values, please refer to the "Sectors and Industries" spreadsheet.
option_contract
For the Sandbox environment, this data is currently only available if the item is using a custom configuration object, and the
ticker
field of the custom security follows the OCC Option Symbol standard with no spaces.contract_type
put
: for Put option contractscall
: for Call option contractsexpiration_date
strike_price
double
underlying_security _ticker
investment _transactions
investment _transaction_id
investment_transaction_id
is case sensitive.account_id
account_id
of the account against which this transaction posted.security_id
security_id
to which this transaction is related.name
quantity
double
amount
double
price
double
fees
double
type
buy
: Buying an investment
sell
: Selling an investment
cancel
: A cancellation of a pending transaction
cash
: Activity that modifies a cash position
fee
: A fee on the account
transfer
: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transferFor descriptions of possible transaction types and subtypes, see the Investment transaction types schema.
buy
, sell
, cancel
, cash
, fee
, transfer
subtype
account fee
, adjustment
, assignment
, buy
, buy to cover
, contribution
, deposit
, distribution
, dividend
, dividend reinvestment
, exercise
, expire
, fund fee
, interest
, interest receivable
, interest reinvestment
, legal fee
, loan payment
, long-term capital gain
, long-term capital gain reinvestment
, management fee
, margin expense
, merger
, miscellaneous fee
, non-qualified dividend
, non-resident tax
, pending credit
, pending debit
, qualified dividend
, rebalance
, return of principal
, request
, sell
, sell short
, send
, short-term capital gain
, short-term capital gain reinvestment
, spin off
, split
, stock distribution
, tax
, tax withheld
, trade
, transfer
, transfer fee
, trust fee
, unqualified gain
, withdrawal
iso_currency_code
null
if unofficial_currency_code
is non-null
.unofficial_currency _code
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_code
s.total_investment _transactions
total_investment_transactions
is larger than the size of the transactions
array, more transactions are available and can be fetched via manipulating the offset
parameter.request_id
is_investments _fallback_item
1{2 "accounts": [3 {4 "account_id": "5e66Dl6jNatx3nXPGwZ7UkJed4z6KBcZA4Rbe",5 "balances": {6 "available": 100,7 "current": 110,8 "iso_currency_code": "USD",9 "limit": null,10 "unofficial_currency_code": null11 },12 "mask": "0000",13 "name": "Plaid Checking",14 "official_name": "Plaid Gold Standard 0% Interest Checking",15 "subtype": "checking",16 "type": "depository"17 },18 {19 "account_id": "KqZZMoZmBWHJlz7yKaZjHZb78VNpaxfVa7e5z",20 "balances": {21 "available": null,22 "current": 320.76,23 "iso_currency_code": "USD",24 "limit": null,25 "unofficial_currency_code": null26 },27 "mask": "5555",28 "name": "Plaid IRA",29 "official_name": null,30 "subtype": "ira",31 "type": "investment"32 },33 {34 "account_id": "rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj",35 "balances": {36 "available": null,37 "current": 23631.9805,38 "iso_currency_code": "USD",39 "limit": null,40 "unofficial_currency_code": null41 },42 "mask": "6666",43 "name": "Plaid 401k",44 "official_name": null,45 "subtype": "401k",46 "type": "investment"47 }48 ],49 "investment_transactions": [50 {51 "account_id": "rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj",52 "amount": -8.72,53 "cancel_transaction_id": null,54 "date": "2020-05-29",55 "fees": 0,56 "investment_transaction_id": "oq99Pz97joHQem4BNjXECev1E4B6L6sRzwANW",57 "iso_currency_code": "USD",58 "name": "INCOME DIV DIVIDEND RECEIVED",59 "price": 0,60 "quantity": 0,61 "security_id": "eW4jmnjd6AtjxXVrjmj6SX1dNEdZp3Cy8RnRQ",62 "subtype": "dividend",63 "type": "cash",64 "unofficial_currency_code": null65 },66 {67 "account_id": "rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj",68 "amount": -1289.01,69 "cancel_transaction_id": null,70 "date": "2020-05-28",71 "fees": 7.99,72 "investment_transaction_id": "pK99jB9e7mtwjA435GpVuMvmWQKVbVFLWme57",73 "iso_currency_code": "USD",74 "name": "SELL Matthews Pacific Tiger Fund Insti Class",75 "price": 27.53,76 "quantity": -47.74104242992852,77 "security_id": "JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP",78 "subtype": "sell",79 "type": "sell",80 "unofficial_currency_code": null81 },82 {83 "account_id": "rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj",84 "amount": 7.7,85 "cancel_transaction_id": null,86 "date": "2020-05-27",87 "fees": 7.99,88 "investment_transaction_id": "LKoo1ko93wtreBwM7yQnuQ3P5DNKbKSPRzBNv",89 "iso_currency_code": "USD",90 "name": "BUY DoubleLine Total Return Bond Fund",91 "price": 10.42,92 "quantity": 0.7388014749727547,93 "security_id": "NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk",94 "subtype": "buy",95 "type": "buy",96 "unofficial_currency_code": null97 }98 ],99 "item": {100 "available_products": [101 "assets",102 "balance",103 "identity",104 "transactions"105 ],106 "billed_products": [107 "auth",108 "investments"109 ],110 "consent_expiration_time": null,111 "error": null,112 "institution_id": "ins_12",113 "item_id": "8Mqq5rqQ7Pcxq9MGDv3JULZ6yzZDLMCwoxGDq",114 "update_type": "background",115 "webhook": "https://www.genericwebhookurl.com/webhook"116 },117 "request_id": "iv4q3ZlytOOthkv",118 "securities": [119 {120 "close_price": 27,121 "close_price_as_of": null,122 "cusip": "577130834",123 "institution_id": null,124 "institution_security_id": null,125 "is_cash_equivalent": false,126 "isin": "US5771308344",127 "iso_currency_code": "USD",128 "name": "Matthews Pacific Tiger Fund Insti Class",129 "proxy_security_id": null,130 "security_id": "JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP",131 "sedol": null,132 "ticker_symbol": "MIPTX",133 "type": "mutual fund",134 "unofficial_currency_code": null,135 "update_datetime": null,136 "market_identifier_code": "XNAS",137 "sector": "Miscellaneous",138 "industry": "Investment Trusts or Mutual Funds",139 "option_contract": null140 },141 {142 "close_price": 10.42,143 "close_price_as_of": null,144 "cusip": "258620103",145 "institution_id": null,146 "institution_security_id": null,147 "is_cash_equivalent": false,148 "isin": "US2586201038",149 "iso_currency_code": "USD",150 "name": "DoubleLine Total Return Bond Fund",151 "proxy_security_id": null,152 "security_id": "NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk",153 "sedol": null,154 "ticker_symbol": "DBLTX",155 "type": "mutual fund",156 "unofficial_currency_code": null,157 "update_datetime": null,158 "market_identifier_code": "XNAS",159 "sector": null,160 "industry": null,161 "option_contract": null162 },163 {164 "close_price": 34.73,165 "close_price_as_of": null,166 "cusip": "84470P109",167 "institution_id": null,168 "institution_security_id": null,169 "is_cash_equivalent": false,170 "isin": "US84470P1093",171 "iso_currency_code": "USD",172 "name": "Southside Bancshares Inc.",173 "proxy_security_id": null,174 "security_id": "eW4jmnjd6AtjxXVrjmj6SX1dNEdZp3Cy8RnRQ",175 "sedol": null,176 "ticker_symbol": "SBSI",177 "type": "equity",178 "unofficial_currency_code": null,179 "update_datetime": null,180 "market_identifier_code": "XNAS",181 "sector": "Finance",182 "industry": "Regional Banks",183 "option_contract": null184 }185 ],186 "total_investment_transactions": 3187}
Was this helpful?
/investments/refresh
Refresh investment data
/investments/refresh
is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling /investments/refresh
, Plaid will fire webhooks: HOLDINGS: DEFAULT_UPDATE
if any new holdings are detected, and INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE
if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling /investments/holdings/get
and /investments/transactions/get
. Note that the /investments/refresh
endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a PRODUCT_NOT_SUPPORTED
error.
As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests./investments/refresh
is offered as an add-on to Investments and has a separate fee model. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
client_id
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.access_token
secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.1const request: InvestmentsRefreshRequest = {2 access_token: accessToken,3};4try {5 await plaidClient.investmentsRefresh(request);6} catch (error) {7 // handle error8}
Response fields and example
request_id
1{2 "request_id": "1vwmF5TBQwiqfwP"3}
Was this helpful?
Webhooks
Updates are sent to indicate that new holdings or investment transactions are available.
HOLDINGS: DEFAULT_UPDATE
Fired when new or updated holdings have been detected on an investment account. The webhook typically fires in response to any newly added holdings or price changes to existing holdings, most commonly after market close.
webhook_type
HOLDINGS
webhook_code
DEFAULT_UPDATE
item_id
item_id
of the Item associated with this webhook, warning, or errorerror
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
new_holdings
updated_holdings
environment
sandbox
, production
1{2 "webhook_type": "HOLDINGS",3 "webhook_code": "DEFAULT_UPDATE",4 "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "error": null,6 "new_holdings": 19,7 "updated_holdings": 0,8 "environment": "production"9}
Was this helpful?
INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE
Fired when new transactions have been detected on an investment account.
webhook_type
INVESTMENTS_TRANSACTIONS
webhook_code
DEFAULT_UPDATE
item_id
item_id
of the Item associated with this webhook, warning, or errorerror
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
new_investments _transactions
canceled_investments _transactions
environment
sandbox
, production
1{2 "webhook_type": "INVESTMENTS_TRANSACTIONS",3 "webhook_code": "DEFAULT_UPDATE",4 "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "error": null,6 "new_investments_transactions": 16,7 "canceled_investments_transactions": 0,8 "environment": "production"9}
Was this helpful?
INVESTMENTS_TRANSACTIONS: HISTORICAL_UPDATE
Fired after an asynchronous extraction on an investments account.
webhook_type
INVESTMENTS_TRANSACTIONS
webhook_code
HISTORICAL_UPDATE
item_id
item_id
of the Item associated with this webhook, warning, or errorerror
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
new_investments _transactions
canceled_investments _transactions
environment
sandbox
, production
1{2 "webhook_type": "INVESTMENTS_TRANSACTIONS",3 "webhook_code": "HISTORICAL_UPDATE",4 "item_id": "wz666MBjYWTp2PDzzggYhM6oWWmBb",5 "error": null,6 "new_investments_transactions": 16,7 "canceled_investments_transactions": 0,8 "environment": "production"9}