Passer au contenu principal
GET
Filtrer les entreprises

Autorisations

Authorization
string
header
requis

Un jeton otb_live_, créé dans le tableau de bord OTB Studio.

Paramètres de requête

nace
string[]

Un code ou préfixe NACE-BEL, comme 56.1. Répétez pour en donner plusieurs. Un préfixe de 4 chiffres ou moins vaut pour la version 2008 et 2025.

activity
enum<string>

main (par défaut) ou any, qui ajoute les activités secondaires et auxiliaires.

Options disponibles:
main,
any
area
string[]

Une commune, section, arrondissement, province, région, code postal ou code de zone. Répétez pour en donner plusieurs.

Un code BCE de forme juridique, comme 014. Répétez pour en donner plusieurs.

situation
string[]

Une catégorie de situation juridique : normal, insolvency, dissolution, merger_or_split ou ended. Répétez pour en donner plusieurs.

founded_after
string<date>

Fondée à cette date ou après.

founded_before
string<date>

Fondée à cette date ou avant.

include_inactive
boolean
défaut:false

true liste aussi les entreprises radiées.

sort_by
string
défaut:name

name (par défaut), oldest, newest, ou un chiffre de GET /v1/figures, comme employees, analysis.solvency ou growth3y.turnover. Les entreprises sans valeur pour ce chiffre viennent en dernier.

sort_order
enum<string>
défaut:desc

Pour un chiffre : desc (par défaut) ou asc.

Options disponibles:
desc,
asc
min
object

Garde les entreprises dont le dépôt le plus récent donne au moins cette valeur pour le chiffre, comme min[equity]=1000000. Une entreprise sans valeur ne passe pas. Un ratio est une fraction : min[analysis.solvency]=0.5 vaut 50 %.

max
object

Garde les entreprises dont le dépôt le plus récent donne au plus cette valeur pour le chiffre, comme max[analysis.customerCreditDays]=30.

include
string[]

Un chiffre que chaque résultat montre aussi, comme turnover. Répétez pour plus. Chaque valeur coûte un crédit, et un résultat d'un filtrage qui utilise un chiffre 2 de plus.

limit
integer
défaut:20

Combien d'entreprises renvoyer, de 1 à 50. Une valeur absente, nulle ou négative donne 20, une plus grande 50.

offset
integer
défaut:0

Où la page commence. Prenez-le dans nextOffset.

also_requested
string[]

Une partie de la demande qu'aucun filtre ne couvre, comme has a terrace. Elle revient dans unsupported. Répétez pour en donner plusieurs.

Réponse

Les entreprises qui correspondent, et ce que le filtre a fait de la demande.

Les entreprises qui correspondent, et ce que le filtre a fait de la demande.

matched
integer
requis

Toutes les entreprises qui passent les filtres, pas seulement cette page.

returned
integer
requis
hasMore
boolean
requis
sortedBy
string
requis

name, oldest, newest, ou un chiffre et son ordre, comme employees desc.

bySituation
object[]
requis

Les entreprises trouvées par catégorie de situation juridique, pour qu'une liste avec des faillites le dise.

unsupported
object[]
requis

Chaque partie de la demande que le filtre n'a pas appliquée, avec la raison.

results
object[]
requis
nextOffset
integer

L'offset de la page suivante, s'il y en a une.

bounds
object

Les min et max que le filtrage a appliqués, par chiffre, comme {"employees": {"min": 10}}. Chaque borne coûte 5 crédits : matched y répond.

resolvedArea
object

Chaque zone résolue, et les codes postaux de toutes.

nace
object[]