North Data Search
Search North Data companies and people by name. Returns suggestion cards and pagination (1 credit).
Credit cost: 1 credit per call
ApiKeyAuthx-api-key<token>Your API key. Include it in the x-api-key header for every request.
query*stringCompany or person name, or a North Data suggest URL.
Example (keyword):
BMWExample (suggest URL):
https://www.northdata.fr/suggest.json?query=BMW&countries=FRNotes:
- A profile URL returns 400. Use the company endpoint.
domaindefaults tofr.countriesis optional (FRorFR,DE).- Only page 1 exists.
countries?stringISO alpha-2 codes, separated by comma, pipe or space (FR or FR,DE). Empty searches every country. A URL that already has countries wins.
domain?stringHost of a name: fr (default), com or en, de. Ignored when query is a URL.
"fr"page?numberOnly 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows.
fields?stringComma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).
is_async?booleanRun the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
falseSuccessful response
application/json- response
results?array<>pagination?curl -X GET 'https://api.piloterr.com/v2/northdata/search?query=string'{ "results": [ { "url": "https://www.northdata.fr/Maison%20Boinaud%20SAS,%20Angeac-Champagne/Siren%20907120216", "name": "Maison Boinaud SAS", "type": "company", "location": "Angeac-Champagne", "position": 1 } ], "pagination": { "next": null, "page": 1, "per_page": 15, "total_pages": null, "total_results": null }}