plaid

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.

post/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.

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.

access_tokenstring required

The access token associated with the Item for which data is being requested.

start_datestring date required

The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD. Plaid returns all investment transaction history stored for the Item (up to 2 years prior to the initial linking of the Item).

end_datestring date required

The most recent date for which to fetch transaction history. 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 26 of the 53 revisions of this API.13143132

  • e536704a333f91See the full diff
    • added the new charge card enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new commercial line of credit enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new home equity loan enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new installment enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new prediction market enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the optional property /// to the response with the 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

  • a1bbca018160261See the full diff
    • added the new ASSETS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ASSETS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the required property // to the response with the 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

    • added the new IDEMPOTENCY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new IDEMPOTENCY_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

  • fb8c3f188d8b24See the full diff
    • added the new BASE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the 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

    • added the new limited purpose checking enum value to the /// response property for the response status

      response-property-enum-value-added

  • 7f9a02ad0ce3892See the full diff
    • the / response's property type changed from object to no type for status

      response-property-type-changed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added subschema #2 to the / response property allOf list for the response status

      response-property-all-of-added

    • added the required property // to the response with the 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

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the 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

    • removed the IDENTITY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the IDENTITY_ERROR enum value from the // response property for the response status

      response-property-enum-value-removed

  • f8b9f1a8576725See the full diff
    • added the new IDENTITY_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

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