# EPEX API

[![npm version](https://img.shields.io/npm/v/@north-tec/epex-api.svg?style=flat-square)](https://www.npmjs.org/package/@north-tec/epex-api)
[![npm downloads](https://img.shields.io/npm/dm/@north-tec/epex-api.svg?style=flat-square)](http://npm-stat.com/charts.html?package=@north-tec/epex-api)
[![install size](https://packagephobia.now.sh/badge?p=@north-tec/epex-api)](https://packagephobia.now.sh/result?p=@north-tec/epex-api)
[![pipeline status](https://git.dingx.net/powerpro/repositories/epexspot-interface/badges/master/pipeline.svg)](http://git.dingx.net/powerpro/repositories/epexspot-interface/-/commits/master)
[![coverage report](https://git.dingx.net/powerpro/repositories/epexspot-interface/badges/master/coverage.svg)](http://git.dingx.net/powerpro/repositories/epexspot-interface/-/commits/master)

## Installing

Using npm:

```cmd
$ npm install @north-tec/epex-api
```

## Example

```javascript
const epexApi = require('@north-tec/epex-api').epex;

epexApi.parse('2018-07-01', 'FR').then(auctions => {
    console.log(auctions);
}).catch(err => {
    console.log(err);
});
```

```typescript
import { epex } from '@north-tec/epex-api';

epex.parse('2018-07-01', 'FR').then(auctions => {
    console.log(auctions);
}).catch(err => {
    console.log(err);
});
```

<a name="Epex"></a>

## Epex
<p>Create a new instance of Epex</p>

**Kind**: global class  

* [Epex](#Epex)
    * [.dateFormat](#Epex+dateFormat) : <code>string</code>
    * [.baseUrl](#Epex+baseUrl) : <code>string</code>
    * [.parse(date, country)](#Epex+parse) ⇒ <code>Promise</code>

<a name="Epex+dateFormat"></a>

### epex.dateFormat : <code>string</code>
**Kind**: instance property of [<code>Epex</code>](#Epex)  
<a name="Epex+baseUrl"></a>

### epex.baseUrl : <code>string</code>
**Kind**: instance property of [<code>Epex</code>](#Epex)  
<a name="Epex+parse"></a>

### epex.parse(date, country) ⇒ <code>Promise</code>
<p>Parse the dayahead auctions from epexspot</p>

**Kind**: instance method of [<code>Epex</code>](#Epex)  
**Returns**: <code>Promise</code> - <p>Resolves the auctions as array</p>  
**Fulfil**: <code>Array</code>    -     The auctions as an array  
**Reject**: <code>Error</code>    -     An error  

| Param | Type | Description |
| --- | --- | --- |
| date | <code>String</code> | <p>The date of the auctions in the given dateFormat</p> |
| country | <code>String</code> | <p>The country short</p> |


## Resources

* [Changelog](https://git.dingx.net/powerpro/repositories/epexspot-interface/blob/master/CHANGELOG.md)

## License

MIT