vormkracht10/kvk-api

KvK API client (Dutch Chamber of Commerce API)

v2.0.0 2024-08-30 14:48 UTC

This package is auto-updated.

Last update: 2024-10-30 15:13:01 UTC


README

Latest Version on Packagist Tests Total Downloads

PHP package to communicate with the business register of the Dutch Chamber of Commerce.

At the moment it is only possible to search by company name. The result will contain the following data:

  • KvK number
  • Establishment number
  • Tradename
  • Address(es) (type, full address, street, housenumber, zip, city and country)
  • Website(s)

Installation

You can install the package via composer:

composer require vormkracht10/kvk-api

Upgrade guide

See the upgrade guide for more information on what has changed recently.

Usage

Note: if you don't have an API key yet, get yours at the developer portal of the Chamber of Commerce

use Vormkracht10\KvkApi\ClientFactory;
$apiKey = '<KVK_API_KEY>';

// Optional SSL certificate
$rootCertificate = '<PATH_TO_SSL_CERT>';

$kvk = ClientFactory::create($apiKey, $rootCertificate);

// Search by company name
$companies = $kvk->search('Vormkracht10');

Search with additional parameters

$companies = $kvk->search('Vormkracht10', [
'pagina' => 1,
'resultatenPerPagina' => 10
]);

Set page and results per page before searching

$kvk->setPage(2);
$kvk->setResultsPerPage(20);

Search by KvK number

$companies = $kvk->searchByKvkNumber('12345678');

Search by RSIN

$companies = $kvk->searchByRSIN('12345678');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

License

The MIT License (MIT). Please see License File for more information.