codabl v0.1.0

codabl

Codabl - JavaScript client for codabl The Codabl 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.

• API version: 0.1.0
• Package version: 0.1.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

Then install it via:

npm install codabl --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:

npm install

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

npm link

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

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('codabl') 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/codabl then install it via:

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

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 Codabl = require('codabl');

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

var opts = { 
  'request': new Codabl.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

Documentation for Models

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

Documentation for Authorization

APIKeyHeader

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