Holdings represent a stock, bond, or other type of investment.

List Holdings by User

Endpoint: GET /users/:user_guid/holdings

This endpoint returns all holdings associated with the specified user across all accounts and members.

Parameters

For the Request

Example Request

curl -X GET /users/:user_guid/holdings \\
  -H 'Content-Type: application/json' \\
  -d '{
    "access_token": String
  }'

Response

{
  "holdings": [
    {
      "account_guid": "ACT-f3a6ddfb-3768-4713-87a0-4ad04f87c396",
      "cost_basis": null,
      "created_at": "2019-08-02T17:43:22Z",
      "currency_code": "USD",
      "cusip": "70450Y103",
      "daily_change": null,
      "description": "PayPal Holdings Inc.",
      "guid": "HOL-bd3bc50f-5a70-4226-abef-ae9bb4c1cb1a",
      "holding_type": 9,
      "id": "holding-8417f306-7113-485f-b209-3864ae82fdd7",
      "market_value": 57,
      "member_guid": null,
      "metadata": null,
      "purchase_price": 26,
      "shares": 37,
      "symbol": "PYPL",
      "updated_at": "2020-03-02T19:11:02Z",
      "user_guid": "USR-a2e65785-975d-dcbd-fd22-7bbba2581fb0"
    },
    {
      "account_guid": "ACT-f3a6ddfb-3768-4713-87a0-4ad04f87c396",
      "cost_basis": null,
      "created_at": "2019-08-02T17:43:22Z",
      "currency_code": "USD",
      "cusip": "99UBAYWG0",
      "daily_change": null,
      "description": "American Airlines Group Inc.",
      "guid": "HOL-813a8b86-0dfd-4e8b-8852-24e9a5a0c688",
      "holding_type": 10,
      "id": "holding-a3fccf60-9a89-4a90-aaaf-0462a4e40bef",
      "market_value": 4,
      "member_guid": null,
      "metadata": null,
      "purchase_price": 60,
      "shares": 31,
      "symbol": "AAL",
      "updated_at": "2020-03-02T19:11:02Z",
      "user_guid": "USR-a2e65785-975d-dcbd-fd22-7bbba2581fb0"
    },
    ...
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 10,
    "total_pages": 1
  }
}

Read Holding

Endpoint: GET /users/:user_guid/holdings/:holding_guid

This endpoint returns all holdings associated with the specified account.

Parameters

For the Request

Example Request

curl -X GET /users/:user_guid/holdings/:holding_guid \\
  -H 'Content-Type: application/json' \\
  -d '{
    "access_token": String
  }'

Response