POST /processor/investments/transactions/get

The /processor/investments/transactions/get endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for the investment account associated with the processor token.

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 the account, 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 /processor/investments/transactions/get is first called, Plaid will wait for the data. For this reason, calling /processor/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 /processor/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 /processor/investments/transactions/get is called, it will return a PRODUCT_NOT_READY error.

To receive Investments Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update endpoint.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`start_date`	String	Yes	The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.
`client_id`	String	No	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.
`options`	Object	No	An optional object to filter `/investments/transactions/get` results. If provided, must be non-`null`.
`options.count`	Integer	No	The number of transactions to fetch. Default value: 100
`options.account_ids[]`	Array	No	An array of `account_ids` to retrieve for the Item.
`options.offset`	Integer	No	The number of transactions to skip when fetching transaction history Default value: 0
`options.async_update`	Boolean	No	If the Item was not initialized with the investments product via the `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. Default value: false
`end_date`	String	Yes	The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.
`processor_token`	String	Yes	The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.