APIs

Fingrid's open data platform provides machine readable access to datasets through open REST API interface. On this page you will find information about the registration and instructions for using the API. 

Registration

Fingrid wants to provide equal service for all users of the open data platform, and wants to develop the service according to the user feedback. Therefore, the API-access requires registration and the use of an API-key.

  • API-key will be sent to you when you register and approve the license and terms of use
  • You can use the API free of charge and you only need an valid email address for the registration. Your personal API-key will be sent to you right away: if you don't receive the email, please check your junk mail folder.
  • Registered users may opt-in to receive email notifications about maintenance breaks or other important changes that affect the use of the API.
  • If you want, you can also delete your account and the related API-key.

How to use the API

Technical API documentation for developers can be found at http://data.fingrid.fi/open-data-api/

  • API responds to requests at https://api.fingrid.fi/
  • For an individual variable you can get the latest event, or events from a specified date/time range. For a set of variables you can get the latest events. In addition to JSON-format you can use XML or CSV-formats.
  • You can make custom searches for each dataset. Each dataset has an unique link to the search interface. 
  • Datasets are identified by an unique VariableId number that you need to use in API requests. You will find the variable id number from the dataset resource description. 
  • When you register, you'll receive an email with your personal API-key. API-key must be inserted to the http-request header x-api-key, not into the URL-address. If you are importing data from the API into an application, it is usually possible to insert the API-key by modifying the request header parameters in your application: further instructions for doing this are usually available in the documentation of your chosen software.
  • Service has throttling that is based on API-keys: you can make 10 000 requests in 24h period with one API-key. Please contact the administrator if you need to make more requests.
  • Data timestamps are presented in UTC (prev. GMT) time format. Correct format for API requests is YYYY-MM-ddTHH:mm:ssZ
  • Data update frequency varies by dataset: many datasets have data that is updated hourly, and some datasets include data that is updated in 3 or 5 minute intervals. The update frequency is stated in the dataset description.
  • If you request frequently updated data from an extended date range, you may receive an error message that results from exceeding the maximum allowed API payload. Shorten the date range and request the results in JSON-format. 
  • If you use the API in browser environment, you need to note the requirements and limitations for Cross Origin Resource Sharing (CORS)

Availability and uptime

The open data API is not guaranteed to have 100% uptime. Although maximum uptime is a goal, as with any service disruptions can happen at any point along the networks and Internet between the client application and the API servers. When you register for using the API, we recommend that you opt-in to the email notifications so that we can inform you about changes that affect the use of the API. You can also get information about planned maintenance breaks from the API. It's important that your application is defensive and can handle API downtime gracefully. One such way could be by implementing good caching. Another strategy could be to aim for graceful failure if the API is not available.