Home / FAQ / API. How to access keep.eu data in Open Data format, through an API (Application Programme Interface)?

API. How to access keep.eu data in Open Data format, through an API (Application Programme Interface)?

Open Data API – Users’ instructions

About this service

Keep.eu’s API web service allows access to data from keep.eu in an Open Data standard way.
This API enables users to easily retrieve information about programmes, projects, and partnerships.
Below are detailed instructions on how to use this API effectively.

Obtaining an API Key

To access the keep.eu open data services, the user must first obtain an API key. This key is essential for authentication and ensuring secure access to the data.
The following steps should be used to retrieve an API key:

  1. Register to keep.eu: Only registered users can access to the service. Registration can be done at https://keep.eu/register/ or if you have registered to Interact collaboration platform already, you need to log in with the same credentials at https://keep.eu/login/.
  2. Request an API Key: Contact the keep.eu team by email keep.support@interact.eu to request an API key.
  3. Keep.eu team will evaluate the need for an API access and creates the API Key: Once your request is received, the keep.eu team will generate a unique API key for you.
  4. Receive the API Key via email: After the API key is created, you will receive an email from the keep.eu team containing your new API key. 
  5. Store your API Key Securely: Keep your API key secure and do not share it with others. This key is unique to you and provides access to the open data. It is the responsibility of the API key owner to keep the key safe.

Accessing the API

To access the open data, you need an API key. You can use the following URL to retrieve data: https://keep.eu/api/open-data?key=YOUR_API_KEY  Replace YOUR_API_KEY with your actual API key.

Accessing Specific Programme Data

If you want to access data related to a specific programme or multiple programmes, you need to include the programme ID(s) in your request using the following URL format:

Replace PROGRAMME_ID, PROGRAMME_ID_1, PROGRAMME_ID_2, and PROGRAMME_ID_3 with the actual programme ID(s) you are interested in. Programme IDs can be found at https://keep.eu/programmes/ by entering to the programme pages and checking the ID from the URL.

Accessing Specific Programme Period

If you want to access data related to a specific programming period, you need to include the programming period in your request. Use the following URL format: https://keep.eu/api/open-data?key=YOUR_API_KEY&period=PERIOD
also combined with the programme ids filter https://keep.eu/api/open-data?key=YOUR_API_KEY&ids=PROG_ID_1,PROG_ID2&period=PERIOD.
The actual values for PERIOD are:

  • 2000-2006
  • 2007-2013
  • 2014-2020
  • 2021-2027

Understanding the Data Structure

The API grants access to the comprehensive data of keep.eu, organized in a hierarchical manner. The structure consists of three main levels:

  1. Programmes
  2. Projects
  3. Partnerships

Each level in the hierarchy is interconnected as follows:

  • Programmes: This is the top level of the hierarchy. Each programme encompasses multiple projects.
  • Projects: Under each programme, there are various projects. Projects represent specific initiatives or activities that fall under the broader objectives of a programme.
  • Partnerships: Each project involves several partnerships. Partnerships refer to the collaborative efforts between different entities working together to achieve the project’s goals.  

To understand the structure of the data provided, you can refer to the following tables present in the file that you can download from here:

  • Programmes: This table outlines the structure of programme-related data.
  • Projects: This table details the structure of project-related data.
  • Partnerships: This table describes the structure of partnership-related data.

Example Requests

Terms of use of the keep.eu API

Access to the keep.eu API will be evaluated by Interact case by case. In general Interact will grant access to the API to anyone who is considered to benefit of it. However Interact reserves the right not to grant access, or remove existing access, in case of any misuse of the data or other reasons decided by Interact.

When using the API data, users must give appropriate credit to keep.eu, provide a link to keep.eu and indicate if changes were made, further to any other reference that is required and indicated in the materials themselves.

Interact makes every effort to ensure that the information available in the API is accurate. However, Interact cannot accept any liability for the accuracy or content. If errors are brought to our attention, we will try to correct them without delay.

Keep.eu’s general terms of use apply also to the keep.eu API.