iex_api.model package

Submodules

iex_api.model.ca module

class iex_api.model.ca.AdvancedDividend(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], symbol: str, ex_date: datetime.date, record_date: datetime.date, payment_date: datetime.date, announce_date: datetime.date, currency: str, frequency: str, amount: float, description: str, flag: str, security_type: str, notes: str, figi: str, last_updated: datetime.date, country_code: str, par_value: str, par_valueCurrency: str, net_amount: float, gross_amount: float, marker: str, tax_rate: float, from_factor: float, to_factor: float, adr_fee: float, coupon: float, declared_currency_CD: str, declared_gross_amount: float, is_net_investment_income: bool, is_DAP: bool, is_approximate: bool, fx_date: datetime.date, second_payment_date: datetime.date, second_ex_date: datetime.date, fiscal_year_end_date: datetime.date, period_end_date: datetime.date, optional_election_date: datetime.date, to_date: datetime.date, registration_date: datetime.date, installment_pay_date: datetime.date, declared_date: datetime.date, refid: int, created: datetime.date)

Bases: iex_api.model.common.IEXTimeSeriesObject

ID = 'ADVANCED_DIVIDENDS'

adr_fee: float = None

amount: float = None

announce_date: datetime.date = None

country_code: str = None

coupon: float = None

created: datetime.date = None

currency: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

declared_currency_CD: str = None

declared_date: datetime.date = None

declared_gross_amount: float = None

description: str = None

ex_date: datetime.date = None

figi: str = None

fiscal_year_end_date: datetime.date = None

flag: str = None

frequency: str = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

from_factor: float = None

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

fx_date: datetime.date = None

gross_amount: float = None

installment_pay_date: datetime.date = None

is_DAP: bool = None

is_approximate: bool = None

is_net_investment_income: bool = None

last_updated: datetime.date = None

marker: str = None

net_amount: float = None

notes: str = None

optional_election_date: datetime.date = None

par_value: str = None

par_valueCurrency: str = None

payment_date: datetime.date = None

period_end_date: datetime.date = None

record_date: datetime.date = None

refid: int = None

registration_date: datetime.date = None

classmethod schema()

second_ex_date: datetime.date = None

second_payment_date: datetime.date = None

security_type: str = None

symbol: str = None

tax_rate: float = None

to_date: datetime.date = None

to_dict()

to_factor: float = None

to_json()

class iex_api.model.ca.BasicDividend(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], amount: float, currency: str, declared_date: datetime.date, description: str, ex_date: datetime.date, flag: str, frequency: str, payment_date: datetime.date, record_date: datetime.date, refid: int, symbol: str)

Bases: iex_api.model.common.IEXTimeSeriesObject

ID = 'DIVIDENDS'

amount: float = None

currency: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

declared_date: datetime.date = None

description: str = None

ex_date: datetime.date = None

flag: str = None

frequency: str = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

payment_date: datetime.date = None

record_date: datetime.date = None

refid: int = None

classmethod schema()

symbol: str = None

to_dict()

to_json()

iex_api.model.common module

class iex_api.model.common.IEXBaseMixin

Bases: object

classmethod api()

class iex_api.model.common.IEXTimeSeriesObject(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date])

Bases: iex_api.model.common.IEXBaseMixin

async classmethod all(key: str, sub_key: str = None, output_constructor=<class 'list'>)

dataclass_json_config = {'letter_case': <function camelcase>}

date: Optional[datetime.date] = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: str = None

key: str = None

async classmethod latest(key: str, sub_key: str = None, n: int = 1, output_constructor=<class 'list'>)

classmethod schema()

async classmethod series(key: str, sub_key: str, request: iex_api.api.model.model.TimeSeriesRequest = None, output_constructor=<class 'list'>)

source: Optional[str] = None

sub_key: Optional[str] = None

to_dict()

to_json()

updated: Optional[datetime.date] = None

class iex_api.model.common.Symbol(symbol: str, exchange: str, name: str, date: datetime.date, type: str, iex_id: str, region: str, currency: str, is_enabled: bool)

Bases: iex_api.model.common.IEXBaseMixin

currency: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

date: datetime.date = None

exchange: str = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

async classmethod get_all_symbols_for_region()

iex_id: str = None

is_enabled: bool = None

name: str = None

region: str = None

classmethod schema()

symbol: str = None

to_dict()

to_json()

type: str = None

class iex_api.model.common.SymbolMixin

Bases: iex_api.model.common.IEXBaseMixin

async classmethod from_symbol(symbol: str, *args, **kwargs)

async classmethod from_symbols()

iex_api.model.company module

