Giter VIP home page Giter VIP logo

companieshouse.net's Introduction

CompaniesHouse.NET

A simple .NET client wrapper for CompaniesHouse API.

install from nuget downloads Build status

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 SearchCompany method and await on the result.

var result = await _client.SearchCompanyAsync(request);

Contributing

  1. Fork
  2. Hack!
  3. Pull Request

companieshouse.net's People

Contributors

kevbite avatar jay2base avatar

Watchers

Steve Williams avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.