API ReferenceCopilot
Portfolio impact
/api/v1/copilot/portfolio-impact- Plan
- Expert and up
- Price
- 10 credits per call
- MCP tool
copilot_portfolio_ impact
Portfolio-aware verdict on a candidate ticker. Call this when you have the user's holdings and they ask about a specific ticker. Returns the candidate's full standalone analysis PLUS pre/post sector + voter-tilt comparison, concentration warnings, correlated holdings already in the portfolio, and the portfolio context in sizing_rationale. No position size is served: suggested_size_pct_unconstrained and suggested_size_pct_with_portfolio are always null, with a magnitudes_withheld block saying why: null is a refusal to size, never a size of 0%. Body is JSON: {holdings:[{ticker, weight_pct},...], candidate_ticker, candidate_weight_pct (default 0.04)}. The narrative field is the quotable spine — quote it or rewrite in your voice.
Request body
application/json, required.
holdingsarray of objectRequiredholdings[].tickerstringRequiredholdings[].weight_pctnumberRequiredFRACTION of NAV — 0.04 = 4%.
candidate_tickerstringRequiredcandidate_weight_pctnumberOptionalFraction of NAV.
0.04Response
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 not_found | No such resource. Not billed. |
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 Copilot guide for this endpoint's fields and examples.