DataverseNO API¶

The DataverseNO application programming interface (API) allows you to interact programmatically with the DataverseNO repository, for example to search for datasets, retrieve metadata, download files, and perform permitted deposit and dataset-management operations.

The DataverseNO API follows the API of the open-source Dataverse software that powers the DataverseNO repository. The base URL for DataverseNO API requests is:

https://dataverse.no/api/

Dataverse exposes much of the functionality available through the DataverseNO graphical user interface through REST-based APIs.

DataverseNO API token¶

Some DataverseNO API operations involving public content do not require authentication. Operations performed through your DataverseNO user account generally require an API token.

Create or retrieve your DataverseNO API token¶

1. Sign in to DataverseNO.
2. Select your account name in the upper-right corner.
3. Select API Token.
4. Create a token or view your existing token.

Your DataverseNO API token is associated with your DataverseNO user account and allows API requests to be performed with your permissions. Treat it like a password: do not share it or include it in scripts, repositories, log files, or other locations where it may be exposed. Once you have completed your tasks using the API, revoke the API token to prevent it from being used again.

When a DataverseNO API endpoint requires authentication, pass the token in the X-Dataverse-key HTTP header:

curl -H "X-Dataverse-key: YOUR_API_TOKEN" \
  "https://dataverse.no/api/v1/dataverses/root/contents"

Using the HTTP header is preferable to including the token as a URL parameter because URLs may be stored in browser histories, server logs, and other systems.

DataverseNO permissions¶

DataverseNO API requests are subject to the same permissions as actions performed through the DataverseNO web interface. A DataverseNO API token does not give you additional access. You can only view restricted content or perform operations such as creating, editing, and publishing datasets if your DataverseNO account has the necessary permissions.

DataverseNO API documentation¶

For available DataverseNO API endpoints, request parameters, response formats, and examples, see the official Dataverse API Guide. The documentation covers, among other topics:

• getting started with the DataverseNO API;
• authentication and DataverseNO API tokens;
• searching for collections, datasets, and files in DataverseNO;
• retrieving dataset metadata from DataverseNO;
• downloading files from DataverseNO;
• creating and updating datasets in DataverseNO;
• uploading files to DataverseNO; and
• client libraries for languages such as Python and R.

Use documentation matching the DataverseNO software version¶

The latest version of the Dataverse API Guide may describe features that are not yet available in DataverseNO. Check the Dataverse version displayed in the footer of the DataverseNO repository and, where necessary, replace /latest/ in the documentation URL with that version number.

For example, as of October 2026, DataverseNO runs on Dataverse v6.11, so the corresponding documentation is available at:

https://guides.dataverse.org/en/6.11/api/

The installed Dataverse version is displayed in the footer of the DataverseNO repository landing page.

DataverseNO support¶

Before contacting DataverseNO support, check that:

• the DataverseNO API endpoint and parameters are documented for the Dataverse version used by DataverseNO;
• your DataverseNO account has the permissions required for the requested operation;
• your DataverseNO API token is valid and is being passed correctly; and
• your DataverseNO API request body uses the expected syntax and data structure.

If the problem appears to be specific to DataverseNO, contact the DataverseNO repository management at support@dataverse.no.