The Official Intrinio API Java SDK
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen
docs
gradle/wrapper init Mar 21, 2018
src No release notes for this build Jan 3, 2019
.gitignore
.swagger-codegen-ignore
.travis.yml
README.md
build.gradle No release notes for this build Jan 3, 2019
build.sbt
git_push.sh
gradle.properties init Mar 21, 2018
gradlew
gradlew.bat
pom.xml
settings.gradle No release notes for this build Dec 17, 2018

README.md

Intrinio Java 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.1

Requirements

Building the Intrinio Java SDK requires Maven to be installed.

Installation

To install the Intrinio Java SDK to your local Maven repository, simply execute:

mvn install

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.intrinio</groupId>
    <artifactId>intrinio-sdk</artifactId>
    <version>1.1.1</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.intrinio:intrinio-sdk:1.1.1"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/intrinio-sdk-1.1.1.jar
  • target/lib/*.jar

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 Java code:

import com.intrinio.invoker.ApiClient;
import com.intrinio.invoker.ApiException;
import com.intrinio.invoker.Configuration;
import com.intrinio.invoker.auth.ApiKeyAuth;
import com.intrinio.api.CompanyApi;
import com.intrinio.models.ApiResponseCompanies;

import java.io.File;
import java.util.*;

public class CompanyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        auth.setApiKey("YOUR API KEY");

        CompanyApi companyApi = new CompanyApi();
        String nextPage = null;
        
        try {
            ApiResponseCompanies result = companyApi.getAllCompanies(nextPage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#filterCompanies");
            e.printStackTrace();
        }
    }
}

Multi-threading Recommendation

It's recommended to create one instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Documentation for API Endpoints

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

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

Documentation for Models