Nuanced Pterodactyl Monk

    entsoe-api

    0.0.3 • Public • Published

    ENTSOe-API for Node JS

    Installation

      npm install entsoe-api --save
    

    Usage

    Basic

        require("entsoe-api");
        var entsoeApi = new ENTSOEapi("YOUR-WEB-API-KEY");
            
        // Optional: Set some basic TimeInterval as most queries need that...
        var periodstart=new Date();
        periodstart.setDate(periodstart.getDate()-4); // 4 Days back
        var periodend=new Date();
     
        // Optional: Set some defaults for your query
        var defaults= {
                outBiddingZone_Domain:'10YCZ-CEPS-----N',
                biddingZone_Domain:'10Y1001A1001A63L',
                in_Domain:'10YCZ-CEPS-----N',
                out_Domain:'10YSK-SEPS-----K',
                periodStart:ENTSOEapi.buildPeriod(periodstart),
                periodEnd:ENTSOEapi.buildPeriod(periodend),
        }
        
        var query = new ENTSOEapi.query(defaults);
        
        
        // Query for Actual Generation
        entsoeApi.getData(query.actualGenerationPerType(),function(data) {
            var ret=ENTSOEapi.parseData(data);
            console.log(JSON.parse(ret));
        });
            

    The query functions are pure helpers and you might overwrite all parameters:

        var query = new ENTSOEapi.query(defaults);
        var options=query.actualGenerationPerType();
        options.in_Domain='10YCZ-CEPS-----N';

    Available Queries

    physicalFlows
    installedGenerationCapacity
    dayAheadGeneration
    actualGeneration
    actualGenerationPerType
    installedGenerationCapacityPerUnit
    actualTotalLoad
    dayAheadTotalLoadForecast
    weekAheadTotalLoadForecast
    monthAheadTotalLoadForecast
    yearAheadTotalLoadForecast
    yearAheadForecastMargin
    ExpansionAndDismantlingProjects
    Redispatch
    Countertrading
    CongestionCosts
    PlannedUnavailabilityOfConsumptionUnits
    ForcedUnavailabilityOfConsumptionUnits
    PlannedUnavailabilityOfGenerationUnits
    ForcedUnavailabilityOfGenerationUnits
    PlannedUnavailabilityOfProductionUnits
    ForcedUnavailabilityOfProductionUnits
    PlannedUnavailabilityOfTransmissionUnits
    ForcedUnavailabilityOfTransmissionUnits
    PlannedUnavailabilityOfOffshore
    dayAheadGenerationForecastWindAndSolar

    If you like to add a query type - do not hesitate to send a pull request... it is easy :)

    Useful Links

    See full API spec at ENTSOe: https://transparency.entsoe.eu/content/static_content/Static content/web api/Guide.html

    ACER List of standard contract: https://www.acer-remit.eu/portal/document-download?documentId=z235pl461qr

    Contributing

    https://blog.stromhaltig.de/

    Release History

    • 0.0.1 Initial release
    • 0.0.2 Update for STROMDAO / Stromhaltig Tarif usage

    Install

    npm i entsoe-api

    DownloadsWeekly Downloads

    4

    Version

    0.0.3

    License

    ISC

    Last publish

    Collaborators

    • zoernert