class iex_api.model.company.AdvancedStats(company_name: str, marketcap: int, week52high: float, week52low: float, week52change: float, shares_outstanding: float, avg10_volume: int, avg30_volume: int, day200_moving_avg: int, day50_moving_avg: int, employees: int, ttmEPS: float, ttm_dividend_rate: float, dividend_yield: float, next_dividend_date: datetime.date, ex_dividend_date: datetime.date, next_earnings_date: datetime.date, pe_ratio: float, beta: float, max_change_percent: float, year5_change_percent: float, year2_change_percent: float, year1_change_percent: float, ytd_change_percent: float, month6_change_percent: float, month3_change_percent: float, month1_change_percent: float, day30Change_percent: float, day5Change_percent: float, total_cash: int, current_debt: int, revenue: int, gross_profit: int, total_revenue: int, EBITDA: int, revenue_per_share: float, revenue_per_employee: float, debt_to_equity: float, profit_margin: float, enterprise_value: int, enterprise_value_to_revenue: float, price_to_sales: float, price_to_book: float, forward_PERatio: float, peg_patio: float, pe_high: float, pe_low: float, week52high_date: datetime.date, week52low_date: datetime.date, put_call_ratio: float)

Bases: iex_api.model.company.KeyStats

EBITDA: int = None

PATH = 'advanced-stats'

current_debt: int = None

dataclass_json_config = {'letter_case': <function camelcase>}

debt_to_equity: float = None

enterprise_value: int = None

enterprise_value_to_revenue: float = None

forward_PERatio: float = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

gross_profit: int = None

pe_high: float = None

pe_low: float = None

peg_patio: float = None

price_to_book: float = None

price_to_sales: float = None

profit_margin: float = None

put_call_ratio: float = None

revenue: int = None

revenue_per_employee: float = None

revenue_per_share: float = None

classmethod schema()

to_dict()

to_json()

total_cash: int = None

total_revenue: int = None

week52high_date: datetime.date = None

week52low_date: datetime.date = None

class iex_api.model.company.CashFlow(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], capital_expenditures: int, cash_change: int, cash_flow: int, cash_flow_financing: int, changes_in_inventories: int, changes_in_receivables: int, currency: str, depreciation: int, dividends_paid: int, exchange_rate_effect: int, fiscal_date: datetime.date, investing_activity_other: int, investments: int, net_borrowings: int, net_income: int, other_financing_cash_flows: int, report_date: datetime.date, symbol: str, total_investing_cash_flows: int)

Bases: iex_api.model.common.IEXTimeSeriesObject

ID = 'CASH_FLOW'

capital_expenditures: int = None

cash_change: int = None

cash_flow: int = None

cash_flow_financing: int = None

changes_in_inventories: int = None

changes_in_receivables: int = None

currency: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

depreciation: int = None

dividends_paid: int = None

exchange_rate_effect: int = None

fiscal_date: datetime.date = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

investing_activity_other: int = None

investments: int = None

net_borrowings: int = None

net_income: int = None

other_financing_cash_flows: int = None

report_date: datetime.date = None

classmethod schema()

symbol: str = None

to_dict()

to_json()

total_investing_cash_flows: int = None

class iex_api.model.company.Company(symbol: str, company_name: str, exchange: str, industry: str, website: str, description: str, CEO: str, security_name: str, issue_type: str, sector: str, primary_sic_code: int, employees: int, tags: List[str], address: str, address2: Optional[str], state: str, city: str, zip: str, country: str, phone: str)

Bases: iex_api.model.common.SymbolMixin

CEO: str = None

PATH = 'company'

address: str = None

address2: Optional[str] = None

city: str = None

company_name: str = None

country: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

description: str = None

employees: int = None

exchange: str = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

industry: str = None

issue_type: str = None

phone: str = None

primary_sic_code: int = None

classmethod schema()

sector: str = None

security_name: str = None

state: str = None

symbol: str = None

tags: List[str] = None

to_dict()

to_json()

website: str = None

zip: str = None

class iex_api.model.company.Financials(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], EBITDA: int, accounts_payable: int, capital_surplus: int, cash_change: int, cash_flow: int, cash_flow_financing: int, changes_in_inventories: int, changes_in_receivables: int, common_stock: int, cost_of_revenue: int, currency: str, current_assets: int, current_cash: int, current_debt: int, current_long_term_debt: int, depreciation: int, dividends_paid: int, ebit: int, exchange_rate_effect: int, fiscal_date: datetime.date, goodwill: int, gross_profit: int, income_tax: int, intangible_assets: int, interest_income: int, inventory: int, investing_activity_other: int, investments: int, longTerm_debt: int, longTerm_investments: int, minority_interest: int, net_borrowings: int, net_income: int, net_income_basic: int, net_tangible_assets: int, operating_expense: int, operating_income: int, operating_revenue: int, other_assets: int, other_current_assets: int, other_current_liabilities: int, other_income_expense_net: int, other_liabilities: int, pretax_income: int, property_plant_equipment: int, receivables: int, report_date: datetime.date, research_and_development: int, retained_earnings: int, revenue: int, selling_general_and_admin: int, shareholder_equity: int, shortTerm_debt: int, shortTerm_investments: int, symbol: str, total_assets: int, total_cash: int, total_debt: int, total_investing_cash_flows: int, total_liabilities: int, total_revenue: int, treasury_stock: int)

