# numi

> Revenue by business segment, product and region for US SEC filers, each breakdown checked against reported revenue, and fundamentals as filed.

- [Introduction](https://docs.numi.sh/introduction.md): Revenue by business segment, product and region for US SEC filers, each breakdown checked against reported revenue, and fundamentals as filed.
- [Quickstart](https://docs.numi.sh/quickstart.md): Make an API key and get Microsoft's revenue by business segment in one call.
- [Authentication and limits](https://docs.numi.sh/authentication.md): Send an API key with each request. The limits of a plan apply to the account, across REST and MCP.
- [MCP server](https://docs.numi.sh/mcp-server.md): Connect Claude, ChatGPT, Cursor, Claude Code or any MCP client to the data.
- [Plans](https://docs.numi.sh/plans.md): The sandbox, free for 10 companies, and Builder, every company for $20 a month. You can use the data commercially on both.
- [Licensing](https://docs.numi.sh/licensing.md): Commercial use on every plan, the free one included, with no attribution required.
- [Segments](https://docs.numi.sh/segments.md): Axes, members, segment and reconciling rows, and the reconciliation of each axis with reported revenue.
- [Fundamentals](https://docs.numi.sh/fundamentals.md): The line items of a filing as the filing states them, each with its concept, unit and period.
- [Bulk files](https://docs.numi.sh/bulk.md): Every company, filing, axis, segment and line item, as Parquet and as CSV.
- [Search companies by ticker or name](https://docs.numi.sh/api-reference/search-companies.md): Returns the companies whose ticker or name matches `q` and that have at least one extracted filing. An exact ticker comes first, then the tickers that start with `q`, then the names that contain it, each group in name order. `%`, `_` and backslash in `q` match as plain characters, not as wildcards.
- [Get a company and its filings](https://docs.numi.sh/api-reference/get-company.md): Returns the company and each of its extracted filings, the newest period first.
- [Get the segments of a filing by axis](https://docs.numi.sh/api-reference/get-segments.md): Returns the segment breakdowns of one filing, one per XBRL axis: business, product or geography. Each axis has its rows, and `coverage_ratio` and `reconciliation` for how their revenue compares with the revenue that the filing reports.
- [Get one axis across every filing](https://docs.numi.sh/api-reference/get-segment-history.md): Returns one axis in every filing of `period_type` that has it, the oldest period first. A filing and its amendment for one period are two entries, and each entry has its own `filing` field.
- [Get the segment note of a filing](https://docs.numi.sh/api-reference/get-segment-note.md): Returns the segment note of one filing as plain text, and `source_concept`, the XBRL concept of the note. Table rows stay on one line each.
- [Get the fundamentals of a filing as filed](https://docs.numi.sh/api-reference/get-fundamentals.md): Returns the line items of one filing as the filing states them, revenue first. With `filing_id`, the line items come from that filing. Without `filing_id`, they come from the newest filing of `period_type` that has line items.
- [Get links to the bulk files](https://docs.numi.sh/api-reference/get-bulk-latest.md): Returns links to the bulk files of the account's plan. Each link is valid for 15 minutes. On the sandbox plan, the files are the sample, which has the sandbox companies only. On the Builder plan, the files are the latest full set. Each table comes as Parquet and as CSV.
- [Ask numi to extract a company's filings](https://docs.numi.sh/api-reference/request-extraction.md): On the Builder plan, puts a company in the queue for extraction. When numi has extracted the filings of the company already, the response is 200 with the company. Otherwise the response is 202 with `request_id`, the integer id of the extraction request, not the `meta.request_id` of the response. The…
- [Get the plan and usage of the key](https://docs.numi.sh/api-reference/get-me.md): Returns the plan of the key's account, the prefix of the key and the limits of the plan. It also returns the number of requests on the account today, this one included. REST and MCP calls count toward the same limits, and the daily count is reset at midnight UTC.
- [Get the name and version of the API](https://docs.numi.sh/api-reference/get-api-info.md): Returns the name and version of the API and the links to the docs and to this document. You can call it without an API key.
- [Get this document as JSON](https://docs.numi.sh/api-reference/get-open-api-json.md): Returns the OpenAPI document of the API. The body is the document itself, without the `data` and `meta` envelope. You can call it without an API key.
- [Get this document as YAML](https://docs.numi.sh/api-reference/get-open-api-yaml.md): Returns the OpenAPI document of the API as the YAML file it is written in. The body is the file itself, without the `data` and `meta` envelope. You can call it without an API key.
- [Get the account of the signed-in user](https://docs.numi.sh/api-reference/get-account.md): Returns the account of the signed-in user of the numi web app, with its plan, its limits, its usage today and its subscription. The API makes the account on the first call. The account routes take a session, not an API key.
- [List the API keys of the account](https://docs.numi.sh/api-reference/list-account-keys.md): Returns the keys of the account that are not revoked, newest first. A key is shown whole only once, when it is made, so each key in the list has only its `prefix`.
- [Make an API key](https://docs.numi.sh/api-reference/create-account-key.md): Makes a key for the account and returns it whole. This is the only time the key is shown, so store it at once. An account can have as many active keys as its plan allows.
- [Revoke an API key](https://docs.numi.sh/api-reference/revoke-account-key.md): Revokes one key of the account. A request with the key is refused from then on.
- [Get the number of requests of the account for each day](https://docs.numi.sh/api-reference/get-account-usage.md): Returns the number of requests of the account on each of the last `days` UTC days, today included, oldest first, with REST calls in `api` and MCP calls in `mcp`. A day without requests has zeros.
- [Start the checkout of the Builder plan](https://docs.numi.sh/api-reference/create-checkout.md): Returns the URL of a Stripe Checkout for the Builder plan. After payment, Stripe sends the browser back to the account page of the numi web app, and the plan changes once Stripe tells the API.
- [Open the billing portal](https://docs.numi.sh/api-reference/create-portal.md): Returns the URL of the Stripe billing portal of the account, where you manage the subscription, card and invoices of the account. The portal sends the browser back to the account page.
- [Changelog](https://docs.numi.sh/changelog.md): Changes to the API, the MCP server and the bulk files.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.