Intrinio.SDK.Api.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 (string company = null, string reportType = null, DateTime? startDate = null, DateTime? endDate = null, string industryCategory = null, string industryGroup = null, bool? theaEnabled = null, int? pageSize = null, string nextPage = null)

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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllFilingsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string company = "AAPL";
      string reportType = "10-Q";
      DateTime? startDate = DateTime.Parse("2015-01-01");
      DateTime? endDate = null;
      string industryCategory = null;
      string industryGroup = null;
      bool? theaEnabled = null;
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseFilings result = filingApi.GetAllFilings(company, reportType, startDate, endDate, industryCategory, industryGroup, theaEnabled, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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="https://docs.intrinio.com/documentation/sec_filing_report_types\" target="_blank">report types</a>.	[optional]
startDate	DateTime?	Filed on or after the given date	[optional]
endDate	DateTime?	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	bool?	Return filings that have been read by our Thea NLP and are ready for our answers endpoint	[optional]
pageSize	int?	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 (string company = null, string reportType = null, DateTime? filingStartDate = null, DateTime? filingEndDate = null, DateTime? periodEndedStartDate = null, DateTime? periodEndedEndDate = null, int? pageSize = null, string nextPage = null)

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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllNotesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string company = "AAPL";
      string reportType = "10-Q";
      DateTime? filingStartDate = null;
      DateTime? filingEndDate = null;
      DateTime? periodEndedStartDate = null;
      DateTime? periodEndedEndDate = null;
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseFilingNotes result = filingApi.GetAllNotes(company, reportType, filingStartDate, filingEndDate, periodEndedStartDate, periodEndedEndDate, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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="https://docs.intrinio.com/documentation/sec_filing_report_types\" target="_blank">report type</a>	[optional]
filingStartDate	DateTime?	Limit search to filings on or after this date	[optional]
filingEndDate	DateTime?	Limit search to filings on or before this date	[optional]
periodEndedStartDate	DateTime?	Limit search to filings with a period end date on or after this date	[optional]
periodEndedEndDate	DateTime?	Limit search to filings with a period end date on or before this date	[optional]
pageSize	int?	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 (string identifier, string query)

Filing Answers

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetFilingAnswersExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "fil_B73xBG";
      string query = "What do they believe in?";
      
      ApiResponseFilingAnswers result = filingApi.GetFilingAnswers(identifier, query);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 (string id)

Lookup Filing

Returns the Filing with the given identifier

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetFilingByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string id = "fil_7Kn2P6";
      
      Filing result = filingApi.GetFilingById(id);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

Filing

GetFilingFundamentals

View Intrinio API Documentation

ApiResponseFilingFundamentals GetFilingFundamentals (string identifier, string statementCode = null, string type = null, int? fiscalYear = null, string fiscalPeriod = null, DateTime? startDate = null, DateTime? endDate = null, string nextPage = null)

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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetFilingFundamentalsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "fil_B73xBG";
      string statementCode = null;
      string type = null;
      int? fiscalYear = null;
      string fiscalPeriod = null;
      DateTime? startDate = null;
      DateTime? endDate = null;
      string nextPage = null;
      
      ApiResponseFilingFundamentals result = filingApi.GetFilingFundamentals(identifier, statementCode, type, fiscalYear, fiscalPeriod, startDate, endDate, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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	int?	Filters fundamentals by fiscal year	[optional]
fiscalPeriod	string	Filters fundamentals by fiscal period	[optional]
startDate	DateTime?	Returns fundamentals on or after the given date	[optional]
endDate	DateTime?	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 (string identifier)

Filing Html

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetFilingHtmlExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "fil_B73xBG";
      
      string result = filingApi.GetFilingHtml(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name	Type	Description	Notes
identifier	string	A Filing identifier

Return type

string

GetFilingText

View Intrinio API Documentation

string GetFilingText (string identifier)

Filing Text

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetFilingTextExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "fil_B73xBG";
      
      string result = filingApi.GetFilingText(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name	Type	Description	Notes
identifier	string	A Filing identifier

Return type

string

GetNote

View Intrinio API Documentation

FilingNote GetNote (string identifier, string contentFormat = null)

Filing Note by ID

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

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetNoteExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "xbn_ydK3QL";
      string contentFormat = "text";
      
      FilingNote result = filingApi.GetNote(identifier, contentFormat);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 (string identifier)

Filing Note HTML

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetNoteHtmlExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "xbn_ydK3QL";
      
      string result = filingApi.GetNoteHtml(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

string

GetNoteText

View Intrinio API Documentation

string GetNoteText (string identifier)

Filing Note Text

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetNoteTextExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string identifier = "xbn_ydK3QL";
      
      string result = filingApi.GetNoteText(identifier);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

string

SearchNotes

View Intrinio API Documentation

ApiResponseFilingNotesSearch SearchNotes (string query, DateTime? filingStartDate = null, DateTime? filingEndDate = null, int? pageSize = null)

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

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class SearchNotesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var filingApi = new FilingApi();
      
      string query = "inflation";
      DateTime? filingStartDate = DateTime.Parse("2018-07-15");
      DateTime? filingEndDate = DateTime.Parse("2018-11-30");
      int? pageSize = 100;
      
      ApiResponseFilingNotesSearch result = filingApi.SearchNotes(query, filingStartDate, filingEndDate, pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

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

Return type

ApiResponseFilingNotesSearch

Files

FilingApi.md

Latest commit

History

FilingApi.md

File metadata and controls

Intrinio.SDK.Api.FilingApi

GetAllFilings

All Filings

Example

Parameters

Return type

GetAllNotes

All Filing Notes

Example

Parameters

Return type

GetFilingAnswers

Filing Answers

Example

Parameters

Return type

GetFilingById

Lookup Filing

Example

Parameters

Return type

GetFilingFundamentals

All Fundamentals by Filing

Example

Parameters

Return type

GetFilingHtml

Filing Html

Example

Parameters

Return type

GetFilingText

Filing Text

Example

Parameters

Return type

GetNote

Filing Note by ID

Example

Parameters

Return type

GetNoteHtml

Filing Note HTML

Example

Parameters

Return type

GetNoteText

Filing Note Text

Example

Parameters

Return type

SearchNotes

Search Filing Notes

Example

Parameters

Return type