Naar hoofdinhoud gaan
GET
Ondernemingen screenen

Autorisaties

Authorization
string
header
vereist

Een otb_live_-token, aangemaakt in het OTB Studio-dashboard.

Queryparameters

nace
string[]

Een NACE-BEL-code of -prefix, zoals 56.1. Herhaal voor meer. Een prefix van 4 cijfers of minder geldt voor de versie 2008 en 2025.

activity
enum<string>

main (standaard) of any, dat de neven- en hulpactiviteiten toevoegt.

Beschikbare opties:
main,
any
area
string[]

Een gemeente, deelgemeente, arrondissement, provincie, gewest, postcode of gebiedscode. Herhaal voor meer.

Een KBO-code voor de rechtsvorm, zoals 014. Herhaal voor meer.

situation
string[]

Een categorie van de juridische toestand: normal, insolvency, dissolution, merger_or_split of ended. Herhaal voor meer.

founded_after
string<date>

Opgericht op of na deze datum.

founded_before
string<date>

Opgericht op of voor deze datum.

include_inactive
boolean
standaard:false

true toont ook de geschrapte ondernemingen.

sort_by
string
standaard:name

name (de standaard), oldest, newest, of een cijfer uit GET /v1/figures, zoals employees, analysis.solvency of growth3y.turnover. Bedrijven zonder waarde voor het cijfer komen laatst.

sort_order
enum<string>
standaard:desc

Voor een cijfer: desc (de standaard) of asc.

Beschikbare opties:
desc,
asc
min
object

Houd de bedrijven waarvan de nieuwste neerlegging het cijfer minstens deze waarde geeft, zoals min[equity]=1000000. Een bedrijf zonder waarde valt weg. Een verhouding is een breuk: min[analysis.solvency]=0.5 is 50%.

max
object

Houd de bedrijven waarvan de nieuwste neerlegging het cijfer hoogstens deze waarde geeft, zoals max[analysis.customerCreditDays]=30.

include
string[]

Een cijfer dat elk resultaat ook toont, zoals turnover. Herhaal voor meer. Elke waarde kost een credit, en een resultaat van een screening die een cijfer gebruikt 2 meer.

limit
integer
standaard:20

Hoeveel ondernemingen terug te geven, 1 tot 50. Een ontbrekende, nul- of negatieve waarde geeft 20, een grotere 50.

offset
integer
standaard:0

Waar de pagina begint. Neem het uit nextOffset.

also_requested
string[]

Een deel van de vraag dat geen filter dekt, zoals has a terrace. Het komt terug in unsupported. Herhaal voor meer.

Respons

De ondernemingen die voldoen, en wat de screening met de vraag deed.

De ondernemingen die voldoen, en wat de screening met de vraag deed.

matched
integer
vereist

Elke onderneming die door de filters komt, niet alleen deze pagina.

returned
integer
vereist
hasMore
boolean
vereist
sortedBy
string
vereist

name, oldest, newest, of een cijfer en zijn volgorde, zoals employees desc.

bySituation
object[]
vereist

De gevonden ondernemingen per categorie van juridische toestand, zodat een lijst met faillissementen dat zegt.

unsupported
object[]
vereist

Elk deel van de vraag dat de screening niet toepaste, met de reden.

results
object[]
vereist
nextOffset
integer

De offset van de volgende pagina, als die er is.

bounds
object

De min en max die de screening toepaste, per cijfer, zoals {"employees": {"min": 10}}. Elke grens kost 5 credits: matched beantwoordt ze.

resolvedArea
object

Elk gebied opgezocht, en de postcodes van allemaal.

nace
object[]