Skip to content

Investabit/investabit-js-sdk

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

crypto_weather

CryptoWeather - JavaScript client for crypto_weather The CryptoWeather API allows for access to all of the cryptocurrency data and market forecast services provided. There are two primary categories of routes, public and private, where public routes are accessible to the general public and do not require API authentication, and private routes, which require API authentication. ## General Overview 1. All API methods adhere to RESTful best practices as closely as possible. As such, all API calls will be made via the standard HTTP protocol using the GET/POST/PUT/DELETE request types. 2. Every request returns the status as a JSON response with the following: - success, true if it was successful - code, the http status code (also in the response header) - 200 if response is successful - 400 if bad request - 401 if authorization JWT is wrong or limit exceeded - 404 wrong route - 500 for any internal errors - status, the status of the request, default success - errors, an array of any relevant error details 3. For any requests that are not successful an error message is specified and returned as an array for the errors key in the JSON response. 4. All authentication uses JSON Web Tokens (JWT), which is set as the Authorization entry in the header, see the following for more details. - http://jwt.io - https://scotch.io/tutorials/the-anatomy-of-a-json-web-token ## Code Example The following is a code example in Python, which demonstrates using the Python Requests library for both the public and private API routes. import requests HOST = \"https://api.cryptoweather.ai/v1\" # Your API key (JWT) API_KEY = \"<YOUR API KEY>\" # Example public request, no API key required. requests.get(\"{}/public/symbols\".format(HOST)).json() # Get the current btc price using the public route requests.get(\"{}/public/price-current/{}\".format(HOST, \"btc\")).json() # Example private request, API key required. Get the btc hourly forecasts headers = {\"Authorization\": \"Bearer {}\".format(API_KEY)} requests.get(\"{}/private/forecast/{}/{}\".format(HOST, \"btc\", \"1h\"), headers=headers).json() This SDK is automatically generated by the Swagger Codegen project:

  • API version:
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.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 crypto_weather --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 crypto_weather from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('crypto_weather') 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/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, 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 CryptoWeather = require('crypto_weather');

var defaultClient = CryptoWeather.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new CryptoWeather.PrivateApi()

var symbol = "btc"; // {String} The cryptocurrency symbol.

var interval = "1h"; // {String} The forecast interval, 1h or 1d.

var period = "7d"; // {String} The period for computing the accuracy, such as the past 7 days.

var opts = { 
  'cookie': "csrf=b1820141-1bad-4a9c-93c0-52022817ce89", // {String} e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89
  'xCsrf': "b1820141-1bad-4a9c-93c0-52022817ce89" // {String} e.g. b1820141-1bad-4a9c-93c0-52022817ce89
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v1PrivateAccuracySymbolIntervalPeriodGet(symbol, interval, period, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.cryptoweather.ai

Class Method HTTP request Description
CryptoWeather.PrivateApi v1PrivateAccuracySymbolIntervalPeriodGet GET /v1/private/accuracy/{symbol}/{interval}/{period} Accuracy
CryptoWeather.PrivateApi v1PrivateForecastAccuracySymbolIntervalPeriodGet GET /v1/private/forecast-accuracy/{symbol}/{interval}/{period} Forecast Accuracy
CryptoWeather.PrivateApi v1PrivateForecastSymbolIntervalGet GET /v1/private/forecast/{symbol}/{interval} Forecast
CryptoWeather.PrivateApi v1PrivateForecastTimeSymbolIntervalPeriodGet GET /v1/private/forecast-time/{symbol}/{interval}/{period} Forecast Time
CryptoWeather.PrivateApi v1PrivateTrendSymbolGet GET /v1/private/trend/{symbol} Trend
CryptoWeather.PrivateApi v1PrivateTrendTabularGet GET /v1/private/trend-tabular Trend Tabular
CryptoWeather.PublicApi v1PublicPriceChangeSymbolGet GET /v1/public/price-change/{symbol} Price Change
CryptoWeather.PublicApi v1PublicPriceCurrentSymbolGet GET /v1/public/price-current/{symbol} Price Current
CryptoWeather.PublicApi v1PublicPriceHistorySymbolPeriodIntervalGet GET /v1/public/price-history/{symbol}/{period}/{interval} Price History
CryptoWeather.PublicApi v1PublicSummaryGet GET /v1/public/summary Summary
CryptoWeather.PublicApi v1PublicSymbolsGet GET /v1/public/symbols Symbols
CryptoWeather.PublicApi v1PublicTrendSymbolGet GET /v1/public/trend/{symbol} Trend

Documentation for Models

Documentation for Authorization

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes: N/A

About

Investabit JavaScript SDK.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published