Skip to content

Latest commit

 

History

History
907 lines (573 loc) · 23.4 KB

FilingApi.md

File metadata and controls

907 lines (573 loc) · 23.4 KB

FilingApi

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

Method HTTP request Description
getAllFilings GET /filings All Filings
getAllNotes GET /filings/notes All Filing Notes
getFilingById GET /filings/{id} Lookup Filing
getFilingFundamentals GET /filings/{identifier}/fundamentals All Fundamentals by Filing
getFilingHtml GET /filings/{identifier}/html Filing Html
getFilingText GET /filings/{identifier}/text Filing Text
getNote GET /filings/notes/{identifier} Filing Note by ID
getNoteHtml GET /filings/notes/{identifier}/html Filing Note HTML
getNoteText GET /filings/notes/{identifier}/text Filing Note Text
searchNotes GET /filings/notes/search Search Filing Notes

getAllFilings

View Intrinio API Documentation

ApiResponseFilings getAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, earningsRelease, pageSize, nextPage)

All Filings

Returns pertinent filing reference data for a specific company filing or latest filings for all companies. Useful for tracking the latest filings submitted and updating your database accordingly with the new information.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String company = "AAPL";
    String reportType = "10-Q";
    LocalDate startDate = LocalDate.of(2015,1,01);
    LocalDate endDate = null;
    String industryCategory = null;
    String industryGroup = null;
    Boolean earningsRelease = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseFilings result = filingApi.getAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, earningsRelease, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
company String Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) [optional]  
reportType String Filter by report type. Separate values with commas to return multiple The filing <a href=&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\" target=&quot;_blank&quot;>report types</a>. [optional]  
startDate LocalDate Filed on or after the given date [optional]  
endDate LocalDate Filed before or after the given date [optional]  
industryCategory String Return companies in the given industry category [optional]  
industryGroup String Return companies in the given industry group [optional]  
earningsRelease Boolean Return filings that have been tagged as having Results of Operations and Financial Conditions [optional]  
pageSize Integer The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseFilings

getAllNotes

View Intrinio API Documentation

ApiResponseFilingNotes getAllNotes(company, reportType, filingStartDate, filingEndDate, periodEndedStartDate, periodEndedEndDate, pageSize, nextPage)

All Filing Notes

