ZINT

Use when a user provides a UK company **name** and/or **domain** but not a `company_number`. Returns a ranked list of candidate UK entities with company numbers that can be passed to `/data`, `/context/news`, `/context/accounts`, or `/context/website`. Costs **10 credits** per non-empty response (free if no candidates are found). Provide at least one of `name` or `domain`. When both are supplied they are combined as ranking signals. Each candidate carries a list of which signals fired (`name_exact`, `domain_primary`, `cluster_primary`, etc.) so the caller can judge confidence.

api_disambiguate_endpoints_disambiguate_company

Retrieve tagged sections of UK Companies House annual accounts for a single company. Pass `preview_only=true` to list the available sections for each filing without downloading the text. Costs 1 credit per filing in preview mode and 10 credits per filing for extraction. Top-level section slugs expand to include their children; omit `sections` (or pass `['all']`) to return everything. Requires premium data access.

api_context_accounts_endpoints_get_context_accounts

Retrieve specific data sections for one or more companies. Pass a list of company numbers and a list of field names you want returned. Credits are only charged for fields that contain data. ## Batching Up to **100 company numbers** per request. Lookups run in parallel, so the wall-clock cost is roughly the same as a single-company request. The response returns `results` (one entry per company that was found) and `not_found` (company numbers that did not exist). Duplicates in the request are deduplicated while preserving order. ## Pagination Fields marked as *paginated* return an envelope with `items`, `total_count`, `page`, `page_size`, and `total_pages`. Default page size is **50**, maximum **100**. Pass per-field pagination via the `pagination` parameter: ```json {"officers": {"page": 2, "page_size": 25}} ``` The `pagination` map is keyed by **field name**, not by company. The same `{page, page_size}` is applied to every company in the batch, and each company in `results` returns its own independent envelope (its own `items`, `total_count`, `total_pages`). If `page` exceeds a given company's `total_pages`, that company returns `items: []` rather than an error — so you can safely paginate to the deepest company in the batch without special-casing shorter ones. There is no per-company pagination override in a single call. If you need different page depths per company, split into separate requests. Credits are charged based on `total_count`, not page size — you pay once per `(company, field)` regardless of how many pages you fetch. ## Historical Fields Two fields use **per-year pricing** (5 credits/year): | Field | Parameter | Max cost | |-------|-----------|----------| | `historical_financials` | `historical_financials_year_count` (1–5, default 5) | 25 credits | | `historical_energy_and_emissions` | `historical_energy_and_emissions_year_count` (1–5, default 5) | 25 credits |

api_endpoints_get_company_data

Retrieve recent news articles mentioning a single UK company, including LLM-extracted business-event categories (acquisitions, leadership changes, regulatory actions, etc.) and per-article summaries. Costs **10 credits** per request (free if no articles are found). Expects a `company_number`. Resolve free-text company names or domains via `/disambiguate` first. Pairs with `/data` (structured firmographics for the same company) and with `/search`'s `news_text` / `news_event_categories` / `news_within_days` filters (find companies *by* news signal before fetching the articles themselves). See per-field `description` / `examples` for the date window, category enum, and full-text toggle.

api_context_endpoints_get_context_news

Return the authenticated user's current credit balance. **Free** — no credits are charged. Rate limited per user to prevent abuse.

api_credits_endpoints_get_credit_balance

Retrieve tagged sections of a UK company's website, categorised by content type (products and services, company overview, contact details, case studies, careers, and more). Costs **10 credits** per request (free if no website content is found). Omit `tags` (or pass `['all']`) to return all available sections. Pass specific tag slugs to retrieve only those categories. See the `tags` field's `enum` for the full slug list. `found=true` means website content exists in our data for this company; `sections` may still be empty if none of the company's website sections match the requested tags.

api_context_website_endpoints_get_context_website

Discover complete answer fields to request through POST /magic-insights/answers. Missing and unknown answers are free; each usable answer costs 3 credits.

list_magic_insights_answers

Return self-contained public search definitions for one published Magic Insights module. Authenticated and rate limited, but free to call.

list_magic_insights_filters

List modules with filters published for Data API search. Authenticated and rate limited, but free to call.

list_magic_insights_modules

**Not for name lookup.** To resolve a free-text company name or domain to a `company_number`, use `/disambiguate` instead. Filter the UK company database using structured criteria. Returns a paginated list of matching company numbers. Costs **10 credits** per search (free if no results are found). Every filter — including its semantics, accepted values, examples, and any preferred higher-level alternative — is documented inline on the request-body property itself (`description`, `examples`, `guidance`). Read those per-field hints before constructing a query; this endpoint description intentionally does not enumerate filters or worked examples, so that the schema remains the single source of truth.

api_endpoints_search_companies