available metrics

Author: andrewkittredge

calcbench/__init__.py

@@ -1,4 +1,4 @@
 __version__ = '0.0.7'
 from .api_client import (normalized_data, normalized_dataframe, tickers, set_credentials, 
                          companies, normalized_raw, as_reported_raw, breakouts_raw, companies_raw,
-                         company_disclosures, disclosure_text)
+                         company_disclosures, disclosure_text, available_metrics)

calcbench/api_client.py

@@ -307,9 +307,9 @@ def breakouts_raw(company_identifiers=None, metrics=[], start_year=None,
     return _json_POST('breakouts', payload)
 
 
-def tickers(SIC_codes=[], index=None, company_identifiers=[], universe=False):
+def tickers(SIC_codes=[], index=None, company_identifiers=[], entire_universe=False):
     '''Return a list of tickers in the peer-group'''
-    companies = _companies(SIC_codes, index, company_identifiers, universe)
+    companies = _companies(SIC_codes, index, company_identifiers, entire_universe)
     tickers = [co['ticker'] for co in companies]
     return tickers
 
@@ -360,6 +360,12 @@ def disclosure_text(network_id):
     r = _calcbench_session().get(url, params={'networkID': network_id}, verify=_SESSION_STUFF['ssl_verify'])
     r.raise_for_status()
     return r.json()
+
+def available_metrics():
+    url = _SESSION_STUFF['api_url_base'].format('availableMetrics')
+    r = _calcbench_session().get(url, verify=_SESSION_STUFF['ssl_verify'])
+    r.raise_for_status()
+    return r.json()
 
 if __name__ == '__main__':