Bases: iex_api.model.common.IEXTimeSeriesObject

EBITDA: int = None

ID = 'FINANCIALS'

accounts_payable: int = None

capital_surplus: int = None

cash_change: int = None

cash_flow: int = None

cash_flow_financing: int = None

changes_in_inventories: int = None

changes_in_receivables: int = None

common_stock: int = None

cost_of_revenue: int = None

currency: str = None

current_assets: int = None

current_cash: int = None

current_debt: int = None

current_long_term_debt: int = None

dataclass_json_config = {'letter_case': <function camelcase>}

depreciation: int = None

dividends_paid: int = None

ebit: int = None

exchange_rate_effect: int = None

fiscal_date: datetime.date = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

goodwill: int = None

gross_profit: int = None

income_tax: int = None

intangible_assets: int = None

interest_income: int = None

inventory: int = None

investing_activity_other: int = None

investments: int = None

longTerm_debt: int = None

longTerm_investments: int = None

minority_interest: int = None

net_borrowings: int = None

net_income: int = None

net_income_basic: int = None

net_tangible_assets: int = None

operating_expense: int = None

operating_income: int = None

operating_revenue: int = None

other_assets: int = None

other_current_assets: int = None

other_current_liabilities: int = None

other_income_expense_net: int = None

other_liabilities: int = None

pretax_income: int = None

property_plant_equipment: int = None

receivables: int = None

report_date: datetime.date = None

research_and_development: int = None

retained_earnings: int = None

revenue: int = None

classmethod schema()

selling_general_and_admin: int = None

shareholder_equity: int = None

shortTerm_debt: int = None

shortTerm_investments: int = None

symbol: str = None

to_dict()

to_json()

total_assets: int = None

total_cash: int = None

total_debt: int = None

total_investing_cash_flows: int = None

total_liabilities: int = None

total_revenue: int = None

treasury_stock: int = None

class iex_api.model.company.Income(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], report_date: datetime.date, fiscal_date: datetime.date, currency: str, total_revenue: int, cost_of_revenue: int, gross_profit: int, research_and_development: int, selling_general_and_admin: int, operating_expense: int, operating_income: int, other_income_expense_net: int, ebit: int, interest_income: int, pretax_income: int, income_tax: int, minority_interest: int, net_income: int, net_incomeBasic: int)

Bases: iex_api.model.common.IEXTimeSeriesObject

ID = 'INCOME'

cost_of_revenue: int = None

currency: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

ebit: int = None

fiscal_date: datetime.date = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

gross_profit: int = None

income_tax: int = None

interest_income: int = None

minority_interest: int = None

net_income: int = None

net_incomeBasic: int = None

operating_expense: int = None

operating_income: int = None

other_income_expense_net: int = None

pretax_income: int = None

report_date: datetime.date = None

research_and_development: int = None

classmethod schema()

selling_general_and_admin: int = None

to_dict()

to_json()

total_revenue: int = None

class iex_api.model.company.KeyStats(company_name: str, marketcap: int, week52high: float, week52low: float, week52change: float, shares_outstanding: float, avg10_volume: int, avg30_volume: int, day200_moving_avg: int, day50_moving_avg: int, employees: int, ttmEPS: float, ttm_dividend_rate: float, dividend_yield: float, next_dividend_date: datetime.date, ex_dividend_date: datetime.date, next_earnings_date: datetime.date, pe_ratio: float, beta: float, max_change_percent: float, year5_change_percent: float, year2_change_percent: float, year1_change_percent: float, ytd_change_percent: float, month6_change_percent: float, month3_change_percent: float, month1_change_percent: float, day30Change_percent: float, day5Change_percent: float)

Bases: iex_api.model.common.SymbolMixin

PATH = 'stats'

avg10_volume: int = None

avg30_volume: int = None

beta: float = None

company_name: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

day200_moving_avg: int = None

day30Change_percent: float = None

day50_moving_avg: int = None

day5Change_percent: float = None

dividend_yield: float = None

employees: int = None

ex_dividend_date: datetime.date = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

