api-documentation

Api Documentation

Usage no npm install needed!

<script type="module">
  import apiDocumentation from 'https://cdn.skypack.dev/api-documentation';
</script>

README

api-documentation

ApiDocumentation - JavaScript client for api-documentation Api Documentation This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 1.0
  • Build date: 2016-05-12T22:21:30.582Z
  • Build package: class 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 api-documentation --save

git

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

npm install YOUR_USERNAME/api-documentation --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.

Getting Started

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

var ApiDocumentation = require('api-documentation');

var api = new ApiDocumentation.AccountTypesApi()

var token = "token_example"; // {String} The API partner's authorization token


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

Documentation for API Endpoints

All URIs are relative to https://api.hedgeable.com/

Class Method HTTP request Description
ApiDocumentation.AccountTypesApi searchUsingGET1 GET /accounttypes Get Account Types
ApiDocumentation.AuthenticationApi validateCredentialsUsingPOST POST /authenticate Authenticate app
ApiDocumentation.BenchmarksApi getPricesUsingGET GET /benchmark/{id}/values Get values for the benchmark
ApiDocumentation.BenchmarksApi searchUsingGET2 GET /benchmark Search a benchmark
ApiDocumentation.ClientApi createUsingPOST1 POST /client Create A Client
ApiDocumentation.ClientApi getAllInfoUsingGET GET /client/{clientid}/getallinformation Get all information
ApiDocumentation.ClientApi getBalancesUsingGET1 GET /client/{clientid}/performance Get Client Performance
ApiDocumentation.ClientApi getHoldingsUsingGET1 GET /client/{clientid}/holdings Get Client Holdings
ApiDocumentation.ClientApi getTransactionsUsingGET1 GET /client/{clientid}/transactions Get Client Transactions
ApiDocumentation.ClientApi getUsingGET1 GET /client/{clientid} Get client
ApiDocumentation.ClientApi loginUsingPOST POST /client/login Login a user
ApiDocumentation.ClientApi logoutUsingPOST POST /client/{clientid}/logout Logout a user
ApiDocumentation.ClientApi refreshTokenUsingPOST POST /client/{clientid}/refreshtoken Refresh the user token
ApiDocumentation.ClientApi resetPasswordUsingPUT PUT /client/resetpassword Reset passoword
ApiDocumentation.ClientApi updateUsingPUT1 PUT /client/{clientid} Update A Client
ApiDocumentation.ClientAccountApi createUsingPOST POST /client/{clientid}/account Create An Account
ApiDocumentation.ClientAccountApi getBalancesUsingGET GET /client/{clientid}/account/{accountid}/performance Get Account Performance
ApiDocumentation.ClientAccountApi getHoldingsUsingGET GET /client/{clientid}/account/{accountid}/holdings Get Account Holdings
ApiDocumentation.ClientAccountApi getTransactionsUsingGET GET /client/{clientid}/account/{accountid}/transactions Get Account Transactions
ApiDocumentation.ClientAccountApi getUsingGET GET /client/{clientid}/account/{accountid} Get An Account
ApiDocumentation.ClientAccountApi searchUsingGET GET /client/{clientid}/account Search An Account
ApiDocumentation.ClientAccountApi updateUsingPUT PUT /client/{clientid}/account/{accountid} Update An Account
ApiDocumentation.ClientNotificationsApi editAlertSettingsUsingPUT PUT /client/{clientid}/alertsettings Update Alert Settings
ApiDocumentation.ClientNotificationsApi editEmailSettingsUsingPUT PUT /client/{clientid}/alertsettings/{alertsettingsid} Update An Alert Setting
ApiDocumentation.ClientNotificationsApi getAlertSettingsUsingGET GET /client/{clientid}/alertsettings/{alertsettingsid} Get An Alert Setting
ApiDocumentation.ClientNotificationsApi getAllAlertSettingsUsingGET GET /client/{clientid}/alertsettings Get Alert Settings
ApiDocumentation.ClientNotificationsApi getAllNotificationsUsingGET GET /client/{clientid}/allnotifications Get Client All Notifications
ApiDocumentation.ClientNotificationsApi getNotificationsUsingGET GET /client/{clientid}/activenotifications Get Client Active Notifications
ApiDocumentation.ClientNotificationsApi setPushTokenUsingPOST POST /client/{clientid}/pushtoken Set the push notification token
ApiDocumentation.CountriesApi searchUsingGET3 GET /country Get Countries
ApiDocumentation.SecuritiesApi getPricesUsingGET1 GET /security/{id}/prices Get prices
ApiDocumentation.SecuritiesApi searchUsingGET4 GET /security Search a security

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.