Returns a list of the latest XBRL filing note sections from the SEC 10-K and 10-Q statements. The returned Intrinio XBRL filing note ID can then be utilized with the “Filing Note by ID” endpoint to retrieve the contents of the note in HTML or text format.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String company = "AAPL";
    String reportType = "10-Q";
    LocalDate filingStartDate = null;
    LocalDate filingEndDate = null;
    LocalDate periodEndedStartDate = null;
    LocalDate periodEndedEndDate = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseFilingNotes result = filingApi.getAllNotes(company, reportType, filingStartDate, filingEndDate, periodEndedStartDate, periodEndedEndDate, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
company String A Company identifier (Ticker, CIK, LEI, Intrinio ID) [optional]  
reportType String Notes contained in filings that match the given <a href=&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\" target=&quot;_blank&quot;>report type</a> [optional] [enum: 10-Q, 10-K]  
filingStartDate LocalDate Limit search to filings on or after this date [optional]  
filingEndDate LocalDate Limit search to filings on or before this date [optional]  
periodEndedStartDate LocalDate Limit search to filings with a period end date on or after this date [optional]  
periodEndedEndDate LocalDate Limit search to filings with a period end date on or before this date [optional]  
pageSize Integer The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseFilingNotes

getFilingById

View Intrinio API Documentation

Filing getFilingById(id)

Lookup Filing

Returns the Filing with the given `identifier`

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String id = "fil_7Kn2P6";
    Filing result = filingApi.getFilingById(id);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String The Intrinio ID of the Filing  

Return type

Filing

getFilingFundamentals

View Intrinio API Documentation

ApiResponseFilingFundamentals getFilingFundamentals(identifier, statementCode, type, fiscalYear, fiscalPeriod, startDate, endDate, nextPage)

All Fundamentals by Filing

Returns a list of fundamentals with unique fundamental IDs associated with a particular `Intrinio Filing ID` (if applicable) that have been updated or created as a result of a company`s latest SEC filing. Useful to ensure your database is up to date with the latest fundamentals.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String identifier = "fil_B73xBG";
    String statementCode = null;
    String type = null;
    Integer fiscalYear = null;
    String fiscalPeriod = null;
    LocalDate startDate = null;
    LocalDate endDate = null;
    String nextPage = null;
    ApiResponseFilingFundamentals result = filingApi.getFilingFundamentals(identifier, statementCode, type, fiscalYear, fiscalPeriod, startDate, endDate, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Filing identifier  
statementCode String Filters fundamentals by statement code [optional] [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]  
type String Filters fundamentals by type [optional] [enum: QTR, YTD, FY, TTM]  
fiscalYear Integer Filters fundamentals by fiscal year [optional]  
fiscalPeriod String Filters fundamentals by fiscal period [optional] [enum: FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD, Q1TTM, Q2TTM, Q3TTM]  
startDate LocalDate Returns fundamentals on or after the given date [optional]  
endDate LocalDate Returns fundamentals on or before the given date [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseFilingFundamentals

getFilingHtml

View Intrinio API Documentation

String getFilingHtml(identifier)

Filing Html

Returns a SEC filing in HTML Format for a specified filing ID.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String identifier = "fil_B73xBG";
    String result = filingApi.getFilingHtml(identifier);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Filing identifier  

Return type

String

getFilingText

View Intrinio API Documentation

String getFilingText(identifier)

Filing Text

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String identifier = "fil_B73xBG";
    String result = filingApi.getFilingText(identifier);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Filing identifier  

Return type

String

getNote

View Intrinio API Documentation

FilingNote getNote(identifier, contentFormat)

Filing Note by ID

Returns the XBRL filing note contents in HTML or text format for a specified Intrinio XBRL filing note ID.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String identifier = "xbn_ydK3QL";
    String contentFormat = "text";
    FilingNote result = filingApi.getNote(identifier, contentFormat);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String The Intrinio ID of the filing note  
contentFormat String Returns content in html (as filed) or plain text [optional] [default to text] [enum: text, html]  

Return type

FilingNote

getNoteHtml

View Intrinio API Documentation

String getNoteHtml(identifier)

Filing Note HTML

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String identifier = "xbn_ydK3QL";
    String result = filingApi.getNoteHtml(identifier);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String The Intrinio ID of the filing note  

Return type

String

getNoteText

View Intrinio API Documentation

String getNoteText(identifier)

Filing Note Text

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String identifier = "xbn_ydK3QL";
    String result = filingApi.getNoteText(identifier);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String The Intrinio ID of the filing note  

Return type

String

searchNotes

View Intrinio API Documentation

ApiResponseFilingNotesSearch searchNotes(query, filingStartDate, filingEndDate, pageSize)

Search Filing Notes

Search the XBRL note database and return a list of XBRL note sections containing text from the text query parameter passed through.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    FilingApi filingApi = new FilingApi();
    String query = "inflation";
    LocalDate filingStartDate = LocalDate.of(2018,7,15);
    LocalDate filingEndDate = LocalDate.of(2018,11,30);
    Integer pageSize = 100;
    ApiResponseFilingNotesSearch result = filingApi.searchNotes(query, filingStartDate, filingEndDate, pageSize);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
query String Search for notes that contain all or parts of this text  
filingStartDate LocalDate Limit search to filings on or after this date [optional]  
filingEndDate LocalDate Limit search to filings on or before this date [optional]  
pageSize Integer The number of results to return [optional] [default to 100]  

Return type

ApiResponseFilingNotesSearch