Wealthnow
Sign up

API ReferenceCopilot

Status

Comparison full

POST/api/v3/copilot/comparison_full
Plan
Expert and up
Price
10 credits per call, plus layers
MCP tool
copilot_comparison_full

Side-by-side comparison of 2-6 tickers in one call, for 'X vs Y', 'should I buy NVDA or AMD' or 'compare these three names': for each ticker the model prediction, its drivers, voter coverage, analyst consensus and insider trades, keyed per ticker (layers.ml_prediction__NVDA, layers.ml_prediction__AMD). Answers are cached for 2 minutes; cache_max_age_s=0 forces a fresh one.

Parameters

Query

cache_max_age_snumberOptional
Range0 to 3600

Request body

application/json, required.

tickersarray of stringRequired
holdingsarray of object or nullOptional

Reserved: not used by any computation; the response reports only holdings_provided.

Response

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.

When this aggregation is not served from its cache, each layer it fetches is also billed at that layer's own product rate and needs that product on your plan. See Copilot.

Errors

No error is billed. The body is { "ok": false, "error", "detail", "request_id" }; read the code from error.

ErrorMeaning
400 invalid_tickerThe 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 unauthorizedMissing or invalid API key.
402 plan_requiredYour 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_deniedThis 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_foundNo such resource. Not billed.
422 validationA parameter is missing, out of range or the wrong type; param names it. Not billed.
429 rate_limitedYour plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed.
503 paid_data_unavailableThe data could not be served completely right now; retry later. Not billed.
504 request_timeoutThe 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.