Wealthnow
Sign up

API ReferenceResearch Datasets

Status

Research read

GET/api/v2/datasets/{dataset}
Plan
Starter and up, by dataset
Price
Priced per dataset
MCP tool
research_read

Read any research dataset by slug (discover via research_datasets). ?ticker= pushes an exact server-side filter down the dataset's own symbol column when it has one; datasets keyed by an internal security id instead state explicitly that ticker was ignored. The implied_vol_by_ticker slug REQUIRES ?ticker= and resolves the symbol to that id automatically before pushdown. The cds_composites slug serves the FULL 2005–2025 spread history. Unfiltered reads are capped at 5000 rows.

Parameters

Path

datasetstringRequired

Query

tickerstringOptional

Exchange symbol — pushed down the dataset's own symbol column.

limitintegerOptional
Default1000
Range1 to 50000
permnointegerOptional

Security number — only on datasets keyed by it (security_names_history, security_issuer_links); 422 elsewhere.

Range1 to 9999999
gvkeystringOptional

Issuer key, 1-6 digits — only on datasets keyed by it (security_issuer_links, fundamentals_pit_report_dates); 422 elsewhere.

Response

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