The Official Intrinio API Javascript SDK
Clone or download
Kenneth Miller
Latest commit e218798 Jan 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen Minor update Mar 21, 2018
docs No release notes for this build Jan 3, 2019
src No release notes for this build Jan 8, 2019
test No release notes for this build Jan 8, 2019
.babelrc Minor update Mar 21, 2018
.swagger-codegen-ignore Minor update Mar 21, 2018
.travis.yml Minor update Mar 21, 2018
README.md No release notes for this build Jan 8, 2019
git_push.sh fixed package generation Mar 21, 2018
mocha.opts Minor update Mar 21, 2018
package.json No release notes for this build Jan 8, 2019

README.md

Intrinio JavaScript SDK

To get an API key, sign up here.

Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the Intrinio API documentation. If you need additional help in using the API, please visit the Intrinio website and click on the chat icon in the lower right corner.

  • API version: 2.1.0
  • Package version: 1.1.2

Installation

npm install intrinio-sdk --save

Installation from Github

npm install intrinio/javascript-sdk --save

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
      }
    }
  ]
}

SDK Code Examples

Code examples for Intrinio SDKs are available at https://github.com/intrinio/sdk-code-samples

Getting Started

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

var intrinioSDK = require('intrinio-sdk');
const util = require('util')
 
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR API KEY";
 
var companyAPI = new intrinioSDK.CompanyApi()
 
