Download the PHP package finstat/client-api without Composer
On this page you can find all versions of the php package finstat/client-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download finstat/client-api
More information about finstat/client-api
Files in finstat/client-api
Package client-api
Short Description PHP Client for Finstat API
License MIT
Homepage https://github.com/finstat/ClientApi.PHP/
Informations about the package client-api
Finstat API Client for PHP
This repository contains a PHP client for interacting with the Finstat API services. Finstat provides financial and corporate data for businesses in Slovakia and the Czech Republic.
Features
- Retrieve detailed company information by ICO (Company ID)
- Search companies using autocomplete functionality
- Monitor changes in company data, and the proceedings of monitored companies
- Financial statements and their template legends
- Access daily data diffs and pre-generated reports
- Bankruptcy, restructuring and distraint (CRE) searches
- Support for both Slovak and Czech business registries
Every class is loaded by Composer's autoloader (vendor/autoload.php); the examples below assume it is included.
Installation
Configuration
Before using the API client, you need to set up your credentials:
Usage Examples
Slovak Companies API
Czech Companies API
Monitoring API
Statement API
In XML mode templates are names. JSON sends them as the server's numbers: 1 Template2011v2, 2 Template2014, 3 Template2014micro, 4 TemplateFinancial, 8 TemplateROPO, 9 TemplateNujPU.
Daily Diff API
Reporting API
Bankruptcy and Restructuring API
Distraints API (Centrálny register exekúcií)
Only RequestDistraintSearch and RequestDistraintDetail spend credit; the three
"stored" calls re-read data a previous live call already paid for. Every call still
counts against the daily/monthly API call allowance.
When the CRE register itself is unreachable the two live calls throw
RegisterUnavailableException (HTTP 502) — no credit is charged, so the request
is safe to retry.
Response Data
The API returns structured data objects containing company information. Depending on the request type, different data fields are available:
Basic Fields (available in all responses)
Ico- Company IDName- Company nameStreet- Street addressStreetNumber- Street numberZipCode- ZIP/Postal codeCity- CityDistrict- DistrictRegion- RegionCountry- CountryUrl- Finstat URL for the company
Additional Fields (available in detail/extended/ultimate responses)
- Legal form information
- Registration details
- Financial data (revenue, profit)
- Credit scores
- Warning indicators
- Bank accounts
- Employee counts
- Ownership information
- Statutory representatives
- Web pages
- And many more...
Error Handling
The API client throws exceptions in case of errors. Make sure to handle these appropriately:
All exceptions extend FinstatException, so a single catch (FinstatException $e)
is enough if you do not need to tell the cases apart. The specific types are
NotFoundException (404), LimitReachedException (402), UnauthorizedException (401),
AuthenticationException / InsufficientAccessException / LicenseExpiredException /
AccessDisabledException / InvalidHashException (403), BadRequestException (400),
RateLimitExceededException (429), GdprRestrictionException (451),
RegisterUnavailableException (502) and ParseException.
API Limits
You can check your current API usage limits:
Requirements
- PHP 7.1 or higher
- cURL extension
- Zlib extension
- DOM extension
- JSON extension (for JSON responses)
- SimpleXML extension (for XML responses)
License
MIT License
Support
For API access and keys, please contact [email protected]
All versions of client-api with dependencies
ext-dom Version *
ext-zlib Version *
ext-json Version *
ext-simplexml Version *