brainrex

Brainrex - JavaScript client for brainrex
Provides anomaly detection and natural language processing technlogies to blockchain developers.
This SDK is automatically generated by the Swagger Codegen project:

- API version: 1.0.1
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

$3

#### npm

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

Then install it via:

``shell
npm install brainrex --save
`

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

`shell
npm install
`

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

`shell
npm link
`

Finally, switch to the directory you want to use your brainrex from, and run:

`shell
npm link /path/to/
`

You should now be able to require('brainrex') in javascript files from the directory you ran the last
command above from.

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

`shell
npm install YOUR_USERNAME/brainrex --save
`

$3

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, that's to say your javascript file where you actually
use this library):

`shell
browserify main.js > bundle.js
`

Then include bundle.js in the HTML pages.

$3

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:

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

Getting Started

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

`javascript
var Brainrex = require('brainrex');

var defaultClient = Brainrex.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 Brainrex.AnomalyApi()

var opts = {
'request': new Brainrex.TimeSeries() // {TimeSeries} 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.bitlongs.com

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
Brainrex.AnomalyApi | anomalyBatch | POST /anomaly/json/detect | Detects anomalies in historical data in batches. This endpoint uses your entire dataset as input
Brainrex.IntegrationsApi | cryptoGetCandleData | POST /crypto/get_candles | Downloads candle format market data
Brainrex.IntegrationsApi | cryptoGetExchangeAssets | POST /crypto/get_exchange_assets | Gets all currency pairs traded in selected exchange
Brainrex.IntegrationsApi | cryptoGetOrderbooks | POST /crypto/get_orderbooks | Downloads candle format market data
Brainrex.IntegrationsApi | cryptoGetSupportedExchanges | GET /crypto/get_supported_exchanges | Gets all cryptocurrency exchanges supported by the Brainrex API
Brainrex.IntegrationsApi | cryptoGetTicker | POST /crypto/get_ticker | Downloads candle format market data
Brainrex.LanguageApi | languageGetCryptoEntities | POST /entity/get_crypto_entities | Named Entity Recognition software capable of understanding cryptocurrency and blockchain speficic language.
Brainrex.LanguageApi | languageGetGeneralSentiment | POST /sentiment/get_general_sentiment | This endpoints returns a score from -1 to +1 where depending on negative or positive attitude in the text.
Brainrex.LanguageApi | languageGetPriceSentiment | POST /language/get_price_sentiment | Sentiment analysis score using a model trained for buy signals.

Documentation for Models

- Brainrex.CandleRequest
- Brainrex.CandleResponse
- Brainrex.Error
- Brainrex.Exchange
- Brainrex.ExchangeAssetsResponse
- Brainrex.ExchangeAssetsResponseInner
- Brainrex.OHCLV
- Brainrex.OrderbookRequest
- Brainrex.OrderbookResponse
- Brainrex.PointTimeSeries
- Brainrex.SeriesResponse
- Brainrex.SeriesResponsePoint
- Brainrex.SupportedExchanges
- Brainrex.Text
- Brainrex.TickerResponse
- Brainrex.TickerResponseInner
- Brainrex.TimeSeries

Documentation for Authorization

$3

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