Skip to content

Add a note not to use keywords search with relations=true #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spinetrak merged 2 commits into from
Sep 22, 2025
Merged

Add a note not to use keywords search with relations=true #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f41e1b
Add a note not to use keywords search with relations=true
spinetrak Sep 22, 2025
bcbcd0c
Updated documentation regarding large search results in combination w…
spinetrak Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/data-api-userguide/data-api-userguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,8 @@ Parameter name | Type | Explanation

If `history` is set to true, the `name`, `address` and `register` history is added to the API response. If `history` is set to true in combination with `financials`, then the known financial history is added to the response. If `history` is set to true in combination with `relations`, then also formerly related companies and persons are included.

**Note**: Your search might return a large result set. In that case, please DO NOT use `relations=true`, as this may quickly lead to loading of hundreds of thousands of companies.

### Events

Events of a company are changes in the company lifecycle, changes of base data such as name, address, legal form or base capital, or changes in management. For a complete list, see [Appendix G](#appendix-g-event-types).
Expand Down Expand Up @@ -531,6 +533,9 @@ The keywords parameter may include or one or more keywords to match in the compa
```
keywords=restaurant cafe lunch
```

**Note**: Your search by `keywords` might return a large result set. Please DO NOT combine it with `relations=true`, as this may quickly lead to loading of hundreds of thousands of companies.

Please also see our help center article: [Combining Keywords in the Power Search](https://help.northdata.com/en/center/keywords)

#### Filtering by segment codes
Expand Down