CompaniesHouse.NET

A simple .NET client wrapper for CompaniesHouse API.

Getting Started

CompaniesHouse.NET can be installed via the package manager console by executing the following commandlet:

PM> Install-Package CompaniesHouse

Once we have the package installed, we can then create a CompaniesHouseSettings with a ApiKey which can be created via the CompaniesHouse API website

var settings = new CompaniesHouseSettings(apiKey);

We need to now create a CompaniesHouseClient - passing in the settings that we've just created.

var client = new CompaniesHouseClient(settings);

This is the object we'll use going forward with any interaction to the CompaniesHouse API.

Usage

Searching for a company

To search for a company, we first need to create a CompanySearchRequest with details of the search we require.

var request = new CompanySearchRequest()
{
    Query = "Liberis",
    StartIndex = 10,
    ItemsPerPage = 10
};

We can then pass the request object in to the SearchCompanyAsync method and await on the task.

var result = await client.SearchCompanyAsync(request);

Getting a company profile

To get a company profile, we pass a company number in to the GetCompanyProfileAsync method and await on the task.

var result = await client.GetCompanyProfileAsync("03977902");

If there was no match for that company number then null will be returned.

Getting company officer list

To get a list of officers for a company, we pass a company number in to the GetOfficersAsync method and await on the task.

var result = await client.GetOfficersAsync("03977902");

We can also pass in some optional parameters of startIndex and pageSize which will allow us to page the results.

var result = await client.GetOfficersAsync("03977902", 10, 10);

Contributing

1. Fork
2. Hack!
3. Pull Request