Schema Files

---

Implementation details

Class names

Model name	Parameters class	Data class
SchemaFiles	SchemaFilesQueryParams	SchemaFilesData

Import Statement

from openbb_core.provider.standard_models. import (
SchemaFilesData,
SchemaFilesQueryParams,
)

Parameters

• standard
• sec

taxonomy: Literal['us-gaap', 'srt', 'dei', 'ecd', 'cyd', 'ffd', 'ifrs', 'hmrc-dpl', 'rxp', 'spac', 'cef', 'oef', 'vip', 'fnd', 'sro', 'sbs', 'rocr', 'country', 'currency', 'exch', 'naics', 'sic', 'stpr', 'snj'] | None
Taxonomy family to explore. Omit to list all available taxonomies and their descriptions.

year: int | None
Taxonomy year (e.g. 2011+ for us-gaap, varies by taxonomy). Defaults to the most recent year when omitted.

component: str | None
Presentation component to retrieve. Values are taxonomy-specific. Omit to return all components for the taxonomy.

category: Literal['operating_company', 'investment_company', 'self_regulatory_org', 'sbs_repository', 'nrsro', 'common_reference'] | None
Filter taxonomies by SEC filer category.

Data

• standard
• sec

name: str
Identifier: taxonomy key, year, component name, or XBRL element ID depending on the query mode.

label: str | None
Human-readable label.

description: str | None
Description or long name.

category: str | None
Taxonomy category (e.g., operating_company).

style: str | None
Taxonomy style (e.g., FASB_STANDARD, SEC_EMBEDDED).

has_label_linkbase: bool | None
Whether the taxonomy has a parseable label linkbase.

url: str | None
URL to the taxonomy resource or SEC reference page.

level: int | None
Hierarchy depth in presentation structure (0 = root).

order: float | None
Sort order within parent in presentation structure.

parent_id: str | None
Parent XBRL element ID in presentation structure.

preferred_label: str | None
Preferred label role URI for presentation rendering.

xbrl_type: str | None
XBRL data type (e.g., monetaryItemType, textBlockItemType, stringItemType, sharesItemType, perShareItemType, domainItemType).

period_type: str | None
Period type: 'instant' (point-in-time) or 'duration' (over a period).

balance_type: str | None
Balance type for monetary items: 'credit' or 'debit'.

abstract: bool | None
Whether the element is abstract (grouping/heading only, not taggable).

substitution_group: str | None
XBRL substitution group: 'item' (line item), 'dimensionItem' (axis), 'hypercubeItem' (table).

nillable: bool | None
Whether the element value can be nil.