`ch_api.types.public_data`#

Public data models for the Companies House API.

This package contains Pydantic models for all public data returned by the Companies House API, organized by API endpoint and data category.

API Endpoints#

The Companies House API provides read-only access to public company information through numerous endpoints:

Company Information: Profile, status, registered address
Officers & Management: Officers, appointments, officer changes
Ownership & Control: Persons with Significant Control (PSC), statements
Financial: Charges, exemptions, insolvency information
Documents: Filing history
Search: Full-text search across company names, officers, etc.
Registers: Registers held at Companies House
Overseas: UK establishments for overseas companies

Module Organization#

Each module corresponds to a Companies House API endpoint:

:mod:`company_profile` - Company profiles and status information
:mod:`company_officers` - Officers and director information
:mod:`officer_appointments` - Detailed officer appointment records
:mod:`officer_changes` - Historical officer changes
:mod:`psc` - Persons with Significant Control data
:mod:`charges` - Charges over company assets
:mod:`filing_history` - Historical filings and documents
:mod:`insolvency` - Insolvency and administration data
:mod:`exemptions` - Exemptions from filing requirements
:mod:`disqualifications` - Officer disqualifications
:mod:`company_registers` - Registers held at Companies House
:mod:`registered_office` - Registered office address
:mod:`uk_establishments` - UK branches of overseas companies
:mod:`search` - Search results (companies, officers, disqualified officers)
:mod:`search_companies` - Advanced company search results

API Documentation#

Full API documentation and schema specifications are available at:: https://developer-specs.company-information.service.gov.uk/api.ch.gov.uk-specifications/swagger-2.0/spec/swagger.json

Rate Limiting#

The Companies House API enforces rate limits. See developer guidelines for details:: https://developer-specs.company-information.service.gov.uk/guides/rateLimiting

Enumeration Types#

Many API fields use enumeration types (standardized values). The complete mapping of enumeration values is available on GitHub:

companieshouse/api-enumerations

See also

ch_api.Client: The main API client for querying these endpoints
ch_api.types: All type definitions

This module contains the public data models that map to Companies House API responses:

Company Profile: Core company information
Officers: Company officers and appointments
PSC: Persons with Significant Control
Filing History: Filing records
Charges: Charge registrations
Search Results: Search response models
UK Establishments: UK establishment data