API documentation

Returns a columnar list of assets of the given type — the website's screener as an API. Supports field projection, sorting, and Stripe-style filtering (filter[field][gt|lt|contains|include|exclude]). Column names are the asset endpoint's fields. Unknown field, sort, or filter column names return a 400 that suggests the closest names. Choosing `fields` or passing any filter needs a Personal plan; sort, order and limit are free. Inactive assets are left out.

Returns the current row for one asset: price and profile, and its attention, engagement and sentiment over the last day, week, month and year, with ranks, percentiles and changes. Several hundred fields per asset; the available fields depend on the asset type. Prices are live. Pass fields=* to see every field the asset carries, values included, and read names off that.

Returns historical series for one asset, anywhere in its full history: price candles and volume, social engagement and attention, bullish and bearish engagement, engagement per topic, and engagement by community tenure. Data is columnar: a `dates` array (Unix seconds, ascending) and one array per field, with null where a series has no bucket. Every `*Engagement` series has a `*Attention` twin, the asset's 0-1 share of the cross-entity pool (null where the pool is empty). `communityNewEngagement`/`communityRegularsEngagement` split engagement by the author's tenure with the asset (New = first or second lifetime active month, Regulars = third or later); they sum to slightly less than `socialEngagement` because engagement from unidentifiable authors is excluded — do not renormalize. Pass `dates` instead of a window to get only named days. A window starting further back than 90 days, or at hour or month resolution, needs a Personal plan.

Returns written summaries of what was said about one asset, as lists of plain-text bullets per day or per month. Keys: messages (the whole conversation), sentimentBullish and sentimentBearish (the case each side made), topic{Topic} for the type's topics, and communityNew and communityRegulars where the asset carries them. Pass latest=1 for each key's newest non-empty summary whatever its date; that read is never plan-gated. A named window starting further back than 90 days, or at month resolution, needs a Personal plan.

Returns the assets this asset's audience also discusses, ranked by audience-overlap lift — rank 1 is the strongest overlap. A measure of who talks about what, not of price correlation or sector membership. Co-attention is not published for every asset; one without it answers with empty arrays.

Returns earnings reports, dividends, splits and analyst rating changes for one asset, as one array sorted newest first, each row stamped with its `kind`. Every row carries `date` (Unix seconds, UTC midnight) and `day` (YYYY-MM-DD). Fields by kind: earnings `epsActual` (null for a scheduled report), `epsEstimated`; dividend `dividend`, `adjDividend`, `frequency` (the date is the ex-date); split `numerator`, `denominator`; rating `firm`, `action`, `ratingCurrent`, `ratingPrior`. Every figure is nullable. The feed includes future rows: the next scheduled report and a declared dividend not yet ex. Equities only; funds and cryptocurrencies answer with an empty array and a note in `meta`.

Returns one financial statement for one asset, newest fiscal period first — the data behind the website's Financials tab. Rows are the provider's own: `date` is the fiscal period end as YYYY-MM-DD and `period` its label (FY, Q1, …). Every metric is nullable: null means the provider sent no line, 0 means a reported zero. Per-period valuation multiples (market cap, enterprise value, P/E, P/S, P/B, yields) are null by construction and exist only on the fundamentals `ttm` row. An asset with no published document answers with an empty array and a note in `meta`.

Returns aggregate engagement and sentiment timeseries for an asset type, bucketed by sector, market cap, region, theme, or discussion topic. Values are raw engagement counts, not attention shares. Topic buckets group MESSAGES rather than companies, overlap one another, and cover only part of the conversation, so topic series do not sum to the market. Themes group companies but overlap and leave most of the market out, so they do not sum to it either. A window starting further back than 90 days, or at hour or month resolution, needs a Personal plan.

Returns collected news articles, newest first. With no filters it is the whole market — every article about every asset we track. `type` narrows it to asset classes and `ticker` to named assets; the two compose as OR within each list and AND across them, so a type plus a ticker of another class matches nothing. `description` comes from the publisher's OpenGraph tags and is empty for roughly a third of articles. Each article's `assets` array names every tracked asset it was collected for, with the ticker and type the other endpoints take. There is no offset, cursor, or page parameter: the window's bounds ARE the cursor — with order=desc, request the next page with `end` set to the `publishedAt` of the oldest article you received (with order=asc, move `start` to the newest), and deduplicate on `id`, because the article on the boundary is served again. A window starting further back than 90 days requires a Personal plan.

Returns every publisher that wrote within the window, with the number of articles each contributed, sorted by count descending. These are the exact strings the news endpoint's `publisher` filter matches, so fetch this list before filtering rather than guessing names. A publisher name is occasionally the empty string. Counts are of distinct articles, so one story about four tracked assets is counted once. There is no limit parameter — the point of this endpoint is the complete vocabulary for the window. The window is the news endpoint's: the last 30 days by default. A window starting further back than 90 days requires a Personal plan.

Finds tracked assets by ticker or name, closest first: an exact ticker, then tickers starting with the text, then names with a word starting with it, then tickers or names containing it, and for four or more characters a name word one edit away. Use it to turn a company or coin name into the type and ticker the other endpoints take. Inactive assets are left out.