Advisor Reports
GSCS reports are divided into two categories: real time and daily. Real time reports will contain data as of the point of time that the API is called. Daily reports contain data as of the previous day close of business. For example, if you call a daily report at 3pm EST on Tuesday, the data returned will be as of Monday close of business.
Real Time Reports
Endpoint: GET api/v2/reports/real-time
See below for more information on each of the reports.
Account Management
Purpose: Review all account specific attributes and settings
Example Request: GET /api/v2/reports/real-time?reportType=account-management
Bank Links
Purpose: Review bank links and associated data points.
Example Request: GET /api/v2/reports/real-time?reportType=bank-links
Class Action Lawsuit
Purpose: View all the investors who held shares during the relevant time period.
Example Request: GET /api/v2/reports/daily?reportType=class-action-lawsuit&beginDate=2025-05-06&endDate=2025-05-08&symbol=AAPL
You must pass in a date range using a start date (beginDate) and end date (endDate) and a ticker (symbol).
Client Management
Purpose: Review all client specific attributes and settings.
Example Request: GET /api/v2/reports/real-time?reportType=client-management
Money Movement Instructions
Purpose: Review money movement instructions (Periodic, Investment Income and Automated RMD).
Example Request: GET /api/v2/reports/real-time?reportType=money-movement-instructions
Related Parties
Purpose: Review all secondary persons attached to accounts, such as beneficiaries, trustees, authorized signatories, trusted contacts, and more.
Example Request: GET /api/v2/reports/real-time?reportType=related-parties
Restriction History
Purpose: Review past and present account restrictions.
Example Request: GET api/v2/reports/real-time?reportType=restriction-history
Daily Reports
Endpoint: GET /api/v2/reports/daily
See below for more information on each of the reports.
ADV Update
Purpose: View total Assets Under Management (AUM) by asset type, branch code, rep code, and total number of accounts.
Example Request: GET /api/v2/reports/daily?reportType=adv-update&targetDate=2025-05-29
You must pass in a date (targetDate) and the results will reflect assets held as of that date.
Class Action Lawsuit
Purpose: View all the investors who held shares during the relevant time period.
Example Request: GET /api/v2/reports/daily?reportType=class-action-lawsuit&beginDate=2025-05-06&endDate=2025-05-08&symbol=AAPL
You must pass in a date range using a start date (beginDate) and end date (endDate) and a ticker (symbol).
Date of Death Valuation
Purpose: Determine the fair market value of a decedent's assets at the time of their death.
Example Request: GET /api/v2/reports/daily?reportType=dod-valuation&clientLoginId=sallysmith123&targetDate=2025-05-06
You must pass in the decedent's username (clientLoginId) and the date of death (targetDate).
Holdings Research
Purpose: Manage current holdings or review previous holdings for a specific point in time (up to 2 years).
Example Request: GET /api/v2/reports/daily?reportType=holdings-research&clientLoginId=testuser321&targetDate=2025-05-14&symbols=APPL&symbols=+IBM
You must pass in a date (targetDate). The holdings data returned will be as of this date.
You can also pass in the following parameters to further refine your search:
- Client username
clientLoginIdOR account(s)accountNumbersOR householdhouseholdId - Symbols (tickers or CUSIPS):
symbols
Start of Day Balances
Purpose: Manage cash availability and margin details.
Example Request: GET /api/v2/reports/daily?reportType=balances
Realized Gain/Loss
Purpose: Manage tax impact by monitoring gains and losses.
Example Request: GET /api/v2/reports/daily?reportType=realized-gain-loss
You must pass in a date range using a start date (beginDate) and end date (endDate). Suggested date ranges are last 30 days, year-to-date, and previous year. Do not pass in a date range longer than one year.
You can pass in a client username (clientLoginId) or account number(s) (accountNumbers) to narrow your search.
Tax Planning
Purpose: Manage unrealized gains or losses to plan for any potential tax impact.
Tax Planning has two report types: tax-planning-lots and tax-planning. Use tax-planning-lots for tax lot level results and use tax-planning for position level results.
Example Requests:
GET /api/v2/reports/daily?reportType=tax-planning-lots
GET /api/v2/reports/daily?reportType=tax-planning
Warning
Some reports will not work for advisors who are permissioned to over 15,000 accounts. In this case, you will get a 400 error with displayMessage: "Too many accounts".
You can use the Get accounts API call to see how many accounts an advisor is permissioned to.
Client RMDs Report
Purpose: Manage your clients' Required Minimum Distributions (RMDs) for IRA accounts. See valuable data points such as RMD Amount, Distribution YTD, and RMD Amount Remaining to see which clients are on track to meet their RMDs.
Endpoint: GET /api/v2/dashboard/real-time-folio-widget-data
Example Requests:
GET /api/v2/dashboard/real-time-folio-widget-data?widgetName=client-rmd&startPage=1¶ms=current
GET /api/v2/dashboard/real-time-folio-widget-data?widgetName=client-rmd&startPage=1¶ms=current&searchTerm=Sally+Smith
Use params=current to view current year data and use params=previous to view previous year data. Use searchTeam to search by client name (you can search by first name, last name, or both).
Was this page useful?
Give feedback to help us improve developer.gs.com and serve you better.