===============================
ch-api
===============================

A Python client library for the UK `Companies House <https://www.companieshouse.gov.uk/>`_ `RESTful API <https://developer.company-information.service.gov.uk/>`_.


.. note::

   The API is free to use and requires an API key. You can `register for an API key <https://developer.company-information.service.gov.uk/get-started>`_ 
   by creating a free account with Companies House. Once registered, you can obtain your API key from your account profile.

To learn more about the API please consult the `official documentation <https://developer.company-information.service.gov.uk/>`_, or start :doc:`here <sources/api-overview>`.

If you're interested in contributing please start :doc:`here <sources/contributing>`.


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   sources/api-overview
   sources/usage
   sources/api-reference
   sources/contributing

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`