plaid

Retrieve Investment Holdings

This endpoint returns the stock position data of the account associated with a given processor token.

post/processor/investments/holdings/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.

Response

OK

is_investments_fallback_itemboolean

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

request_idstring

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

Changes

Changed in 15 of the 53 revisions of this API.102717

  • e536704a333f51See 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 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

  • a1bbca018160131See 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 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 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 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 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 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 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 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

  • fb8c3f188d8b15See 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 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

    • 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

  • 7f9a02ad0ce3852See 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 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

    • the response property became optional for the status

      response-property-became-optional

    • 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

    • response property securities/items/sedol deprecated

      response-property-deprecated