Investment Data

Overview

There are two APIs used for Investment Data:

Investment Data API (billable): The main API you will use to access aggregated holdings. A user is automatically enrolled when you use any of the Read/List endpoints for that user.

Deactivate Investment Data API (non-billable): A secondary API that allows you to deactivate service for a specific user. It doesn’t cost extra to use this API. To reactivate a user, use any of the current /investment_holding endpoints.

Learn about the full features of Investment Data.

Sample Data

Here are some examples of the payload in JSON format. These examples showcase the requests and responses for specific endpoints related to Accounts and Holdings.

Holdings Sample Data

Here is a example payload for a Holding endpoint.

  {
    "investment_holding": {
        "account_guid": "ACT-3c9ef6ba-2768-4c4b-bca3-150d8cea18a1",
        "cost_basis": 55000.0,
        "coupon_yield": null,
        "currency_code": "USD",
        "current_price": 15.0,
        "daily_change": 0.03,
        "description": "Vanguard Total Stock Market Index Fund (VTSMX)",
        "expiration": null,
        "face_value": null,
        "frequency": null,
        "guid": "HOL-b6f4ec2e-47d7-45f1-b829-fbada93ca1a2",
        "market_value": 75000.0,
        "maturity_date": null,
        "member_guid": "MBR-52f8b4a7-9cd1-477d-8ad9-d2c32a3cfb7c",
        "percentage_change": 0.2,
        "purchase_price": null,
        "quantity": 5000.0,
        "rate": null,
        "strike_price": null,
        "symbol": "VTSMX",
        "term": null,
        "term_unit": null,
        "today_ugl_amount": 200.0,
        "today_ugl_percentage": 0.27,
        "total_ugl_amount": 20000.0,
        "total_ugl_percentage": 26.67,
        "unvested_quantity": null,
        "unvested_value": null,
        "user_guid": "USR-ed6e88b8-07c7-4af0-bf74-236b54e0d26d",
        "vested_quantity": null,
        "vested_value": null,
        "created_at": "2019-04-01T00:00:00Z",
        "current_price_as_of": "2023-11-06T00:00:00Z",
        "issue_date": "2015-08-15",
        "vesting_start_date": null,
        "vesting_end_date": null,
        "put_or_call": null,
        "holding_type": "MUTUAL_FUND"
    }
}

Accounts Sample Data

For account information on the holdings, refer to the Account Endpoints page.

Investment Data

Overview

Quick Links

API Reference - Investment Data

Common Errors

Sample Data

Holdings Sample Data

Accounts Sample Data

​Overview

​Quick Links

API Reference - Investment Data

Common Errors

​Sample Data

​Holdings Sample Data

​Accounts Sample Data

Overview

Quick Links

Sample Data

Holdings Sample Data

Accounts Sample Data