Ga naar hoofdinhoud

Open Source Register

Informatiehuis Internationaal Ondernemen - API specificatie

Rijksdienst voor Ondernemend Nederland

Originele specificatie (YAML)

API documentatie

IIO API (1.2.3)

Download OpenAPI specification:Download

Deze API (Application Programming Interface) van RVO biedt de mogelijkheid om data van het Informatiehuis Internationaal Ondernemen (IIO) op te vragen. Om ervoor te zorgen dat RVO zijn dienstverlening zo goed mogelijk aan kan bieden is de Informatie Internationaal Ondernemen (IIO) API momenteel alleen bruikbaar met behulp van een API-key. RVO gebruikt deze key om inzicht te krijgen in het gebruik van de API. Bijvoorbeeld om te meten welke endpoints en filtermogelijkheden het populairst zijn. We gebruiken de API-key ook om de gebruikers van de API in beeld te krijgen. Zo kunnen wij gebruikers tijdig informeren over incidenten (veroorzaakte piekbelasting, storingen, etc.) en backwards incompatible wijzigingen (versie updates, deprecation periods, etc.).

Een IIO API-key kan verkregen worden door een e-mail te sturen naar informatiehuisIO@rvo.nl. Om onze dienstverlening in de toekomst te kunnen verbeteren en aan te laten sluiten bij onze gebruikers stellen wij het op prijs als je ook laat weten wie je bent en wat je motivatie is om deze API te gebruiken.

De loggings gegevens worden enkel gebruikt voor statische doeleinden, beheer en doorontwikkeling. Loggings gegevens worden niet gepubliceerd als dit herleidbaar kan zijn naar individuele gebruikers.

Een compleet overzicht van alle technische wijzigingen is te vinden in de onderstaande changelog: https://internationaal.ondernemen.overheid.nl/api/iio/v1/changelog.md

content-items

content-items

Endpoint for retrieving a single content item.

Return the image, body, source, country and link of a content item.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

A UUID parameter from a sector, country, content-item etc.

Responses

Response samples

Content type
application/json
{}

Endpoint for retrieving all available content items.

Return the ID's of all content-items together with the title, body, link, image, date and related sectors or countries.

Authorizations:
ApiKeyAuth
query Parameters
sector
string <uuid>
Example: sector=123e4567-e89b-12d3-a456-426614174000

Filter items by one or more sector UUIDs. UUIDs should be comma-separated for multiple sectors.

country
string <uuid>
Example: country=123e4567-e89b-12d3-a456-426614174000

Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.

pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

landen

landen

Endpoint for retrieving all available countries.

Return the ID's of all countries together with the country name, ISO codes, capital and time difference with The Netherlands.

Authorizations:
ApiKeyAuth
query Parameters
code
integer <int32>
Example: code=123

A filter parameter for the country code.

code_iso_alpha_2
string
Example: code_iso_alpha_2=NL

A filter parameter for the ISO Alpha-2 code.

code_iso_alpha_3
string
Example: code_iso_alpha_3=NLD

A filter parameter for the ISO Alpha-3 code.

code_iso_3166_2
string
Example: code_iso_3166_2=ISO 3166-2:NR

A filter parameter for the ISO 3166-2 code.

pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

object

Controls the sorting order of countries based on specified fields. Use field names as keys.

Responses

Response samples

Content type
application/json
{}

Endpoint for retrieving a single country.

Return the links, observations and do's and don'ts of a country. Also including oficial languages, currency, currency code, image file of flag, country name, country code, residence name, capital, time difference with The Netherlands, form of government and business languages.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

A UUID parameter from a sector, country, content-item etc.

Responses

Response samples

Content type
application/json
{}

Endpoint for retrieving the contact details of organizations of a country.

Return the contact details of organizations belonging to a country.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

A UUID parameter from a sector, country, content-item etc.

query Parameters
pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

Endpoint for retrieving the content item details of a country.

Return the content items details belonging to a country.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

A UUID parameter from a sector, country, content-item etc.

query Parameters
pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

Endpoint for retrieving the do's and don'ts of a country.

Return the do's and don'ts of a country.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

A UUID parameter from a sector, country, content-item etc.

query Parameters
pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

Endpoint for retrieving all observations of a country.

Retrieve observations for a specific country using a valid country UUID.

Authorizations:
ApiKeyAuth
path Parameters
uuid
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

A UUID parameter from a sector, country, content-item etc.

query Parameters
type
string
Enum: "bigMacIndex" "economischeGroei" "easeOfDoingBusinessIndex" "uitvoerwaarde" "corruptieIndex" "bbp" "koopkracht" "globalCompetitivenessIndex" "globalInnovationIndex" "invoerWaarde" "inflatie" "logisticPerformanceIndex" "inwoneraantal" "oppervlakte" "werkloosheid"

Specifies the type of observation to filter by.

year
integer <int32>
Example: year=2024

Filter results on a specific year.

jaartal
integer <int32>
Example: jaartal=2024

Filter results on a specific year with a dutch parameter.

pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

evenementen

evenementen

Endpoint for retrieving all available "event" content items.

Return the ID's of all events together with the event title, body, link, image, dates and related sectors or countries.

Authorizations:
ApiKeyAuth
query Parameters
sector
string <uuid>
Example: sector=123e4567-e89b-12d3-a456-426614174000

Filter items by one or more sector UUIDs. UUIDs should be comma-separated for multiple sectors.

country
string <uuid>
Example: country=123e4567-e89b-12d3-a456-426614174000

Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.

pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

financieringen

financieringen

Endpoint for retrieving all available finances and subsidy from the availble countries.

Return the title, body and link of all finances and subsidies together with the related country along with associated country names, links, and IDs. Supports filtering by multiple country IDs using the 'country' query parameter.

Authorizations:
ApiKeyAuth
query Parameters
country
string <uuid>
Example: country=123e4567-e89b-12d3-a456-426614174000

Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.

pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

wet-en-regelgevingen

wet-en-regelgevingen

Endpoint for retrieving all available laws and regulations from the availble countries.

Return the title, body and link of all laws and regulations together with the related country along with associated country names, links, and IDs. Supports filtering by multiple country IDs using the 'country' query parameter.

Authorizations:
ApiKeyAuth
query Parameters
country
string <uuid>
Example: country=123e4567-e89b-12d3-a456-426614174000

Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.

pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}

sectoren

sectoren

Endpoint for retrieving all available sectors.

Return the ID's and names of all sectors together.

Authorizations:
ApiKeyAuth
query Parameters
pageSize
integer
Default: 10
Enum: 10 20 50

Set the amount of items to retrieve per page.

page
integer <int32> >= 1
Default: 1

Set the current page for the items to retrieve.

Responses

Response samples

Content type
application/json
{}