Typed Adapters API Reference#

Specialized regulatory model adapters in nse_xbrl_parser.typed.

Financial Results (Regulation 33)#

class nse_xbrl_parser.typed.financial_results.FinancialResultsModel(*, company_name=None, scrip_code=None, symbol=None, isin=None, industry_type=None, nature_of_report=None, reporting_quarter=None, date_of_start_financial_year=None, date_of_end_financial_year=None, period_start_date=None, period_end_date=None, revenue_from_operations=None, other_income=None, total_income=None, cost_of_materials_consumed=None, purchases_of_stock_in_trade=None, changes_in_inventories=None, employee_benefit_expense=None, finance_costs=None, depreciation_amortization=None, other_expenses=None, total_expenses=None, ebitda=None, profit_before_exceptional_items_and_tax=None, exceptional_items=None, profit_before_tax=None, tax_expense=None, current_tax=None, deferred_tax=None, profit_after_tax=None, other_comprehensive_income=None, total_comprehensive_income=None, basic_eps=None, diluted_eps=None, paid_up_equity_capital=None, face_value=None, reserves_and_surplus=None, net_worth=None, total_assets=None, total_equity_and_liabilities=None, raw_facts_count=0)[source]#

Bases: BaseModel

Normalized, strongly typed representation of NSE/BSE Financial Results filing.

Parameters:

  • company_name (str | None)

  • scrip_code (str | None)

  • symbol (str | None)

  • isin (str | None)

  • industry_type (str | None)

  • nature_of_report (str | None)

  • reporting_quarter (str | None)

  • date_of_start_financial_year (date | None)

  • date_of_end_financial_year (date | None)

  • period_start_date (date | None)

  • period_end_date (date | None)

  • revenue_from_operations (float | None)

  • other_income (float | None)

  • total_income (float | None)

  • cost_of_materials_consumed (float | None)

  • purchases_of_stock_in_trade (float | None)

  • changes_in_inventories (float | None)

  • employee_benefit_expense (float | None)

  • finance_costs (float | None)

  • depreciation_amortization (float | None)

  • other_expenses (float | None)

  • total_expenses (float | None)

  • ebitda (float | None)

  • profit_before_exceptional_items_and_tax (float | None)

  • exceptional_items (float | None)

  • profit_before_tax (float | None)

  • tax_expense (float | None)

  • current_tax (float | None)

  • deferred_tax (float | None)

  • profit_after_tax (float | None)

  • other_comprehensive_income (float | None)

  • total_comprehensive_income (float | None)

  • basic_eps (float | None)

  • diluted_eps (float | None)

  • paid_up_equity_capital (float | None)

  • face_value (float | None)

  • reserves_and_surplus (float | None)

  • net_worth (float | None)

  • total_assets (float | None)

  • total_equity_and_liabilities (float | None)

  • raw_facts_count (int)

company_name: str | None#
scrip_code: str | None#
symbol: str | None#
isin: str | None#
industry_type: str | None#
nature_of_report: str | None#
reporting_quarter: str | None#
date_of_start_financial_year: date | None#
date_of_end_financial_year: date | None#
period_start_date: date | None#
period_end_date: date | None#
revenue_from_operations: float | None#
other_income: float | None#
total_income: float | None#
cost_of_materials_consumed: float | None#
purchases_of_stock_in_trade: float | None#
changes_in_inventories: float | None#
employee_benefit_expense: float | None#
finance_costs: float | None#
depreciation_amortization: float | None#
other_expenses: float | None#
total_expenses: float | None#
ebitda: float | None#
profit_before_exceptional_items_and_tax: float | None#
exceptional_items: float | None#
profit_before_tax: float | None#
tax_expense: float | None#
current_tax: float | None#
deferred_tax: float | None#
profit_after_tax: float | None#
other_comprehensive_income: float | None#
total_comprehensive_income: float | None#
basic_eps: float | None#
diluted_eps: float | None#
paid_up_equity_capital: float | None#
face_value: float | None#
reserves_and_surplus: float | None#
net_worth: float | None#
total_assets: float | None#
total_equity_and_liabilities: float | None#
raw_facts_count: int#
classmethod from_instance(instance)[source]#

Construct a strongly typed FinancialResultsModel from any parsed XBRLInstance.

Parameters:

instance (XBRLInstance)

Return type:

FinancialResultsModel

