jinx package

Submodules

jinx.base module

jinx.exceptions module

exception jinx.exceptions.JinxAuthenticationError(msg)[source]

Bases: Exception

This error is thrown when there is an authentication issue with an IEX cloud request.

exception jinx.exceptions.JinxQueryError(status, response)[source]

Bases: Exception

This error is thrown when an error occurs with the query to IEX, be it a network problem or an invalid query.

exception jinx.exceptions.JinxSymbolError(symbol)[source]

Bases: Exception

This error is thrown when an invalid symbol is given.

jinx.stock module

class jinx.stock.Stock(symbol=None, **kwargs)[source]

Bases: jinx.base._JinxBase

Base class for obtaining data abouot a stock from IEX.

symbol

Ticker symbol

Type:str
get_balance_sheet(period='quarter', last=1)[source]

Pulls balance sheet data. Available quarterly or annually.

Reference: https://iexcloud.io/docs/api/#balance-sheet

Data Weighting: 3000 per symbol per period

Parameters:
  • period (str, default quarter, optional) – Allows you to specify annual or quarterly cash flows. Defaults to quarterly. Values should be annual or quarter.
  • last (int, default 1, optional) – Specify the number of quarters or years to return. One quarter is returned by default. You can specify up to 12 quarters with quarter, or up to 4 years with annual.
Returns:

Stocks Balance Sheet endpoint data
Return type:

dict
get_cash_flow(period='quarter', last=1)[source]

Pulls cash flow data. Available quarterly or annually.

Reference: https://iexcloud.io/docs/api/#cash-flow

Data Weighting: 1000 per symbol per period

Parameters:
  • period (str, default quarter, optional) – Allows you to specify annual or quarterly cash flows. Defaults to quarterly. Values should be annual or quarter.
  • last (int, default 1, optional) – Specify the number of quarters or years to return. One quarter is returned by default. You can specify up to 12 quarters with quarter, or up to 4 years with annual.
Returns:

Stocks Cash Flow endpoint data
Return type:

dict
get_company()[source]

Gets company data about the stock.

Reference: https://iexcloud.io/docs/api/#company

Data Weighting: 1 per symbol

Returns:Company data
Return type:dict
get_income_statement(period='quarter', last=1)[source]

Pulls income statement data. Available quarterly or annually.

Reference: https://iexcloud.io/docs/api/#income-statement

Data Weighting: 1000 per symbol per period

Parameters:
  • period (str, default quarter, optional) – Allows you to specify annual or quarterly cash flows. Defaults to quarterly. Values should be annual or quarter.
  • last (int, default 1, optional) – Specify the number of quarters or years to return. One quarter is returned by default. You can specify up to 12 quarters with quarter, or up to 4 years with annual.
Returns:

Stocks Income Statement endpoint data
Return type:

dict
get_latest_financial_report_date()[source]

Gets report date of latest financial report using data points.

Reference: https://iexcloud.io/docs/api/#data-points

Data Weighting: 1

Returns:Dictionary with one key: latestFinancialReportDate
Return type:dict

Module contents