Skip to content

Latest commit

 

History

History
951 lines (550 loc) · 21.8 KB

FilingApi.md

File metadata and controls

951 lines (550 loc) · 21.8 KB

intrinioSDK.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
getFilingAnswers GET /filings/{identifier}/answers Filing Answers
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(opts)

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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var opts = { 
  'company': "AAPL",
  'reportType': "10-Q",
  'startDate': new Date("2015-01-01"),
  'endDate': null,
  'industryCategory': null,
  'industryGroup': null,
  'theaEnabled': null,
  'earningsRelease': null,
  'pageSize': 100,
  'nextPage': null
};

filing.getAllFilings(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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 Date Filed on or after the given date [optional]  
endDate Date 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]  
theaEnabled Boolean Return filings that have been read by our Thea NLP and are ready for our answers endpoint [optional]  
earningsRelease Boolean Return filings that have been tagged as having Results of Operations and Financial Conditions [optional]  
pageSize Number 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(opts)

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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var opts = { 
  'company': "AAPL",
  'reportType': "10-Q",
  'filingStartDate': null,
  'filingEndDate': null,
  'periodEndedStartDate': null,
  'periodEndedEndDate': null,
  'pageSize': 100,
  'nextPage': null
};

filing.getAllNotes(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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]  
filingStartDate Date Limit search to filings on or after this date [optional]  
filingEndDate Date Limit search to filings on or before this date [optional]  
periodEndedStartDate Date Limit search to filings with a period end date on or after this date [optional]  
periodEndedEndDate Date Limit search to filings with a period end date on or before this date [optional]  
pageSize Number 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

getFilingAnswers

View Intrinio API Documentation

ApiResponseFilingAnswers getFilingAnswers(identifier, query)

Filing Answers

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "fil_B73xBG";
var query = "What do they believe in?";


filing.getFilingAnswers(identifier, query).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Filing identifier  
query String The query to ask the Thea API  

Return type

ApiResponseFilingAnswers

getFilingById

View Intrinio API Documentation

Filing getFilingById(id)

Lookup Filing

Returns the Filing with the given `identifier`

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var id = "fil_7Kn2P6";


filing.getFilingById(id).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

Filing

getFilingFundamentals

View Intrinio API Documentation

ApiResponseFilingFundamentals getFilingFundamentals(identifier, opts)

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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "fil_B73xBG";


var opts = { 
  'statementCode': null,
  'type': null,
  'fiscalYear': null,
  'fiscalPeriod': null,
  'startDate': null,
  'endDate': null,
  'nextPage': null
};

filing.getFilingFundamentals(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Filing identifier  
statementCode String Filters fundamentals by statement code [optional]  
type String Filters fundamentals by type [optional]  
fiscalYear Number Filters fundamentals by fiscal year [optional]  
fiscalPeriod String Filters fundamentals by fiscal period [optional]  
startDate Date Returns fundamentals on or after the given date [optional]  
endDate Date 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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "fil_B73xBG";


filing.getFilingHtml(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Filing identifier  

Return type

'String'

getFilingText

View Intrinio API Documentation

'String' getFilingText(identifier)

Filing Text

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "fil_B73xBG";


filing.getFilingText(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Filing identifier  

Return type

'String'

getNote

View Intrinio API Documentation

FilingNote getNote(identifier, opts)

Filing Note by ID

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "xbn_ydK3QL";


var opts = { 
  'contentFormat': "text"
};

filing.getNote(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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]  

Return type

FilingNote

getNoteHtml

View Intrinio API Documentation

'String' getNoteHtml(identifier)

Filing Note HTML

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "xbn_ydK3QL";


filing.getNoteHtml(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var identifier = "xbn_ydK3QL";


filing.getNoteText(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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, opts)

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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var filing = new intrinioSDK.FilingApi();

var query = "inflation";


var opts = { 
  'filingStartDate': new Date("2018-07-15"),
  'filingEndDate': new Date("2018-11-30"),
  'pageSize': 100
};

filing.searchNotes(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

ApiResponseFilingNotesSearch