# UK Company Accounts (iXBRL) (`metropolitan_fire/uk-company-ixbrl-financials`) Actor

Fetch UK Companies House company profile + parse latest accounts iXBRL into clean JSON for agents. Null-honest: never invents figures. v1 omits officers/PSCs.

- **URL**: https://apify.com/metropolitan_fire/uk-company-ixbrl-financials.md
- **Developed by:** [David Wilson](https://apify.com/metropolitan_fire) (community)
- **Stats:** 2 total users, 1 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## UK Company Accounts (iXBRL) — Apify Actor (local Week 2)

Null-honest parser: company numbers → Companies House profile + latest accounts iXBRL → clean JSON for agents.
**No Apify account. No spend.** v1 omits officers/PSCs.

### Layout

- `fixtures/fixture-pack-20.json` — 20 verified companies (Week 1, David OK)
- `fixtures/samples/*_latest.xhtml` — cached public iXBRL downloads from dry-run
- `schemas/` — input, output, null-honest rules
- `docs/ixbrl-concept-map.json` — FRC concept → JSON fields
- `docs/companies-house-api-key.md` — free CH API key (later; not created yet)
- `src/` — Actor code (CH client, rate limit, iXBRL parser, pipeline)
- `scripts/dry_run_fixtures.py` — run all 20 locally
- `dry-run-output/fixture-results.json` — latest dry-run
- `.actor/` — Apify-shaped metadata (not deployed)

### Run locally

```bash
cd /workspace/apify-uk-company-ixbrl
python3 -m src.main --fixtures --out dry-run-output/fixture-results.json
python3 -m src.main --numbers 11006939 SC028977
python3 tests/test_parser_innov8.py
```

Optional: set `CH_API_KEY` for Public Data API mode. Without it, uses public HTML (filing-history pagination + xhtml document links).

### Status enum

`parsed` | `no_ixbrl_available` | `no_accounts_filed` | `parse_failed`

### Week 2 dry-run snapshot (28 Oct 2026 Europe/London)

20/20 fixtures matched expected status candidates via public HTML (no API key):

- parsed: 7 (micro / exemption / dormant / LLP with iXBRL)
- no_ixbrl_available: 11 (PLCs, large full accounts, some dormant PDF-only)
- no_accounts_filed: 2 (new incorporations)
- parse_failed: 0

### Next (Week 3)

Finance QA checklist on 5 sample JSONs; pricing draft; still no Apify until David replies **GO**.

# Actor input Schema

## `companyNumbers` (type: `array`):

Companies House numbers (8 digits, or SC/NI/OC prefixes). Preferred over names.

## `companyNames` (type: `array`):

Optional name lookup when number unknown. First exact/best CH search hit used; ambiguous matches return profile with status parse_failed / error_code name_ambiguous unless companyNumbers also given.

## `accountsYears` (type: `integer`):

How many most-recent accounts periods to attempt (default 1). Prior comparative figures inside one filing are separate from this.

## `includePriorComparatives` (type: `boolean`):

If true, populate figures.prior from the same iXBRL filing when tagged.

## `currency` (type: `string`):

Report monetary values as filed (ISO code from unit). Do not convert. Informational preference only in v1.

## Actor input object example

```json
{
  "accountsYears": 1,
  "includePriorComparatives": true,
  "currency": "as_filed"
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("metropolitan_fire/uk-company-ixbrl-financials").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("metropolitan_fire/uk-company-ixbrl-financials").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call metropolitan_fire/uk-company-ixbrl-financials --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,metropolitan_fire/uk-company-ixbrl-financials"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/sLlEnXdY7w6zwelcn/builds/DAZqPdwEDev8HPxUd/openapi.json