@predictionvc/prediction-api/README.md

Prediction Enterprise API sdk in Javascript

# Prediction API

We are proud to introduce our 1.0.0 version of Prediction Enterprise API.  It is our first step to sharing our data with the world and being more transparent about our predictions, their accuracy and our fund trades and performance.  In the case you are missing some data please drop us a line at enterprise@prediction.vc. We will be happy to answer your questions and implement new features for you.  [Platform FAQ](https://predictionvc.freshdesk.com/support/solutions/)

Check out the docs at https://enterprise.prediction.vc/docs

- API version: 1.0.0
- Package version: 1.0.0

## Installation

```shell
npm i @predictionvc/prediction-api
```

## Getting Started

### Authorization

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

### Code sample

```javascript
const PredictionApi = require('prediction_enterprise_api')

const defaultClient = PredictionApi.ApiClient.instance

// Configure API key authorization: Authorization
const Authorization = defaultClient.authentications['Authorization']
Authorization.apiKey = "YOUR API KEY"

const api = new PredictionApi.FundApi()

const opts = {
  'entry': '2018-09-01', // {Date} entry date for trades
  'exit': '2018-09-01', // {Date} exit date for trades
  'direction': 'short' // {String} short/long
}
api.fundTradesGet(opts)
  .then(data => {
    console.log('API called successfully. Returned data: ')
    console.log(data)
  })
  .catch(error => {
    console.error(error)
  })


```

## Documentation for API Endpoints

All URIs are relative to *https://enterprise.prediction.vc/api/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PredictionApi.FundApi* | [**fundTradesGet**](docs/FundApi.md#fundTradesGet) | **GET** /funds/trades | Prediction Fund trade data
*PredictionApi.FundApi* | [**fundsTradesPairsGet**](docs/FundApi.md#fundTradesTokensGet) | **GET** /funds/trades/tokens | Traded tokens
*PredictionApi.HistoricalApi* | [**historicalGet**](docs/HistoricalApi.md#historicalGet) | **GET** /historical | Historical Data
*PredictionApi.OHLCApi* | [**ohlcGet**](docs/OHLCApi.md#ohlcGet) | **GET** /ohlc | OHLC Data
*PredictionApi.PredictionsApi* | [**predictionsAccuracyGet**](docs/PredictionsApi.md#predictionsAccuracyGet) | **GET** /predictions/accuracy | Accuracy
*PredictionApi.PredictionsApi* | [**predictionsGet**](docs/PredictionsApi.md#predictionsGet) | **GET** /predictions | Predictions
*PredictionApi.PredictionsApi* | [**predictionsTokensGet**](docs/PredictionsApi.md#predictionsTokensGet) | **GET** /predictions/tokens | Tokens