Wealthnow
Sign up

API ReferenceCopilot

Status

Ticker full

GET/api/v3/copilot/ticker_full/{ticker}
Plan
Expert and up
Price
10 credits per call, plus layers
MCP tool
copilot_ticker_full

OMNIBUS aggregation for one ticker — the single-call single-stock verdict path. Pulls BOTH the 5-layer transparency cluster AND the 7-layer smartmoney cluster in ONE call (up to 12 underlying tools in parallel, server-side). Replaces a 24-72 call fan-out with a single call. Use for 'should I buy X?' / 'what do you think of Y?' / 'verdict on Z' shapes. include_smartmoney and include_transparency flags let comparison views skip clusters they don't need. degraded is true when a layer failed, its vendor refused, or its source is stale (not a quiet ticker's options-flow alert list; a stale prediction book counts); missing_reasons says which. as_of is the core layer's DATA time, rendered_at the response time. Cache TTL 60s. Pass cache_max_age_s=0 to bypass cache.

Parameters

Path

tickerstringRequired

Query

include_smartmoneybooleanOptional
Defaulttrue
include_transparencybooleanOptional
Defaulttrue
candidate_weight_pctnumberOptional

Echoed back unchanged; nothing is computed from it yet, so no unit is applied. Note the POST portfolio tools take candidate_weight_pct as a FRACTION of NAV (0.04 = 4%).

Range0 to 100
cache_max_age_snumberOptional
Range0 to 3600

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 unknown_tickerNo 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 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.