Piloterr

North Data Search

GET
/v2/northdata/search

Search North Data companies and people by name. Returns suggestion cards and pagination (1 credit).

Credit cost: 1 credit per call

Authentification

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Paramètres de requête

query*string

Company or person name, or a North Data suggest URL.

Example (keyword):

BMW

Example (suggest URL):

https://www.northdata.fr/suggest.json?query=BMW&countries=FR

Notes:

  • A profile URL returns 400. Use the company endpoint.
  • domain defaults to fr. countries is optional (FR or FR,DE).
  • Only page 1 exists.
countries?string

ISO 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?string

Host of a name: fr (default), com or en, de. Ignored when query is a URL.

Default"fr"
page?number

Only 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows.

fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Corps de la réponse

Successful response

application/json
  1. response
results?array<>
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/northdata/search?query=string'
Example Response
{  "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  }}