alphaiq-sdk

AlphaIqApi - JavaScript client for alphaiq-sdk Quantitative Linguistics is the Future of Investment Research This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.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 alphaiq-sdk --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your alphaiq-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 AlphaIqApi = require('alphaiq-sdk');

var defaultClient = AlphaIqApi.ApiClient.instance;
// Configure Bearer access token for authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.accessToken = "YOUR ACCESS TOKEN"

var api = new AlphaIqApi.InvestmentResearchersApi()
var contentType = application/json; // {String} 
var opts = {
  'gettokenModel': {"email":"[email protected]","password":"base_64_password"} // {GettokenModel} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authGettokenPost(contentType, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AlphaIqApi.InvestmentResearchersApi | authGettokenPost | POST /auth/gettoken | GetToken AlphaIqApi.InvestmentResearchersApi | companyCompassReportTickerGet | GET /company/compass/report/{ticker} | CompassReportPDF AlphaIqApi.InvestmentResearchersApi | companyMappingCompanyToSecurityGet | GET /company-mapping/company-to-security | CompanyToSecurity AlphaIqApi.InvestmentResearchersApi | companySpindexGetLatestSpindexFactorsGet | GET /company-spindex/getLatestSpindexFactors | GetLatestSpindexFactors AlphaIqApi.InvestmentResearchersApi | companySpindexGetLatestSpindexOverallRiskGet | GET /company-spindex/getLatestSpindexOverallRisk | GetLatestSpindexOverallRisk AlphaIqApi.InvestmentResearchersApi | companySpindexGetTimeseriesSpindexFactorsGet | GET /company-spindex/getTimeseriesSpindexFactors | GetTimeseriesSpindexFactors AlphaIqApi.InvestmentResearchersApi | companySpindexGetTimeseriesSpindexOverallRiskGet | GET /company-spindex/getTimeseriesSpindexOverallRisk | GetTimeseriesSpindexOverallRisk AlphaIqApi.InvestmentResearchersApi | companySpinsightsReportTickerGet | GET /company/spinsights/report/{ticker} | SpinsightsReportPDF AlphaIqApi.InvestmentResearchersApi | factorLibraryCompassQuestionsGet | GET /factor-library/compass-questions | GetCompassQuestions AlphaIqApi.InvestmentResearchersApi | factorLibrarySpindexFactorsGet | GET /factor-library/spindex-factors | GetSpindexFactors AlphaIqApi.InvestmentResearchersApi | generativeCompanyCompassReportContentTickerGet | GET /generative/company/compass/reportContent/{ticker} | GetCompassReportContent AlphaIqApi.InvestmentResearchersApi | generativeCompanyQuestionAnswerTickerGet | GET /generative/company/questionAnswer/{ticker} | GetCompassExplorerQuestionAnswer AlphaIqApi.InvestmentResearchersApi | generativeCompanySpinsightsExplorerTickerGet | GET /generative/company/spinsights/explorer/{ticker} | GetSpinsightsExplorer AlphaIqApi.InvestmentResearchersApi | generativeCompanySpinsightsReportContentTickerGet | GET /generative/company/spinsights/reportContent/{ticker} | GetSpinsightsReportContent

Documentation for Models

• AlphaIqApi.AuthGetTokenModel
• AlphaIqApi.CompanyCompassReportPdfModel
• AlphaIqApi.CompanyMappingCompanyToSecurityModel
• AlphaIqApi.CompanySpindexGetLatestSpindexFactorsModel
• AlphaIqApi.CompanySpindexGetLatestSpindexOverallRiskModel
• AlphaIqApi.CompanySpindexGetTimeseriesSpindexFactorsModel
• AlphaIqApi.CompanySpindexGetTimeseriesSpindexOverallRiskModel
• AlphaIqApi.CompanySpinsightsReportPdfModel
• AlphaIqApi.CompanySpinsightsReportTickerGet404Response
• AlphaIqApi.CompanySpinsightsReportTickerGet404ResponseErrorsInner
• AlphaIqApi.FactorLibraryCompassQuestionsModel
• AlphaIqApi.FactorLibrarySpindexFactorsModel
• AlphaIqApi.GenerativeCompanyCompassReportContentModel
• AlphaIqApi.GenerativeCompanyCompassReportContentModelCompassContent
• AlphaIqApi.GenerativeCompanyQuestionAnswerModel
• AlphaIqApi.GenerativeCompanyQuestionAnswerModelQuestionAnswerInner
• AlphaIqApi.GenerativeCompanySpinsightsExplorerModel
• AlphaIqApi.GenerativeCompanySpinsightsExplorerModelSpinsightsExplorerInner
• AlphaIqApi.GenerativeCompanySpinsightsReportContentModel
• AlphaIqApi.GenerativeCompanySpinsightsReportContentModelSpinsightsContent
• AlphaIqApi.GettokenModel

Documentation for Authorization

Authentication schemes defined for the API:

bearer

• Type: Bearer authentication