TradeTally API Analytics: Build a Custom Trading Dashboard
Plan a custom trading report around TradeTally’s documented analytics and trade fields. Learn what the API exposes, how API keys and authentication work, and which details to verify before building.
When your reporting needs do not fit a standard view, building a custom dashboard can give you a place to organize the information you want to review. The practical challenge is knowing which data the TradeTally API documents and which implementation details you still need to confirm before writing code.
Start with the dashboard question you want to answer
Write down one specific reporting question before choosing metrics or trade fields. For example, you might want a report that puts a performance measure beside selected details about individual trades. Keep the question narrow enough that you can identify what information the report needs.
This guide covers the metrics documented for /api/analytics and the trade record fields documented for /api/trades. It also covers API key permissions, expiration, and supported authentication headers. The API facts here do not specify request parameters, response structure, or the requirements of a particular dashboard tool, so use the API documentation to check those details before implementation.
Use TradeTally API analytics for documented performance metrics
The /api/analytics endpoint exposes win rate, profit factor, average win/loss, and expectancy. Start by comparing that list with the question you wrote down. Choose only the documented metrics that are relevant to your planned report, then use clear labels so a reader can tell what each displayed value represents.
Do not assume that the endpoint accepts requests for custom metrics or that a familiar metric name tells you exactly how a value is calculated. Those details are not established here. Check the endpoint documentation for its request and response details, and use the documented information to determine what your implementation can display.
The TradeTally API documentation is the reference for endpoint-specific implementation details. Make a short list of the metrics you intend to include before you move on to trade-level context.
Add trade-level context from /api/trades
The /api/trades endpoint returns paginated records with P&L, setup tags, and broker fields. These are documented trade-level fields to consider when deciding what belongs beside the analytics metrics. They do not, by themselves, establish which filters, groupings, or display options your dashboard can support.
Write down which fields are relevant to your reporting question. Also account for pagination: the endpoint returns records in pages, so consult the documentation for the details your implementation needs to retrieve and interpret those records. This article does not specify pagination parameters or promise that a particular field can be used as a filter.
For related context on API and trade-data topics, see this overview of trading journal API data and TradeTally analytics. Treat it as additional reading, not a substitute for checking the current endpoint documentation for implementation requirements.
Create an API key and choose its permissions
TradeTally API keys are created from the Settings page. Keys use the format tt_live_<random> and support read and write permission scopes. When creating a key, review the available scopes and select permissions appropriate to your intended use; the facts here do not establish that a custom dashboard requires a specific scope.
API keys also have configurable expiration, up to 90 days. Choose an expiration within that limit when setting up a key, and account for the selected expiration in your own implementation plans. The available facts do not specify key rotation procedures or how an application should handle an expired key, so consult the documentation if you need those details.
Keep this step separate from deciding what the dashboard displays. First identify the data you intend to use; then review the available permission scopes and expiration options when creating the key.
Authenticate requests using a supported header
All TradeTally API endpoints accept either a Bearer token or an X-API-Key header. For requests, consult the API documentation and use one of those supported header options. No other authentication method is established by the facts in this guide.
Do not copy a header example from another service and assume it applies here. Check the TradeTally API documentation for the exact request details, including how the selected authentication option should be represented. This article does not provide an SDK, code sample, or a particular dashboard connection workflow.
Map the documented data to your report, then verify the details
Before implementation, create a compact field map. Connect each planned report label to either a metric documented for /api/analytics or a field documented for /api/trades. If you cannot connect a label to one of those documented items, mark it for further investigation instead of assuming the API exposes it.
| Planned report label | Documented source | Illustrative value |
|---|---|---|
| Win rate | /api/analytics | Hypothetical: 52% |
| Average win/loss | /api/analytics | Hypothetical: 1.4 |
| Trade P&L | /api/trades | Hypothetical: +$85 |
| Setup tag | /api/trades | Hypothetical: breakout |
The values in the table are hypothetical examples of report labels and values, not a TradeTally response or a claim about expected results. In a real implementation, verify endpoint parameters, response structure, and any other implementation-specific details in the API documentation. Those details are not specified in this article’s source facts.
If you are considering a recurring review, read about building a weekly trading review with the TradeTally API as a related reporting example. Use it for context, then verify the details that apply to your own integration in the documentation.
FAQ: TradeTally API analytics and custom dashboards
Can I use TradeTally API analytics outside the app?
The documented API exposes analytics through /api/analytics. Consult the API documentation for implementation details before building an external report or dashboard.
Which performance metrics does /api/analytics expose?
The endpoint exposes win rate, profit factor, average win/loss, and expectancy. Check the documentation for request and response details; this guide does not define calculation methods.
What trade details can I retrieve from /api/trades?
The endpoint returns paginated records with P&L, setup tags, and broker fields. Refer to the API documentation for pagination and response details.
How do I authenticate, and how long can an API key last?
All API endpoints accept a Bearer token or an X-API-Key header. Keys are created from the Settings page, support read and write permission scopes, and have configurable expiration up to 90 days.
To confirm endpoint details before you build, review the TradeTally API documentation.