model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Shareholding Pattern (Regulation 31)#

class nse_xbrl_parser.typed.shareholding.ShareholdingPatternModel(*, company_name=None, scrip_code=None, symbol=None, quarter_ended=None, declaration_quarter=None, promoter_holding_percentage=None, public_holding_percentage=None, non_promoter_non_public_percentage=None, promoter_shares_pledged_percentage=None, categories=<factory>, raw_facts_count=0)[source]#

Bases: BaseModel

Normalized typed representation of Regulation 31 Shareholding Pattern.

Parameters:

  • company_name (str | None)

  • scrip_code (str | None)

  • symbol (str | None)

  • quarter_ended (date | None)

  • declaration_quarter (str | None)

  • promoter_holding_percentage (float | None)

  • public_holding_percentage (float | None)

  • non_promoter_non_public_percentage (float | None)

  • promoter_shares_pledged_percentage (float | None)

  • categories (List[ShareholderCategory])

  • raw_facts_count (int)

company_name: str | None#
scrip_code: str | None#
symbol: str | None#
quarter_ended: date | None#
declaration_quarter: str | None#
promoter_holding_percentage: float | None#
public_holding_percentage: float | None#
non_promoter_non_public_percentage: float | None#
promoter_shares_pledged_percentage: float | None#
categories: List[ShareholderCategory]#
raw_facts_count: int#
classmethod from_instance(instance)[source]#

Construct a strongly typed ShareholdingPatternModel from XBRLInstance.

Parameters:

instance (XBRLInstance)

Return type:

ShareholdingPatternModel

model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nse_xbrl_parser.typed.shareholding.ShareholderCategory(*, category_name, number_of_shareholders=None, number_of_fully_paid_shares=None, total_shares=None, shareholding_percentage=None, voting_rights_percentage=None, shares_pledged_or_encumbered=None, pledge_percentage=None)[source]#

Bases: BaseModel

Holding summary for a shareholder group (Promoter, Public, Non-Promoter).

Parameters:

  • category_name (str)

  • number_of_shareholders (int | None)

  • number_of_fully_paid_shares (int | None)

  • total_shares (int | None)

  • shareholding_percentage (float | None)

  • voting_rights_percentage (float | None)

  • shares_pledged_or_encumbered (int | None)

  • pledge_percentage (float | None)

category_name: str#
number_of_shareholders: int | None#
number_of_fully_paid_shares: int | None#
total_shares: int | None#
shareholding_percentage: float | None#
voting_rights_percentage: float | None#
shares_pledged_or_encumbered: int | None#
pledge_percentage: float | None#
model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Corporate Governance (Regulation 27(2))#

class nse_xbrl_parser.typed.corporate_governance.CorporateGovernanceModel(*, company_name=None, scrip_code=None, symbol=None, reporting_quarter=None, date_of_report=None, has_risk_management_committee=None, directors=<factory>, raw_facts_count=0)[source]#

Bases: BaseModel

Normalized typed representation of Regulation 27(2) Corporate Governance filing.

Parameters:

  • company_name (str | None)

  • scrip_code (str | None)

  • symbol (str | None)

  • reporting_quarter (str | None)

  • date_of_report (date | None)

  • has_risk_management_committee (bool | None)

  • directors (List[DirectorInfo])

  • raw_facts_count (int)

company_name: str | None#
scrip_code: str | None#
symbol: str | None#
reporting_quarter: str | None#
date_of_report: date | None#
has_risk_management_committee: bool | None#
directors: List[DirectorInfo]#
raw_facts_count: int#
classmethod from_instance(instance)[source]#

Construct CorporateGovernanceModel from XBRLInstance.

Parameters:

instance (XBRLInstance)

Return type:

CorporateGovernanceModel

model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nse_xbrl_parser.typed.corporate_governance.DirectorInfo(*, din=None, name=None, category=None, date_of_appointment=None, tenure=None, board_meetings_attended=None)[source]#

Bases: BaseModel

Information for a company director in Corporate Governance report.

Parameters:

  • din (str | None)

  • name (str | None)

  • category (str | None)

  • date_of_appointment (date | None)

  • tenure (float | None)

  • board_meetings_attended (int | None)

din: str | None#
name: str | None#
category: str | None#
date_of_appointment: date | None#
tenure: float | None#
board_meetings_attended: int | None#
model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

On this page
Show Source