Build your next
research workflow.
Bring Headstart’s metric definitions and approved research summaries into your own tools. Explore the API, copy a request, and build from there.
A bounded request
No provider refresh on read
Data + status + context
Pick an endpoint. Start with real code.
Choose a public route and your preferred language. Examples target a configured local backend; nothing is sent from this page.
Metric definitions
Discover Headstart’s metric names, definitions, units, and limitations. Use this catalog to explain the numbers in your own interface.
Requires an enabled Agent-v1 service. Use your deployment’s approved API base URL outside local development.
curl --fail-with-body \
-H "Accept: application/json" \
http://127.0.0.1:8060/api/agent/v1/public/metricsSmall surface. Clear purpose.
/api/agent/v1/public/metricsList product-owned metric definitions.
/api/agent/v1/public/metrics/{key}Look up a metric using a key returned by the catalog.
/api/agent/v1/public/proof-summaryRetrieve the rights-approved aggregate proof summary.
Use your approved API base URL outside local development. These routes are not a bulk market-data feed.
Keep the context attached.
schema_version, operation, and request_id identify the contract and request.
served_at is response time. Source clocks and provenance in meta explain how old the underlying data is.
Headstart’s Quant Score is 0–100. The public metric catalog documents product-owned definitions.
Keep the supplied calculation methods, units, and disclosures attached to the data your application presents.
Build the edge cases in from the start.
How does access to private routes work?
Credentialed reads require a short-lived delegated assertion, the appropriate scope, account entitlement, and an enabled capability. Do not pass a raw hs_mcp_* credential directly to data routes.
How should I handle pagination?
Use the returned next_cursor. Cursors are signed and bound to the operation, query, snapshot, position, expiry, and schema version.
How do I look up one metric?
Start with the metric catalog, take a returned key, then request /api/agent/v1/public/metrics/{key}. Use the returned definition.
Can I cache public responses?
The current public routes supply ETag and Cache-Control headers. Use conditional requests where appropriate and honor the returned policy.
What happens when the API is disabled?
Public routes return an explicit HTTP status and response envelope when the capability is unavailable. Check status as well as payload.
Does a request trigger fresh market data?
No. Agent-v1 reads stored data. Requests do not run pipelines, refresh providers, execute strategies, or synchronize databases.
Building an assistant instead of an app?
Use MCP for tool discovery, read-only access, and the supported connection setup.