You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f627f9f
Browse filesBrowse the repository at this point in the historyBrowse files
@@ -174,8 +182,8 @@ The following requests are available to query a single company:
174
182
175
183
Request | URL
176
184
------- | ---------
177
-
retrieve company | https://www.northdata.de/_api/company/v1/company
178
-
retrieve publications of a company | https://www.northdata.de/_api/company/v1/publications
185
+
retrieve company | https://www.northdata.com/_api/company/v1/company
186
+
retrieve publications of a company | https://www.northdata.com/_api/company/v1/publications
179
187
180
188
The company is referenced using one or more of the following parameters. Which combinations to use depends on your use case and will be explained further below.
181
189
@@ -280,9 +288,9 @@ All of the requests that return information for one or multiple companies:
280
288
281
289
Request | URL
282
290
------- | ---------
283
-
retrieve company | https://www.northdata.de/_api/company/v1/company
284
-
power search | https://www.northdata.de/_api/search/v1/power
@@ -362,8 +370,8 @@ The following request is available to query a single person:
362
370
363
371
Request | URL
364
372
------- | ---------
365
-
retrieve person | https://www.northdata.de/_api/person/v1/person
366
-
retrieve publications associated with a person | https://www.northdata.de/_api/person/v1/publications
373
+
retrieve person | https://www.northdata.com/_api/person/v1/person
374
+
retrieve publications associated with a person | https://www.northdata.com/_api/person/v1/publications
367
375
368
376
The person is referenced using one or more of the following parameters (which combinations to use depends on your use case and will be explained below).
*Power search* is the most flexible search method. It allows you to specify many different criteria, such as regional, financial, and more.
431
439
@@ -447,17 +455,22 @@ Repeat this as long as the field `nextPos` is not empty.
447
455
448
456
*Power search* allows you to search companies matching many different criteria.
449
457
458
+
All lists are pipe-separated (i.e., with the '|' character).
459
+
450
460
Parameter name | Type | Explanation
451
461
---------------|------|------------
452
-
`name` | string | company name or empty
453
-
`description` | string | wz code or keywords to match in the company subject
462
+
`keywords` | string | keywords to match in the company name, subject or segment
454
463
`address` | string | address (any level of precision, from house to country)
455
464
`maxDistanceKm` | number | maximum distance from given address
456
465
`status` | string array | list of valid statuses (active, terminated, liquidation)
457
466
`countries` | string array | list of countries to include (two letter ISO codes)
458
-
`financialId` | string array | list of financial ids for financial filtering
459
-
`lowerBound` | number array | list of lower bounds for financial filterings
460
-
`upperBound` | number array | list of upper bounds for financial filterings
467
+
`segmentCodes` | string array | list of segment codes to match
468
+
`segmentCodeStandard` | string | the segment code standard to use
469
+
`indicatorId` | string array | list of indicator ids for performance filtering (see [Performance indicators reference](https://www.northdata.com/_financials))
470
+
`lowerBound` | number array | list of lower bounds for performance filterings
471
+
`upperBound` | number array | list of upper bounds for performance filterings
472
+
`lowerBoundUnit` | string array | list of lower bound units (by default, this is 'EUR')
473
+
`upperBoundUnit` | string array | list of upper bound units (by default, this is 'EUR')
461
474
`eventType` | string array | list of event types for event filtering (see [Appendix C](#appendix-c-company-lifecycle-and-event-types))
462
475
`minDate` | date array | list of minimum dates for event filtering
463
476
`maxDate` | date array | list of maximum dates for event filtering
@@ -470,31 +483,43 @@ by every new request.
470
483
471
484
Please note that all the [parameters for accessing company detail information](#accessing-company-detail-information) may be used.
472
485
473
-
#### The `description` parameter
486
+
#### The `keywords` parameter
487
+
488
+
The keywords parameter may include or one or more keywords to match in the company name, segment or subject.
489
+
490
+
```
491
+
keywords=restaurant cafe lunch
492
+
```
493
+
494
+
#### Filtering by segment codes
474
495
475
-
The description parameter may be a partial or full industry code (see above) or one or more keywords to match in the company subject.
496
+
This example shows how to do segment filtering.
476
497
477
498
```
478
-
description=62.03.0
479
-
description=62.03
480
-
description=Immobilien
499
+
segmentCodeStandard=WZ
500
+
segmentCodes=01.11|01.12
481
501
```
482
502
483
-
#### Filtering by financials
503
+
TBD.: reference list of segment code standards.
504
+
505
+
#### Filtering by financials and other performance indicators
484
506
485
507
Multiple ranges may be specified. For example, to filter for companies that had earnings in the range of €1 - €2M and 50 - 100 employees, use the following parameters:
486
508
487
509
```
488
-
financialId=Earnings|Employees
510
+
indicatorId=Earnings|Employees
489
511
lowerBound=1000000|50
490
512
upperBound=2000000|100
491
513
```
492
-
A list of financials is provided [here](https://www.northdata.de/_financials).
514
+
A reference list of performance indicators is provided [here](https://www.northdata.com/_financials).
493
515
For open (unlimited) ranges just omit the number.
494
-
The last known financials are used for filtering.
516
+
For the filtering, the company's last known performance indicators are used for filtering. For financial indicators this is
517
+
usually the year of the last yearly report, for marketing & tech filters simply the last year.
495
518
496
519
The search results will match all filters (although some programming languages use the '|' character for *"or"* operations, here it is a simple separator and the the filters have *"and"* semantics.)
497
520
521
+
Foreign currencies will automatically be converted to EUR.
522
+
498
523
#### Filtering by events
499
524
500
525
The power search allows to filter result for companies where particular events happened in a particular date period.
This method provides all publications of a particular day and source. We recommend to run a job every day in the early morning to fetch the publications of the previous day. Each publication represents one or multiple events that may result in changes of company data. The response of the API request provides an array of publications. For each publication there is a field publisher, which contains the updated company data.
578
603
579
604
You need to decided which publication sources are relevant to you, i.e., which sources trigger updates that are important for you to receive.
580
605
For a list of possible sources see [Appendix D](#appendix-d-publication-sources). For example, for German companies, you would select the most important sources `Hrb`, `Eb` and `Ins`, which would result in three update routines:
In addition, you may want to set the parameters `publisherFinancials`, `publisherSheets`, `publisherRelations`, `publisherHistory`, and/or `publisherEvents` to true in order to retrieve company detail information.
0 commit comments