documentation

Author: andrewkittredge

calcbench/api_client.py

@@ -664,7 +664,7 @@ def face_statement(
     company_identifier,
     statement_type,
     period_type="annual",
-    all_periods=False,
+    all_history=False,
     descending_dates=False,
 ):
     """Face Statements.
@@ -674,7 +674,7 @@ def face_statement(
     
     :param string company_identifier: a ticker or a CIK code, eg 'msft'
     :param string statement_type: one of ('income', 'balance', 'cash', 'change-in-equity', 'comprehensive-income')
-    :param string period_type: 'annual' or 'quarterly'
+    :param string period_type: annual|quarterly|cummulative|combined
     :param string all_periods: get all history or only the last four, True or False.
     :param bool descending_dates: return columns in oldest -> newest order.
         
@@ -720,7 +720,7 @@ def face_statement(
         "companyIdentifier": company_identifier,
         "statementType": statement_type,
         "periodType": period_type,
-        "allPeriods": all_periods,
+        "allPeriods": all_history,
         "descendingDates": descending_dates,
     }
     response = _calcbench_session().get(

docs/html/companies.html

@@ -106,6 +106,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>

docs/html/disclosures.html

@@ -14,7 +14,7 @@
     <script src="_static/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Filings" href="filings.html" />
+    <link rel="next" title="Face Statements" href="face-statements.html" />
     <link rel="prev" title="Numeric Data" href="numeric-data.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -133,6 +133,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
@@ -143,7 +144,7 @@ <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
       <li>Previous: <a href="numeric-data.html" title="previous chapter">Numeric Data</a></li>
-      <li>Next: <a href="filings.html" title="next chapter">Filings</a></li>
+      <li>Next: <a href="face-statements.html" title="next chapter">Face Statements</a></li>
   </ul></li>
 </ul>
 </div>

docs/html/face-statements.html

@@ -14,7 +14,8 @@
     <script src="_static/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Low-latency New Data Notification" href="push-notification.html" />
+    <link rel="next" title="Filings" href="filings.html" />
+    <link rel="prev" title="Disclosures/Text" href="disclosures.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -35,15 +36,15 @@
 <h1>Face Statements<a class="headerlink" href="#face-statements" title="Permalink to this headline">¶</a></h1>
 <dl class="function">
 <dt id="calcbench.face_statement">
-<code class="sig-prename descclassname">calcbench.</code><code class="sig-name descname">face_statement</code><span class="sig-paren">(</span><em class="sig-param">company_identifier</em>, <em class="sig-param">statement_type</em>, <em class="sig-param">period_type='annual'</em>, <em class="sig-param">all_periods=False</em>, <em class="sig-param">descending_dates=False</em><span class="sig-paren">)</span><a class="headerlink" href="#calcbench.face_statement" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">calcbench.</code><code class="sig-name descname">face_statement</code><span class="sig-paren">(</span><em class="sig-param">company_identifier</em>, <em class="sig-param">statement_type</em>, <em class="sig-param">period_type='annual'</em>, <em class="sig-param">all_history=False</em>, <em class="sig-param">descending_dates=False</em><span class="sig-paren">)</span><a class="headerlink" href="#calcbench.face_statement" title="Permalink to this definition">¶</a></dt>
 <dd><p>Face Statements.</p>
 <p>face statements as reported by the filing company</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>company_identifier</strong> (<em>string</em>) – a ticker or a CIK code, eg ‘msft’</p></li>
 <li><p><strong>statement_type</strong> (<em>string</em>) – one of (‘income’, ‘balance’, ‘cash’, ‘change-in-equity’, ‘comprehensive-income’)</p></li>
-<li><p><strong>period_type</strong> (<em>string</em>) – ‘annual’ or ‘quarterly’</p></li>
+<li><p><strong>period_type</strong> (<em>string</em>) – annual|quarterly|cummulative|combined</p></li>
 <li><p><strong>all_periods</strong> (<em>string</em>) – get all history or only the last four, True or False.</p></li>
 <li><p><strong>descending_dates</strong> (<em>bool</em>) – return columns in oldest -&gt; newest order.</p></li>
 </ul>
@@ -129,17 +130,18 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Face Statements</a></li>
 </ul>
 
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="push-notification.html" title="previous chapter">Low-latency New Data Notification</a></li>
+      <li>Previous: <a href="disclosures.html" title="previous chapter">Disclosures/Text</a></li>
+      <li>Next: <a href="filings.html" title="next chapter">Filings</a></li>
   </ul></li>
 </ul>
 </div>

docs/html/filings.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Companies" href="companies.html" />
-    <link rel="prev" title="Disclosures/Text" href="disclosures.html" />
+    <link rel="prev" title="Face Statements" href="face-statements.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -79,6 +79,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
@@ -88,7 +89,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="disclosures.html" title="previous chapter">Disclosures/Text</a></li>
+      <li>Previous: <a href="face-statements.html" title="previous chapter">Face Statements</a></li>
       <li>Next: <a href="companies.html" title="next chapter">Companies</a></li>
   </ul></li>
 </ul>

docs/html/genindex.html

@@ -156,10 +156,10 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
-<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 </ul>
 
 <div class="relations">

docs/html/getting-started.html

@@ -114,6 +114,7 @@ <h3>Navigation</h3>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>

docs/html/index.html

@@ -49,10 +49,10 @@ <h1>Calcbench Python API Client<a class="headerlink" href="#calcbench-python-api
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
-<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 </ul>
 </div>
 <div class="section" id="examples">
@@ -82,10 +82,10 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
-<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 </ul>
 
 <div class="relations">

docs/html/numeric-data.html

@@ -230,6 +230,7 @@ <h3>Navigation</h3>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>

docs/html/search.html

@@ -79,10 +79,10 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="numeric-data.html">Numeric Data</a></li>
 <li class="toctree-l1"><a class="reference internal" href="disclosures.html">Disclosures/Text</a></li>
+<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="filings.html">Filings</a></li>
 <li class="toctree-l1"><a class="reference internal" href="companies.html">Companies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="push-notification.html">Low-latency New Data Notification</a></li>
-<li class="toctree-l1"><a class="reference internal" href="face-statements.html">Face Statements</a></li>
 </ul>
 
 <div class="relations">