Skip to main content

A Python client for the Companies House API

Project description

Companies House API Library

A Python client for interacting with the Companies House API.

Installation

pip install companies-house-api-lib

Usage

from companieshouse import CompaniesHouseClient

# Make sure to set the COMPANIES_HOUSE_API_KEY environment variable
# export COMPANIES_HOUSE_API_KEY="YOUR_API_KEY"

client = CompaniesHouseClient()

# Search for companies
search_results = client.search_companies("python")
print(search_results)

# Get a company profile
if search_results.get("items"):
    company_number = search_results["items"][0]["company_number"]
    company_profile = client.get_company_profile(company_number)
    print(company_profile)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

companies_house_api_lib-0.1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

companies_house_api_lib-0.1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file companies_house_api_lib-0.1.tar.gz.

File metadata

  • Download URL: companies_house_api_lib-0.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for companies_house_api_lib-0.1.tar.gz
Algorithm Hash digest
SHA256 14bb7de8d6caacec506cde6c0f3d0364016270a5f486bc97fd45f64dce32dbb3
MD5 8099aa09dd73b2c9d2f9ded9207894f1
BLAKE2b-256 9f6f7c325279f9d68dddb514a509a6a26485b53ddc752b629d46e5f409136082

See more details on using hashes here.

File details

Details for the file companies_house_api_lib-0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for companies_house_api_lib-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 937c01b1f7226007dd04d8d5752670b66e17b812f80c12b52cb8075d64e50765
MD5 47ca603ae5dec2f0c9f5574e9964e92a
BLAKE2b-256 e09239b88bfdfdb60c966878525fecb9c46405d2a18c6729d9a1c7e9e6bd2fdb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page