kudosagency/companieshouse

A Laravel wrapper for the companies house API

1.0.0 2020-06-26 08:58 UTC

This package is auto-updated.

Last update: 2022-05-26 13:57:34 UTC


README

A laravel package to query the Companies House API.

Install

composer require kudosagency/companieshouse

Publish config file

php artisan vendor:publish

Add your Companies house API key to your config (/config/companieshouse.php) or env file

COMPANIES_HOUSE_API_KEY=Your_api_key

Usage

use kudosagency\CompaniesHouse\Controllers\CompaniesHouse;

To use

$companieshouse = new CompaniesHouse;
$companieshouse->get('search/companies?q=KudosLabs');

Or, you can use the facade

CompaniesHouse::get('search/companies?q=KudosLabs');

Full API reference

License

This Laravel Companies House API package is open-sourced software licensed under the The Unlicense.