Wealthnow
Sign up

API ReferenceExecution & Research

Status

Equity profile

GET/api/v3/skills/apex_equity/{ticker}
Price
4 credits per call
MCP tool
equity_brief

Apex Equity Intelligence — single-call omnibus brief for 'what do you think about $TICKER'. Fuses 12 vendor calls in parallel (daily + hourly charts, company facts, income/balance statements, snapshot, insider, congress, lobbying, gov-contracts, WSB, patents, off-exchange). Returns: 'fundamentals' (12 scalar fields — name, sector, market_cap, last_price, day_change_pct, latest_revenue, latest_net_income, latest_eps, total_assets/liabilities/equity, filing_date (the day the latest statement was filed; period_end is the quarter it covers), and fundamentals_null_reason when the statements are null), 'intel' (8 scalar fields — insider/congress 30d counts over trade dates (insider buys and sells are Form 4 open-market purchases and sales), ttm_lobbying_usd, ttm_gov_contract_usd, wsb_7d_mentions+sentiment, patent_filings_recent, avg_off_exchange_short_ratio_pct_30d (the short-sale share of off-exchange volume, in percent; avg_dark_pool_pct_30d is null: the off-exchange feed carries no share of total volume); each windowed field counts only rows dated inside its window, and 'intel_windows' gives each one's window, date_basis and, when it is null, a reason: layer_not_read (see vendor_errors), or rows_without_dates / page_not_newest_first / page_does_not_reach_window_start (the rows read cannot cover the window, so no count is served); a layer that was not fetched or whose call failed is null, not 0, and 'vendor_errors' says why; the same holds for the intel counts in 'components'), 'flags' (notable patterns: insider_cluster_buy/sell, retail_attention_spike, etc.), 'chart' (primary daily 120-bar candlestick PNG with RSI/MACD/BB indicators, palette-quantized to keep the tool result under 32KB), and 'charts' (a list of ADDITIONAL charts beyond the primary — currently just the hourly intraday chart; do NOT expect the daily here, it's only in 'chart'). 'components' carries raw counts of items behind each digest. 'vendor_errors' is non-empty when one of the parallel fetches failed; the rest of the payload is still usable. For full per-section detail (complete insider trade list, full income statements, etc.) call the dedicated tools fundamentals_/intel_ — apex_equity is the digest, not the firehose.

Parameters

Path

tickerstringRequired

Response

A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Execution & Research). 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_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 Execution & Research guide for this endpoint's fields and examples.