README
brainrex_api
BrainrexApi - JavaScript client for brainrex_api Welcome to the Brainrex API. We offer sentiment analysis, crypto market making, blockchain monitoring and real-tie face-id verification. This AI models can be consumed from this API. You can integrate with your programming language of choice through our Client Libraries .We also offer integrations to open data and propietary data providers. There is a collection of data transformation tools. Join our Telegram group to get the latest news and ask us questions directly (https://t.me/brainrex). More about Brainrex at https://brainrex.com. Full Documentation can be found at https://brainrexapi.github.io/docs This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.1.5
- Package version: 0.1.5
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Fornpm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install brainrex_api --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 brainrex_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('brainrex_api')
in javascript files from the directory you ran the last
command above from.
git
https://github.com/YOUR_USERNAME/brainrex_api then install it via:
If the library is hosted at a git repository, e.g. npm install YOUR_USERNAME/brainrex_api --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 BrainrexApi = require('brainrex_api');
var api = new BrainrexApi.BlockchainApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.blockchainGetEthereumPrice(callback);
Documentation for API Endpoints
All URIs are relative to https://brainrexapi.appspot.com/api
Class | Method | HTTP request | Description |
---|---|---|---|
BrainrexApi.BlockchainApi | blockchainGetEthereumPrice | GET /get_ethereum_price | Lastest price quote for Ether |
BrainrexApi.BlockchainApi | blockchainGetEthereumSupply | GET /get_ethereum_supply | Total Supply of Ether |
BrainrexApi.BlockchainApi | blockchainGetEthereumTx | GET /get_ethereum_tx | Total Supply of Ether |
BrainrexApi.BlockchainApi | blockchainListBlockchains | GET /list_blockchain | The blockchains data structure supported by the Brainrex API |
BrainrexApi.CryptoApi | cryptoDownloadCandles | POST /download_candles | Downloads candle format market data |
BrainrexApi.CryptoApi | cryptoListExchanges | GET /exchanges | The exchanges data structure supported by the Brainrex API |
BrainrexApi.CryptoApi | cryptoListMarkets | GET /markets | The markets data structure supported by the Brainrex Market API |
BrainrexApi.CryptoApi | cryptoTickerDataDownload | POST /download_ticker | Download raw ticker data from major crypto markets |
BrainrexApi.SentimentAnalysisApi | sentimentGetSentimentScore | POST /get_sentiment_score | General Sentiment Analysis scoring |
Documentation for Models
- BrainrexApi.InlineResponse200
- BrainrexApi.InlineResponse2001
- BrainrexApi.InlineResponse2002
- BrainrexApi.InlineResponse201
- BrainrexApi.InlineResponse2011
- BrainrexApi.Request
- BrainrexApi.Request1
- BrainrexApi.Text
Documentation for Authorization
All endpoints do not require authorization.