HitHorizons API Documentation
API Introduction
HitHorizons API allows working with company data in European database. It provides endpoints for searching in the database and retrieving company data.
Getting Started
Follow the guide: Getting Started
API Endpoints
The API provides the following endpoints:
-
/Company/Get
- Retrieve data for a single company, identified by HitHorizons ID.
- Code lists for fields in detail
- Segmentation statistics reference
-
/Company/Search
- Search company database, using structured query.
- List of countries for searching in "Country" field.
- Code lists for fields in search results (Industry)
-
/Company/SearchRaw
- Search company database, using unstructured query.
- List of countries for searching in "Address" field.
- Code lists for fields in search results (Industry)
HitHorizons ID Description
The structure of HitHorizons ID is the following:
H-[CC][SC][7DIGITS][CHECK DIGIT]
Example: H-DE0019345275
H-
: Prefix, identifying HitHorizons ID.CC
: ISO 3166 alpha-2 (two-letter) country code.-
SC
: Alphanumeric subdivision code.- Currently reserved for future use, only value
00
or01
is used. - In cases when existing companies within one country don't fit in the space provided by the subsequent digits, the value is
01
.
- Currently reserved for future use, only value
7DIGITS
: 7-digit number.-
CHECK DIGIT
: "mod 11" check digit.- Computed so that multiplying each digit by its position in the number (counting from the right) and taking the sum of these products modulo 11 is 0.
- The digit the farthest to the right (which is multiplied by 1) is the check digit, chosen to make the sum correct.
- In case it would have the value 10, the value is skipped and not assigned.
- The check digit is computed in the same way as ISBN 10 check digit.
API Conventions
Requests
- All requests need to be authenticated using API key obtained from the Developer Portal. The API key is sent in HTTP header
Ocp-Apim-Subscription-Key
.
Responses
-
Response data is wrapped in an envelope containing the following fields:
success
[bool]: Indicates whether the call was successful.error
[string]: In case of error, contains an error description.result
: Actual data returned from the API.