API ReferenceCopilot
Quant score
/api/v1/copilot/score/{ticker}- Plan
- Expert and up
- Price
- 10 credits per call
- MCP tool
copilot_score_ ticker
Full per-ticker quant analysis. CALL THIS when the user asks about any specific stock (e.g. 'should I buy NVDA', 'what do you think of TSLA'). Returns an ORDERING, not a forecast: blended_score, rank, decile and percentile in the scored book (which includes funds and ADRs the API does not serve), served_rank / served_decile / served_percentile among the equities the API serves, the voter breakdown (every voter that scored, of the 19-slot ensemble, with the weight it was blended with: a voter the voter policy disables shows weight 0 and status disabled_at_blend; the contributions sum to blended_score when attribution.reproduces_blended_score is true, and when it is false no contributor is named), voters_bullish / voters_bearish, tier, regime and a self-contained narrative. expected_return_pct and the interval are null (magnitudes_withheld) while the live measurement does not support them. No position size is served: suggested_position_pct is always null (sizing_withheld). model_track_record quotes no performance figure; the record is copilot_track_record. Use the narrative as a quotable summary; use the structured fields for follow-up questions. NAMESPACE: this model's universe is US EQUITIES. Nine tickers (BTC ETH LINK LTC COMP ARB NEAR APT ATOM) are ALSO crypto symbols; for those the response carries a ticker_collision block stating the score describes the US-listed EQUITY. If the user means the CRYPTO asset pass asset_class=crypto, which 404s (no crypto model serves this route). For a ranked crypto sleeve (liquid-book scan, scored ordering, top-N) call GET /api/crypto/sitting — that is DATA, signal_quality_mode=ordering_only, not a forecast. The full liquid book is GET /api/crypto/universe. For overnight movers / watchlist DATA call GET /api/crypto/overnight (X-API-Key) — a SLICE of that universe, data/context, not a score. For a ranked US-equity sleeve (full-book scan, attached factors, top-N) call GET /api/equity/sitting — that is DATA, not a score, and do_not_place_from_mover_rank stays true. NEVER present an equity score as a crypto view.
Parameters
Path
tickerstringRequiredQuery
asset_classstringOptionalEquity (default) | crypto. crypto fails closed with 404: no crypto model serves this route — never a wrong-asset answer.
equitycryptoequityResponse
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Copilot). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.
A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.
Errors
No error is billed. The body is { "ok": false, "error", "detail", "request_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed. |
401 unauthorized | Missing or invalid API key. |
402 plan_required | Your plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed. |
403 scope_denied | This API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed. |
404 unknown_ticker | No data source lists this ticker, active or delisted: the market-data listing and the security master both say it does not exist. param names the parameter. Not billed. Best-effort: it is answered only when the route itself found nothing, and after 20 lookups of new symbols per API key per minute the route's own answer stands. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The request ran past the server's time budget; retry. Not billed. |
This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.