API ReferenceQuant Signals
What's driving it
/api/v3/intel/ml_drivers/{ticker}- Plan
- Starter and up
- Price
- 3 credits per call
- MCP tool
intel_ml_ drivers
UNAVAILABLE: no SHAP drivers can be served. The drivers file does not record which model bundle produced it, so it cannot be tied to the model serving now; every call answers 503 upstream_dead_drivers_unbound until a bound file is published. Top-N SHAP feature attributions for the ML ensemble score on a ticker: drivers[] ranked by |SHAP| with feature (e.g. beta_cma, vol_21d), signed shap_value, direction (bullish/bearish/neutral). PRIMARY tool for 'why is the model bullish/bearish on X?'. Nightly run; default top=5, max 20; available:false outside the ML universe. 5min cache. Served only when the drivers name the active model bundle; otherwise a 503 refusal, not billed (error_code upstream_dead_drivers_unbound, binding.status unbound | foreign_bundle | mixed_bundles | active_bundle_unknown) — say the drivers are unavailable, never that the ticker is outside the universe, never substitute. Every 200, including available:false, carries as_of, model_bundle_sha256 and stale (over 3 days): available:false is a statement about that run's universe.
Parameters
Path
tickerstringRequiredQuery
topintegerOptional5Response
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Quant Signals). 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.
Guides
Read the Quant Signals guide for this endpoint's fields and examples.