Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vormkracht10/kvk-api

PHP package to retrieve data from the Dutch Chamber of Commerce (KvK)
https://github.com/vormkracht10/kvk-api

chamber-of-commerce kvk kvk-api php php7 php8

Last synced: 4 days ago
JSON representation

PHP package to retrieve data from the Dutch Chamber of Commerce (KvK)

Host: GitHub
URL: https://github.com/vormkracht10/kvk-api
Owner: vormkracht10
License: mit
Created: 2022-06-13T09:22:53.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-08-30T14:48:38.000Z (3 months ago)
Last Synced: 2024-11-01T03:35:44.688Z (15 days ago)
Topics: chamber-of-commerce, kvk, kvk-api, php, php7, php8
Language: PHP
Homepage:
Size: 67.4 KB
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        # KvK API client (Dutch Chamber of Commerce)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/vormkracht10/kvk-api.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/kvk-api)

[![Tests](https://github.com/vormkracht10/kvk-api/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/vormkracht10/kvk-api/actions/workflows/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/vormkracht10/kvk-api.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/kvk-api)

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:

```bash

composer require vormkracht10/kvk-api

```

## Upgrade guide

See the [upgrade guide](docs/upgrade.md) 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](https://developers.kvk.nl/) of the Chamber of Commerce

```php

use Vormkracht10\KvkApi\ClientFactory;

$apiKey = '';

// Optional SSL certificate

$rootCertificate = '';

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

// Search by company name

$companies = $kvk->search('Vormkracht10');

```

### Search with additional parameters

```php

$companies = $kvk->search('Vormkracht10', [

'pagina' => 1,

'resultatenPerPagina' => 10

]);

```

### Set page and results per page before searching

```php

$kvk->setPage(2);

$kvk->setResultsPerPage(20);

```

### Search by KvK number

```php

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

```

### Search by RSIN

```php

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

```

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Credits

-   [Bas van Dinther](https://github.com/Baspa)

-   [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.