API Documentation

This documentation page is for a deeper level of understanding of the API parameters and usage. Please refer to our builder page to have the API automatically generated based on your needs.  

Note: Parameters should always come before calling the getSecData(); method.

You can add CSS for the Filing Viewer Page in the IR Office portal.

<div id="B2iSecDiv"></div>
<script src="https://www.b2i.us/b2i/SECapi.js?v=1.0.7.5" type="text/javascript"></script>
<script type="text/javascript">
oSEC.BizID="2626";
oSEC.sKey="Sf6Ic9Gy8";
oSEC.sHttp="https";
oSEC.sDiv="B2iSecDiv";
oSEC.fonticon="1";
oSEC.lo="1";
oSEC.n="1";
oSEC.sf="1";
getSecData();
</script>
oSEC.lo="0"; Layout: default is DIV, lo="1" will display <table> output, lo="3" for Single/Enhanced Filing View
oSEC.sDiv="; Sets the location to render the data
oSEC.fonticon="1"; Use Font icons instead of default images.
oSEC.DocListOpen="0"; Turn this setting off to collapse the documents list on the enhanced views.
oSEC.t="; Form type filter to limit display of forms: Example: oSEC.t="10-K"
oSEC.sf="0"; Search form: default is show search form, setting to 0 will hide the search form
oSEC.sh="0"; Show column headers: default is show column headers, setting to 0 will hide the column headers
oSEC.sg="1"; Show groups: default is off, setting to 1 will display the group column
oSEC.n="; Navigation: default is show navigation, setting to 0 will hide the navigation
oSEC.c="10"; Count: how many items are displayed per page, default is 20
oSEC.y="; Year: setting a year will limit filings to only that year
oSEC.currentyear="1" Current year: setting to only show the current year items in any of the SEC displays
oSEC.sg="1"; ShowGroups: Show Groups on list view
oSEC.CSS="1"; Set to 0 to turn off default css
oSEC.df="1"; Date Format: 1-5, default is 1, 1= mmm dd, yyyy 2= mm/dd/yyyy 3= dd/mm/yyyy 4= dd mmm yyyy 5= Month dd,yyyy
oSEC.LangID="2"; Language to display text items. Additional languages must be initialized.
oSEC.OpenLinks="; set to "1" for new tab, "2" for new window, "3" for floating div
oSEC.OpenIcons="; set to "1" for new tab, "2" for new window, "3" for floating div
oSEC.TextHeader="; Empty by default.
oSEC.sPdf="; Image URL for PDF files
oSEC.sHtm="; Image URL for Html files
oSEC.sDoc="; Image URL for Doc files
oSEC.sXls="; Image URL for Xls files
oSEC.sXbrl="; Image URL for Xbrl files
oSEC.sZip="; Image URL for Zip files

Form Type Filters

US Filers – Form Filters

Parameter Results Returned
t="10" Forms 10-Q or 10-K
t="10-Q" Forms 10-Q or 10-Q/A
t="10-Qonly" Forms 10-Q
t="10-K" Forms 10-K or 10-K/A
t="10-Konly" Forms 10-K
t="8-K" Forms 8-K or 8-K/A
t="8-Konly" Forms 8-K
t="defa" Forms DEF 14A
t="def" Forms DEF(*) wildcard
t="ircurrent" Forms 10-K, 10-Q and 8-K – Ordered by date
t="ircurrent2" Forms 10-K or 10-Q, 8-K and DEF 14A – Ordered by date
t="ircurrent3" Forms 10-K or 10-Q and DEF 14A – Ordered by date
t="ircurrent4" Forms 10-K, 10-Q, 8-K and DEF 14A – Ordered by date
t="345" Forms 3,4,5,3A,4A,5A,144
t="no345" All forms but Forms 3,4,5,3A,4A,5A,144

ADR Filers – Form Filters

US Filers – Form Filters

Parameter Results Returned
t="20-F" Forms 20-F or 20-F/A
t="20-Fonly" Forms 20-F only
t="6-K" Forms 6-K or 6-K/A
t="6-Konly" Forms 6-K only
t="ircurrent2f" top Form 20-F and top 6-K – Ordered by date
* Other configurations by request

oSEC.iStoryWidth="600"; Content floating div width reduced size: default 600 px
oSEC.iStoryHeight="600"; Content floating div height reduced size: default 600 px
oSEC.iStoryMaxWidth=""; Content floating div width expanded size: default screen size -80 px
oSEC.iStoryMaxHeight=""; Content floating div height expanded size: default screen size -80 px
oSEC.iLeftOffset="0"; Content floating div offset from left: default 0
oSEC.iTopOffset="0"; Content floating div offset from top: default 0