Sign in
plaid

Get investment transactions data

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.

post/processor/investments/transactions/get

Request body

client_idstring

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_tokenstring required

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

secretstring

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.

start_datestring date required

The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

end_datestring date required

The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

Response

OK

total_investment_transactionsinteger required

The total number of transactions available within the date range specified. If 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_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

is_investments_fallback_itemboolean

When true, this field indicates that the Item's portfolio was manually created with the Investments Fallback flow.

Changes

Changed in 17 of the 52 revisions of this API.93217

  • e536704a333f51See the full diff
    • ●

      added the new charge card enum value to the account/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new commercial line of credit enum value to the account/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new home equity loan enum value to the account/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new installment enum value to the account/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new prediction market enum value to the account/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property account/allOf[subschema #1: Account]/apy to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a1bbca018160131See the full diff
    • ●

      added the new ASSETS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new ENRICH_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new PROFILE_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ○

      added the required property securities/items/figi to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 80d23bfdc2e51See the full diff
    • ●

      added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

  • fb8c3f188d8b14See the full diff
    • ●

      added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ○

      added the optional property account/allOf[subschema #2]/mask to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property account/allOf[subschema #2]/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property account/allOf[subschema #2]/official_name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property account/allOf[subschema #2]/verification_name to the response with the 200 status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b9a2871636de1See the full diff
    • ●

      added the new limited purpose checking enum value to the account/allOf[subschema #1: Account]/subtype response property for the response status 200

      response-property-enum-value-added

  • 7f9a02ad0ce3852See the full diff
    • ▲

      the account response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property account/account_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property account/balances from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property account/mask from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property account/name from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property account/official_name from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property account/subtype from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property account/type from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property account/holder_category from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property account/persistent_account_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property account/verification_insights from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property account/verification_name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property account/verification_status from the response with the 200 status

      response-optional-property-removed

    • ○

      added AccountBase subschema #2 to the account response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added the required property securities/items/cfi_code to the response with the 200 status

      response-required-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 465584b48c992See the full diff
    • ○

      added the optional property provided_account_subtypes to the response with the default status

      response-optional-property-added

    • ○

      added the optional property required_account_subtypes to the response with the default status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4abee1c569291See the full diff
    • ○

      removed the IDENTITY_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

  • f8b9f1a8576721See the full diff
    • ●

      added the new IDENTITY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new USER_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • ○

      added the optional property investment_transactions/items/transaction_datetime to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • af4b6e71d87f1See the full diff
    • ●

      added the new SIGNAL_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added