Wealthnow
Sign up

API ReferenceFunds & Institutional

Status

Insider clustersLegacy route

GET/api/insider/clusters
Price
4 credits per call
MCP tool
insider_clusters

Clusters of insider buying across companies: tickers where two or more distinct insiders made purchases (Form 4 code P) in the last 30 days. Call it when the user asks 'where are insiders buying?' or wants market-wide insider conviction rather than one company's filings. Each cluster's as_of_ts is its latest purchase date; complete=false would mean the 30-day scan hit its row cap. Clusters computed from the insider feed also carry n_purchases, n_purchases_priced and total_shares: a purchase re-carried by a later ingest or restated in a later filing (a Form 4/A) counts once. Three or more buyers filled on one day at one identical price are one execution on their behalf (an employee purchase plan, a compensation program or an offering), not separate decisions: n_buyers_same_day_price counts them, cluster_score (n_buyers_discretionary / 5, capped at 1) counts only buyers with a purchase of their own, and plan_purchase=true marks a cluster that is mostly such an execution; plan clusters rank after every discretionary one. total_value_usd is shares times the price as filed, served only for a US-incorporated issuer, or a US line that is not an ADR of an issuer with no traded common listing in Canada (a foreign-incorporated US-only listing files in dollars), and only when every purchase is priced. The reference covers US and Canadian lines only, so a home listing outside North America (London, say) is not seen and such an issuer's total is still served as USD, even where a trade was filed at the home-market price; otherwise it is null and total_value_usd_reason says why: adr_home_market_shares (an ADR's filings report the home-market shares, priced in the home currency, and total_shares counts those shares, not ADRs), foreign_issuer_currency_unknown (a foreign issuer with a listing in Canada), issuer_not_identified, issuer_reference_unavailable or unpriced_purchases. No exchange rate is applied. A 503 dataset_unavailable (refunded) means the feed could not be read, not that nobody bought.

Parameters

Query

limitintegerOptional

Maximum clusters returned.

Default25
Range1 to 500

Response

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