# Changelog of New UK Companies: Companies House Incorporations by SIC Code (`clearpath-data/companies-house-new-companies`) Actor

- **URL**: https://apify.com/clearpath-data/companies-house-new-companies/changelog.md
- **Full Actor documentation**: https://apify.com/clearpath-data/companies-house-new-companies.md

## Changelog

### 1.0 (2026-10-09), pre-release update: approved pricing and shared-key guardrails

- Live API check (17/17): the location filter is broad (a search for Manchester includes nearby towns); the README and the input description now say so and recommend `postcodePrefixes` for exact areas. Test validator tolerates an unshipped `$ref` in the published officer spec. Title shortened to 63 characters (Apify's limit).
- Pricing approved as proposed: `company` $0.002 / $0.0017 / $0.0014 (FREE+BRONZE / SILVER / GOLD+), `officers` $0.0005 and `pscs` $0.0005 per company.
- Shared key (no key in the input): capped at 300 API requests per run. On HTTP 429 it makes one run-wide backoff that respects Retry-After or the reset header (else the full 5-minute window). After the pause a single probe request goes first; a repeat 429 stops the run cleanly with no further requests. Partial results are kept and charges stay consistent. The status message and RUN_REPORT tell the user to add their own free key.
- Own key: unchanged retry behaviour. 429s from requests already in flight now count as one backoff episode.
- New `RUN_REPORT.keyUsage` block and a "Key usage" log line on every run: shared key used, requests, 429s, cap hit, stopped by rate limit.
- Shared-key runs add to a daily record in the named key-value store `companies-house-shared-key-usage` (counts only). Best effort: failures only log a warning. Optional `SHARED_KEY_USAGE_TOKEN` writes the records to the owner's account.
- README: new "Use your own free API key" and "How to get a free API key" sections, linking the official Companies House developer pages. The API-key input title and description recommend your own key for scheduled or large runs.
- Clearer message when the shared key itself is rejected.
- Store title and description no longer say "Official API"; the description and README state the Actor is independent and not endorsed by Companies House. `SHARED_KEY_USAGE_TOKEN` stays disabled in production.

### 1.0 (2026-10-09)

- First release, built on the Companies House Public Data API.
- New-companies feed by incorporation date, with filters for SIC code, location, exact postcode prefix, company type, subtype, status and name. The feed splits the date range into windows to get around the 5,000-results-per-search cap.
- Optional extras: officers, PSCs and the full company profile.
- Lookup by company number, register URL or name.
- Pay per event: `company`, `officers` and `pscs`. Respects the run's maximum cost.
- Rate limiting: stays under 600 requests per 5 minutes, retries 5xx and network errors with backoff, and waits out HTTP 429.
- Clear errors for a missing or rejected API key. The API key comes from a secret input field or the `COMPANIES_HOUSE_API_KEY` environment variable.
- "Only companies not delivered before" option for scheduled runs.