1.0.1 • Published 8 years ago

api-documentation v1.0.1

Weekly downloads
7
License
Apache 2.0
Repository
-
Last release
8 years ago

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/

ClassMethodHTTP requestDescription
ApiDocumentation.AccountTypesApisearchUsingGET1GET /accounttypesGet Account Types
ApiDocumentation.AuthenticationApivalidateCredentialsUsingPOSTPOST /authenticateAuthenticate app
ApiDocumentation.BenchmarksApigetPricesUsingGETGET /benchmark/{id}/valuesGet values for the benchmark
ApiDocumentation.BenchmarksApisearchUsingGET2GET /benchmarkSearch a benchmark
ApiDocumentation.ClientApicreateUsingPOST1POST /clientCreate A Client
ApiDocumentation.ClientApigetAllInfoUsingGETGET /client/{clientid}/getallinformationGet all information
ApiDocumentation.ClientApigetBalancesUsingGET1GET /client/{clientid}/performanceGet Client Performance
ApiDocumentation.ClientApigetHoldingsUsingGET1GET /client/{clientid}/holdingsGet Client Holdings
ApiDocumentation.ClientApigetTransactionsUsingGET1GET /client/{clientid}/transactionsGet Client Transactions
ApiDocumentation.ClientApigetUsingGET1GET /client/{clientid}Get client
ApiDocumentation.ClientApiloginUsingPOSTPOST /client/loginLogin a user
ApiDocumentation.ClientApilogoutUsingPOSTPOST /client/{clientid}/logoutLogout a user
ApiDocumentation.ClientApirefreshTokenUsingPOSTPOST /client/{clientid}/refreshtokenRefresh the user token
ApiDocumentation.ClientApiresetPasswordUsingPUTPUT /client/resetpasswordReset passoword
ApiDocumentation.ClientApiupdateUsingPUT1PUT /client/{clientid}Update A Client
ApiDocumentation.ClientAccountApicreateUsingPOSTPOST /client/{clientid}/accountCreate An Account
ApiDocumentation.ClientAccountApigetBalancesUsingGETGET /client/{clientid}/account/{accountid}/performanceGet Account Performance
ApiDocumentation.ClientAccountApigetHoldingsUsingGETGET /client/{clientid}/account/{accountid}/holdingsGet Account Holdings
ApiDocumentation.ClientAccountApigetTransactionsUsingGETGET /client/{clientid}/account/{accountid}/transactionsGet Account Transactions
ApiDocumentation.ClientAccountApigetUsingGETGET /client/{clientid}/account/{accountid}Get An Account
ApiDocumentation.ClientAccountApisearchUsingGETGET /client/{clientid}/accountSearch An Account
ApiDocumentation.ClientAccountApiupdateUsingPUTPUT /client/{clientid}/account/{accountid}Update An Account
ApiDocumentation.ClientNotificationsApieditAlertSettingsUsingPUTPUT /client/{clientid}/alertsettingsUpdate Alert Settings
ApiDocumentation.ClientNotificationsApieditEmailSettingsUsingPUTPUT /client/{clientid}/alertsettings/{alertsettingsid}Update An Alert Setting
ApiDocumentation.ClientNotificationsApigetAlertSettingsUsingGETGET /client/{clientid}/alertsettings/{alertsettingsid}Get An Alert Setting
ApiDocumentation.ClientNotificationsApigetAllAlertSettingsUsingGETGET /client/{clientid}/alertsettingsGet Alert Settings
ApiDocumentation.ClientNotificationsApigetAllNotificationsUsingGETGET /client/{clientid}/allnotificationsGet Client All Notifications
ApiDocumentation.ClientNotificationsApigetNotificationsUsingGETGET /client/{clientid}/activenotificationsGet Client Active Notifications
ApiDocumentation.ClientNotificationsApisetPushTokenUsingPOSTPOST /client/{clientid}/pushtokenSet the push notification token
ApiDocumentation.CountriesApisearchUsingGET3GET /countryGet Countries
ApiDocumentation.SecuritiesApigetPricesUsingGET1GET /security/{id}/pricesGet prices
ApiDocumentation.SecuritiesApisearchUsingGET4GET /securitySearch a security

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.