> ## Documentation Index
> Fetch the complete documentation index at: https://docs.noxint.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Operations overview

> All 23 operations, how they bill, and the asset-ID grammar agents can store forever

Every operation lives at `https://noxint.ai/api/v1/{operation}`. All 23 are
GET requests with query parameters. No POST bodies, no verb zoo, nothing an
agent has to be taught twice.

Five operations are free so an agent can learn the entire surface before it
spends anything. The rest return market data and bill in data credits, one
credit per delivered materialization.

## The 23 operations

| Operation                | Returns                                                     | Billing     |
| ------------------------ | ----------------------------------------------------------- | ----------- |
| **Teaching and account** |                                                             |             |
| `docs`                   | Sectioned contract guide as markdown                        | Free        |
| `schema`                 | One operation's machine contract                            | Free        |
| `resolve`                | Canonical asset IDs for a human query, with ranked evidence | Free        |
| `coverage`               | Known assets, or one asset's coverage detail                | Free        |
| `usage`                  | Your remaining credits and rate-limit window                | Free        |
| **Situation**            |                                                             |             |
| `read`                   | The current picture for an asset across every domain        | 1 per asset |
| **Domains**              |                                                             |             |
| `price`                  | Spot price, returns, range position, quote                  | 1 per asset |
| `funding`                | Perp funding rate, APR, venue spread, funding band          | 1 per asset |
| `open_interest`          | Open interest in USD, change, basis                         | 1 per asset |
| `orderflow`              | Net taker delta and spot premium                            | 1 per asset |
| `liquidations`           | Liquidation totals, imbalance, intensity                    | 1 per asset |
| `liquidity`              | Spread, book imbalance, depth                               | 1 per asset |
| `technicals`             | RSI, ADX, ATR and related indicators                        | 1 per asset |
| `structure`              | Trend state, break of structure, session levels             | 1 per asset |
| `profile`                | Sector, market cap, shares outstanding                      | 1 per asset |
| `valuation`              | P/E, P/S, EV/EBITDA                                         | 1 per asset |
| `growth`                 | Revenue, EPS, and free-cash-flow growth                     | 1 per asset |
| `fundamentals`           | Trailing revenue, EPS, free cash flow                       | 1 per asset |
| **Lists**                |                                                             |             |
| `series`                 | Historical bars or a summary for one asset                  | 1 per call  |
| `financials`             | Filed statement line items over several periods             | 1 per call  |
| `events`                 | Filings, insider trades, dividends, splits                  | 1 per call  |
| `holders`                | Institutional holders for one equity                        | 1 per call  |
| `rank`                   | Assets ordered by a chosen metric                           | 1 per row   |

The domain operations cover different planes. Crypto-only: `funding`,
`open_interest`, `orderflow`, `liquidations`, `liquidity`, `structure`.
Equity-only: `profile`, `valuation`, `growth`, `fundamentals`. Both planes:
`price`, `technicals`. The list operations `financials`, `events`, and
`holders` are equity-only; `rank` is crypto-only; `series` serves both planes.

## Asset-ID grammar

Every asset has one permanent, plane-qualified ID. IDs never change, so your
agent stores them once and never re-resolves. Human symbols are input
convenience only; call `resolve` to turn a symbol into its canonical ID.

| Plane                 | Form                                                                   | Example                       |
| --------------------- | ---------------------------------------------------------------------- | ----------------------------- |
| Crypto (slug)         | `crypto:<slug>`, slug is lowercase letters, digits, and single hyphens | `crypto:bitcoin`              |
| Crypto (EVM token)    | `crypto:eip155-<chainId>:<0x + 40 lowercase hex>`                      | `crypto:eip155-1:0xabc...012` |
| Crypto (Solana token) | `crypto:solana:<mint>`, mint is 32-44 base58 characters                | `crypto:solana:EPjF...Dt1v`   |
| Equity                | `eq:<10-digit CIK>:<mnemonic>`                                         | `eq:0000320193:aapl`          |

EVM hex must be lowercase and the CIK is zero-padded to ten digits. A
canonical ID is at most 128 characters.

## Batching

The chargeable domain operations and `read` accept an `ids` parameter: a
comma-separated list of 2 to 10 distinct assets in one call, encoded as
`?ids=a,b,c`. You pass either `id` for a single asset or `ids` for a batch,
never both. Each distinct returned asset costs one credit, so a batch of five
delivered assets costs five credits. The list operations do not accept `ids`.
