Skip to main content
GET
Screen companies

Authorizations

Authorization
string
header
required

An otb_live_ token, minted in the OTB Studio dashboard.

Query Parameters

nace
string[]

A NACE-BEL code or prefix, such as 56.1. Repeat for more. A prefix of 4 digits or less matches the 2008 and the 2025 version.

activity
enum<string>

main (the default) or any, which adds the secondary and ancillary activities.

Available options:
main,
any
area
string[]

A municipality, sub-municipality, arrondissement, province, region, zip code or area code. Repeat for more.

A KBO legal form code, such as 014. Repeat for more.

situation
string[]

A juridical situation category: normal, insolvency, dissolution, merger_or_split or ended. Repeat for more.

founded_after
string<date>

Founded on or after this date.

founded_before
string<date>

Founded on or before this date.

include_inactive
boolean
default:false

true also lists companies that are struck off.

sort_by
string
default:name

name (the default), oldest, newest, or a figure from GET /v1/figures, such as employees, analysis.solvency or growth3y.turnover. Companies with no value for the figure come last.

sort_order
enum<string>
default:desc

For a figure: desc (the default) or asc.

Available options:
desc,
asc
min
object

Keep the companies whose newest filing has the figure at least this value, such as min[equity]=1000000. A company with no value does not pass. A ratio is a fraction: min[analysis.solvency]=0.5 is 50%.

max
object

Keep the companies whose newest filing has the figure at most this value, such as max[analysis.customerCreditDays]=30.

include
string[]

A figure each result also shows, such as turnover. Repeat for more. Each value costs a credit, and a result of a screen that uses a figure 2 more.

limit
integer
default:20

How many companies to return, 1 to 50. A missing, zero or negative value gives 20, a larger one 50.

offset
integer
default:0

Where the page starts. Take it from nextOffset.

also_requested
string[]

A part of the request no filter covers, such as has a terrace. It comes back in unsupported. Repeat for more.

Response

The companies that matched, and what the screen did with the request.

The companies that matched, and what the screen did with the request.

matched
integer
required

Every company that passed the filters, not only this page.

returned
integer
required
hasMore
boolean
required
sortedBy
string
required

name, oldest, newest, or a figure and its order, such as employees desc.

bySituation
object[]
required

The matched companies per juridical situation category, so a list that includes bankruptcies says so.

unsupported
object[]
required

Every part of the request the screen did not apply, with the reason.

results
object[]
required
nextOffset
integer

The offset of the next page, when there is one.

bounds
object

The min and max the screen applied, by figure, such as {"employees": {"min": 10}}. Each one costs 5 credits: matched answers it.

resolvedArea
object

Every area item resolved, and the zip codes of all of them.

nace
object[]