marketcap: int = None

max_change_percent: float = None

month1_change_percent: float = None

month3_change_percent: float = None

month6_change_percent: float = None

next_dividend_date: datetime.date = None

next_earnings_date: datetime.date = None

pe_ratio: float = None

classmethod schema()

shares_outstanding: float = None

to_dict()

to_json()

ttmEPS: float = None

ttm_dividend_rate: float = None

week52change: float = None

week52high: float = None

week52low: float = None

year1_change_percent: float = None

year2_change_percent: float = None

year5_change_percent: float = None

ytd_change_percent: float = None

class iex_api.model.company.Logo(url: str)

Bases: iex_api.model.common.SymbolMixin

PATH = 'logo'

dataclass_json_config = {'letter_case': <function camelcase>}

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema()

to_dict()

to_json()

url: str = None

iex_api.model.options module

class iex_api.model.options.EndOfDayOptions(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], ask: float, bid: float, cfi_code: str, close: float, closing_price: float, contract_description: str, contract_name: str, contract_size: int, currency: str, exchange_code: str, exchange_MIC: str, exercise_style: str, expiration_date: datetime.date, figi: str, high: float, is_adjusted: bool, last_trade_date: datetime.date, last_trade_time: datetime.time, last_updated: datetime.date, low: float, margin_price: float, open: float, open_interest: int, settlement_price: float, side: str, strike_price: float, symbol: str, type: str, volume: int)

Bases: iex_api.model.common.IEXTimeSeriesObject

ask: float = None

bid: float = None

cfi_code: str = None

close: float = None

closing_price: float = None

contract_description: str = None

contract_name: str = None

contract_size: int = None

currency: str = None

dataclass_json_config = {'letter_case': <function camelcase>}

exchange_MIC: str = None

exchange_code: str = None

exercise_style: str = None

expiration_date: datetime.date = None

figi: str = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

high: float = None

is_adjusted: bool = None

last_trade_date: datetime.date = None

last_trade_time: datetime.time = None

last_updated: datetime.date = None

async classmethod latest()

low: float = None

margin_price: float = None

open: float = None

open_interest: int = None

classmethod schema()

settlement_price: float = None

side: str = None

strike_price: float = None

symbol: str = None

to_dict()

to_json()

type: str = None

volume: int = None

iex_api.model.stocks module

class iex_api.model.stocks.HistoricalStockPrice(id: str, key: str, source: Optional[str], sub_key: Optional[str], date: Optional[datetime.date], updated: Optional[datetime.date], symbol: str, close: float, high: float, low: float, open: float, volume: int, change_over_time: float, market_change_over_time: float, u_open: Optional[float], u_close: Optional[float], u_high: Optional[float], u_low: Optional[float], u_volume: Optional[int], f_open: Optional[float], f_close: Optional[float], f_high: Optional[float], f_flow: Optional[float], f_volume: Optional[int], label: str, change: Optional[float], change_percent: Optional[float])

Bases: iex_api.model.common.IEXTimeSeriesObject, iex_api.model.common.SymbolMixin

change: Optional[float] = None

change_over_time: float = None

change_percent: Optional[float] = None

close: float = None

dataclass_json_config = {'letter_case': <function camelcase>}

f_close: Optional[float] = None

f_flow: Optional[float] = None

f_high: Optional[float] = None

f_open: Optional[float] = None

f_volume: Optional[int] = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

async classmethod from_symbol(symbol: str, range: iex_api.api.model.model.IEXRange, **kwargs) → iex_api.model.stocks.HistoricalStockPrice

high: float = None

label: str = None

low: float = None

market_change_over_time: float = None

open: float = None

classmethod schema()

symbol: str = None

to_dict()

to_json()

u_close: Optional[float] = None

u_high: Optional[float] = None

u_low: Optional[float] = None

u_open: Optional[float] = None

u_volume: Optional[int] = None

volume: int = None

class iex_api.model.stocks.IntraDayStockPrice(date: datetime.date, minute: datetime.time, market_average: float, market_number_of_trades: int, market_open: float, market_close: float, market_high: float, market_low: float, market_volume: int, market_change_over_time: float, change_over_time: float, label: str)

Bases: object

change_over_time: float = None

dataclass_json_config = {'letter_case': <function camelcase>}

date: datetime.date = None

classmethod from_dict(kvs: Union[dict, list, str, int, float, bool, None], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

label: str = None

market_average: float = None

market_change_over_time: float = None

market_close: float = None

market_high: float = None

market_low: float = None

market_number_of_trades: int = None

market_open: float = None

market_volume: int = None

minute: datetime.time = None

classmethod schema()

to_dict()

to_json()

Module contents