Refresh investment data
POST /investments/refresh
/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. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call /sandbox/item/fire_webhook. 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.
Request Body
Required
InvestmentsRefreshRequest defines the request schema for /investments/refresh
Parameters
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.
Response
InvestmentsRefreshResponse defines the response schema for /investments/refresh
Response Properties
request_id