brain_rex_api

BrainRexApi - JavaScript client for brain_rex_api The Brainrex API is a collection of analytics tools and data integrations made for blockchain developers. In particular we offer Natural Language Processing and Anomaly detection algorithms that have been fine tune to understand text data and time series in the domain speficic setting of cryptocurrency and blockchain technology. This technology is intended to be use as building blocks to bigger applications, we offer examples on how to use them for Trading Backtesting and Smart Contract anomaly monitoring. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.2
• Package version: 1.0.2
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install brain_rex_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var BrainRexApi = require('brain_rex_api');
var defaultClient = BrainRexApi.ApiClient.instance;

// Configure API key authorization: APIKeyHeader
var APIKeyHeader = defaultClient.authentications['APIKeyHeader'];
APIKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyHeader.apiKeyPrefix['x-api-key'] = "Token"

var api = new BrainRexApi.AnomalyApi()
var opts = { 
  'body': [new BrainRexApi.PointTimeSeries()] // {[PointTimeSeries]} Time Series to be analyzed, with the following format.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.anomalyBatch(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.brainrex.com

Class	Method	HTTP request	Description
BrainRexApi.AnomalyApi	anomalyBatch	POST /anomaly/json/detect	Detects anomalies in historical data in batches. This endpoint uses your entire dataset as input
BrainRexApi.IntegrationsApi	cryptoGetCandleData	POST /crypto/get_candles	Downloads candle format market data
BrainRexApi.IntegrationsApi	cryptoGetExchangeAssets	POST /crypto/get_exchange_assets	Gets all coin pairs traded in specified exchange
BrainRexApi.IntegrationsApi	cryptoGetOrderbooks	POST /crypto/get_orderbooks	Returns the current state of the orderbook.
BrainRexApi.IntegrationsApi	cryptoGetSupportedExchanges	GET /crypto/get_supported_exchanges	Gets all cryptocurrency exchanges supported by the Brainrex API
BrainRexApi.IntegrationsApi	cryptoGetTicker	POST /crypto/get_ticker	Downloads candle format market data
BrainRexApi.LanguageApi	languageGetCryptoEntities	POST /entity/get_crypto_entities	Extracts known crypto entities like coin names, exchanges, media from text.
BrainRexApi.LanguageApi	languageGetGeneralSentiment	POST /sentiment/get_general_sentiment	Returns a -1 to 1 score, depending on positive/negative sentiment
BrainRexApi.LanguageApi	languageGetPriceSentiment	POST /language/get_price_sentiment	Sentiment analysis score using a model trained for buy signals.

Documentation for Models

• BrainRexApi.CandleRequest
• BrainRexApi.CandleResponse
• BrainRexApi.Error
• BrainRexApi.Exchange
• BrainRexApi.ExchangeAssetsResponse
• BrainRexApi.ExchangeAssetsResponseInner
• BrainRexApi.OHCLV
• BrainRexApi.OrderbookRequest
• BrainRexApi.OrderbookResponse
• BrainRexApi.PointTimeSeries
• BrainRexApi.SupportedExchanges
• BrainRexApi.Text
• BrainRexApi.TickerResponse
• BrainRexApi.TickerResponseInner
• BrainRexApi.TimeSeries

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header