ch_api.types.compound_api_types#

Compound API type wrappers for complex Companies House API responses.

This package contains custom wrapper classes for complex API responses that require additional processing or composition beyond simple Pydantic models.

These types are typically returned by client methods that wrap multiple API endpoints or transform standard responses for easier consumption.

For example: - Search results with custom pagination handling - Officer appointment lists with aggregation - PSC lists with special filtering

See also

ch_api.types.public_data

Base Pydantic models for individual endpoints

ch_api.types.pagination

Pagination support

This module contains complex nested data structures returned by the Companies House API:

  • Officers: Company officers, appointments, and changes

  • PSC: Persons with Significant Control data

  • Filing History: Company filing records

  • Charges: Charge registrations

  • Insolvency: Insolvency information

  • Disqualifications: Officer disqualifications

  • Company Registers: Register information

  • Search: Search result types

This Page