Skip to main content
Deno 2 is finally here 🎉️
Learn more

entsoe-api-client

ENTSO-e transparency platform API Client. Complete. Easy to use. Minimal.

Deno CI MIT License

  • Works in Deno >=1.16
  • Works in Node >=14
  • Native TypeScript typings
  • Support most aspects of Entso-e transparency platform REST API
  • Unzips and parses zip-file endpoints (e.g. outage documents) transparently
  • ESM (Deno, Node) and CommonJS (Node) support
  • Includes examples for getting Outages, Spot-prices, actual generation and generation forecast

Documentation

Full documentation is available at https://deno.land/x/entsoe_api_client/mod.ts

Note These are the document types currently supported (should be all):

  • Publication_MarketDocument
  • GL_MarketDocument
  • Unavailability_MarketDocument
  • Configuration_MarketDocument
  • Balancing_MarketDocument
  • CriticalNetworkElement_MarketDocument
  • TransmissinNetwork_MarketDocument

Installation

Deno

import { QueryConfiguration } from "https://deno.land/x/entsoe_api_client/mod.ts";

Node

npm install entsoe-api-client --save

Examples

Examples can be found in the /examples directory.

Pass your ENTSO-e API key by environment variable API_TOKEN when running the examples.

Deno

Powershell

$env:API_TOKEN="your-api-token"; deno run -A .\spot-prices-today.ts

Bash

API_TOKEN="your-api-token" deno run -A .\spot-prices-today.ts

Node

Powershell

$env:API_TOKEN="your-api-token"; node .\spot-prices-today.ts

Bash

API_TOKEN="your-api-token" node .\spot-prices-today.ts

Contributing

All contributions are welcome.

Module developed for Deno. Node module is generated by dnt, using scripts/build_npm.ts.

See Contribution Guide

Note Please run deno task precommit before each commit, to make sure every file is tested/formatted/linted to standards.

License

MIT