companyAPI.getAllCompanies().then(function(data) {
  console.log(util.inspect(data, false, null, true));
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api-v2.intrinio.com

Class Method HTTP request Description
intrinioSDK.CompanyApi filterCompanies GET /companies/filter Filter Companies
intrinioSDK.CompanyApi filterCompanyFundamentals GET /companies/{identifier}/fundamentals/filter Filter Fundamentals by Company
intrinioSDK.CompanyApi getAllCompanies GET /companies All Companies
intrinioSDK.CompanyApi getAllCompanyNews GET /companies/news All News
intrinioSDK.CompanyApi getCompany GET /companies/{identifier} Lookup Company
intrinioSDK.CompanyApi getCompanyDataPointNumber GET /companies/{identifier}/data_point/{tag}/number Data Point (Number) for Company
intrinioSDK.CompanyApi getCompanyDataPointText GET /companies/{identifier}/data_point/{tag}/text Data Point (Text) for Company
intrinioSDK.CompanyApi getCompanyFilings GET /companies/{identifier}/filings All Filings by Company
intrinioSDK.CompanyApi getCompanyFundamentals GET /companies/{identifier}/fundamentals All Fundamentals by Company
intrinioSDK.CompanyApi getCompanyHistoricalData GET /companies/{identifier}/historical_data/{tag} Historical Data for Company
intrinioSDK.CompanyApi getCompanyNews GET /companies/{identifier}/news All News by Company
intrinioSDK.CompanyApi getCompanySecurities GET /companies/{identifier}/securities All Securities by Company
intrinioSDK.CompanyApi lookupCompanyFundamental GET /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental by Company
intrinioSDK.CompanyApi searchCompanies GET /companies/search Search Companies
intrinioSDK.DataPointApi getDataPointNumber GET /data_point/{identifier}/{tag}/number Data Point (Number)
intrinioSDK.DataPointApi getDataPointText GET /data_point/{identifier}/{tag}/text Data Point (Text)
intrinioSDK.DataTagApi filterDataTags GET /data_tags/filter Filter Data Tags
intrinioSDK.DataTagApi getAllDataTags GET /data_tags All Data Tags
intrinioSDK.DataTagApi getDataTagById GET /data_tags/{identifier} Lookup Data Tag
intrinioSDK.DataTagApi searchDataTags GET /data_tags/search Search Data Tags
intrinioSDK.FilingApi filterFilings GET /filings/filter Filter Filings
intrinioSDK.FilingApi filterNotes GET /filings/notes/filter Filter Filing Notes
intrinioSDK.FilingApi getAllFilings GET /filings All Filings
intrinioSDK.FilingApi getAllNotes GET /filings/notes All Filing Notes
intrinioSDK.FilingApi getFilingById GET /filings/{id} Lookup Filing
intrinioSDK.FilingApi getNote GET /filings/notes/{identifier} Filing Note by ID
intrinioSDK.FilingApi getNoteHtml GET /filings/notes/{identifier}/html Filing Note HTML
intrinioSDK.FilingApi getNoteText GET /filings/notes/{identifier}/text Filing Note Text
intrinioSDK.FilingApi searchNotes GET /filings/notes/search Search Filing Notes
intrinioSDK.FundamentalsApi getFundamentalById GET /fundamentals/{id} Fundamental by ID
intrinioSDK.FundamentalsApi getFundamentalReportedFinancials GET /fundamentals/{id}/reported_financials Reported Financials
intrinioSDK.FundamentalsApi getFundamentalStandardizedFinancials GET /fundamentals/{id}/standardized_financials Standardized Financials
intrinioSDK.FundamentalsApi lookupFundamental GET /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental
intrinioSDK.HistoricalDataApi getHistoricalData GET /historical_data/{identifier}/{tag} Historical Data
intrinioSDK.IndexApi getAllEconomicIndices GET /indices/economic All Economic Indices
intrinioSDK.IndexApi getAllSicIndices GET /indices/sic All SIC Indices
intrinioSDK.IndexApi getAllStockMarketIndices GET /indices/stock_market All Stock Market Indices
intrinioSDK.IndexApi getEconomicIndexById GET /indices/economic/{identifier} Lookup Economic Index
intrinioSDK.IndexApi getEconomicIndexDataPointNumber GET /indices/economic/{identifier}/data_point/{tag}/number Data Point (Number) for an Economic Index
intrinioSDK.IndexApi getEconomicIndexDataPointText GET /indices/economic/{identifier}/data_point/{tag}/text Data Point (Text) for an Economic Index
intrinioSDK.IndexApi getEconomicIndexHistoricalData GET /indices/economic/{identifier}/historical_data/{tag} Historical Data for an Economic Index
intrinioSDK.IndexApi getSicIndexById GET /indices/sic/{identifier} Lookup SIC Index
intrinioSDK.IndexApi getSicIndexDataPointNumber GET /indices/sic/{identifier}/data_point/{tag}/number Data Point (Number) for an SIC Index
intrinioSDK.IndexApi getSicIndexDataPointText GET /indices/sic/{identifier}/data_point/{tag}/text Data Point (Text) for an SIC Index
intrinioSDK.IndexApi getSicIndexHistoricalData GET /indices/sic/{identifier}/historical_data/{tag} Historical Data for an SIC Index
intrinioSDK.IndexApi getStockMarketIndexById GET /indices/stock_market/{identifier} Lookup Stock Market Index
intrinioSDK.IndexApi getStockMarketIndexDataPointNumber GET /indices/stock_market/{identifier}/data_point/{tag}/number Data Point (Number) for Stock Market Index
intrinioSDK.IndexApi getStockMarketIndexDataPointText GET /indices/stock_market/{identifier}/data_point/{tag}/text Data Point (Text) for Stock Market Index
intrinioSDK.IndexApi getStockMarketIndexHistoricalData GET /indices/stock_market/{identifier}/historical_data/{tag} Historical Data for Stock Market Index
intrinioSDK.IndexApi searchEconomicIndices GET /indices/economic/search Search Economic Indices
intrinioSDK.IndexApi searchSicIndices GET /indices/sic/search Search SIC Indices
intrinioSDK.IndexApi searchStockMarketsIndices GET /indices/stock_market/search Search Stock Market Indices
intrinioSDK.SecurityApi getAllSecurities GET /securities All Securities
intrinioSDK.SecurityApi getSecurityById GET /securities/{identifier} Lookup Security
intrinioSDK.SecurityApi getSecurityDataPointNumber GET /securities/{identifier}/data_point/{tag}/number Data Point (Number) for Security
intrinioSDK.SecurityApi getSecurityDataPointText GET /securities/{identifier}/data_point/{tag}/text Data Point (Text) for Security
intrinioSDK.SecurityApi getSecurityHistoricalData GET /securities/{identifier}/historical_data/{tag} Historical Data for Security
intrinioSDK.SecurityApi getSecurityLatestDividendRecord GET /securities/{identifier}/dividends/latest Lastest Dividend Record for Security
intrinioSDK.SecurityApi getSecurityLatestEarningsRecord GET /securities/{identifier}/earnings/latest Lastest Earnings Record for Security
intrinioSDK.SecurityApi getSecurityRealtimePrice GET /securities/{identifier}/prices/realtime Realtime Stock Price for Security
intrinioSDK.SecurityApi getSecurityStockPriceAdjustments GET /securities/{identifier}/prices/adjustments Stock Price Adjustments by Security
intrinioSDK.SecurityApi getSecurityStockPrices GET /securities/{identifier}/prices Stock Prices by Security
intrinioSDK.SecurityApi screenSecurities POST /securities/screen Screen Securities
intrinioSDK.SecurityApi searchSecurities GET /securities/search Search Securities
intrinioSDK.StockExchangeApi filterStockExchanges GET /stock_exchanges/filter Filter Stock Exchanges
intrinioSDK.StockExchangeApi getAllStockExchanges GET /stock_exchanges All Stock Exchanges
intrinioSDK.StockExchangeApi getStockExchangeById GET /stock_exchanges/{identifier} Lookup Stock Exchange
intrinioSDK.StockExchangeApi getStockExchangePriceAdjustments GET /stock_exchanges/{identifier}/prices/adjustments Stock Price Adjustments by Exchange
intrinioSDK.StockExchangeApi getStockExchangePrices GET /stock_exchanges/{identifier}/prices Stock Prices by Exchange
intrinioSDK.StockExchangeApi getStockExchangeRealtimePrices GET /stock_exchanges/{identifier}/prices/realtime Realtime Stock Prices by Exchange
intrinioSDK.StockExchangeApi getStockExchangeSecurities GET /stock_exchanges/{identifier}/securities Securities by Exchange

Documentation for Models