EndpointsDiscovery
Stock Reference
Self-describing catalogs: refusal tokens, shapes, units, concepts, and filing forms.
Playground keys are masked and used only for this browser-initiated test. The docs proxy forwards X-API-Key to POST /v1/tools/* and does not store it server-side. Fumadocs may keep the auth value in browser localStorage while this endpoint page is open; StockContext clears it when you leave or unload the page.
Serve deterministic reference catalog data.
Authorization
ApiKeyAuth X-API-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request for stock_reference.
Response Body
application/json
application/json
curl -X POST "https://api.stockcontext.com/v1/tools/stock_reference" \ -H "X-API-Key: $STOCKCONTEXT_API_KEY" \ -H "Content-Type: application/json" \ -d '{"catalog":"refusal_tokens"}'{
"catalog": "refusal_tokens",
"items": [
{
"code": "AMBIGUOUS_CANDIDATE",
"public": "ambiguous_candidate",
"recovery_action": "disambiguate",
"note": "Candidate survived but failed identity or uniqueness guard."
},
{
"code": "CASH_RETURN_UNAVAILABLE",
"public": "cash_return_unavailable",
"recovery_action": "use_full_document",
"note": "A serve-time cash-return yield (dividend_yield/payout_ratio/buyback_yield/shareholder_yield) whose cash-return operand (dividends_paid/stock_buyback) is not a genuinely-tagged value — it is not_reported (a chain miss), absent, or otherwise refused. A chain miss is indistinguishable from a real non-payer, so serving a $0 (the JNJ dividend_yield:0 bug) would be a wrong number; the yield refuses honestly instead. A genuinely-tagged $0 is served as a real 0; only an unprovable operand reaches this refusal."
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}