ivolapi v3.0.4

ivolapi

IVolApi - JavaScript client for ivolapi implied volatility and price data for selected ETFs and futures. Contact: info at volsurf.com This SDK is automatically generated by the Swagger Codegen project:

• API version: 3.0.3
• Package version: 3.0.3
• 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 ivolapi --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 IVolApi = require('ivolapi');

var api = new IVolApi.APIHealthApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHeartbeat(callback);

Documentation for API Endpoints

All URIs are relative to /

Documentation for Models

• IVolApi.BodyPostApiUserLoginLoginPost
• IVolApi.Data
• IVolApi.DeltaQuery
• IVolApi.GetStrikesModel
• IVolApi.HTTPValidationError
• IVolApi.HeartBeat
• IVolApi.Query
• IVolApi.Query1
• IVolApi.Query2
• IVolApi.RawOptionPy
• IVolApi.RegisterPy
• IVolApi.SurfaceAggregate
• IVolApi.SurfaceValue
• IVolApi.Token
• IVolApi.TopOiQuery
• IVolApi.UpdatePassword
• IVolApi.ValidationError
• IVolApi.VolaSummary

Documentation for Authorization

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes:
  • :