schema_files

Use tool for navigating the directory of SEC XML schema files by year.

Examples

from openbb import obb
obb.regulators.sec.schema_files(provider='sec')
# Get a list of schema files.
data = obb.regulators.sec.schema_files().results
data.files[0]
'https://xbrl.fasb.org/us-gaap/'
# The directory structure can be navigated by constructing a URL from the 'results' list.
url = data.files[0]+data.files[-1]
# The URL base will always be the 0 position in the list, feed  the URL back in as a parameter.
obb.regulators.sec.schema_files(url=url).results.files
['https://xbrl.fasb.org/us-gaap/2024/'
'USGAAP2024Filelist.xml'
'dis/'
'dqcrules/'
'ebp/'
'elts/'
'entire/'
'meta/'
'stm/'
'us-gaap-2024.zip']

Parameters

• standard
• sec

query: str
Search query.

query: str
Search query.

url: str
Enter an optional URL path to fetch the next level.

use_cache: bool
Default: True
Whether or not to use cache.

---

Returns

results: list[SchemaFiles]

Serializable results.

provider: Optional[Literal['sec']]

Provider name.

warnings: Optional[list[Warning_]]

list of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• sec

files: list[str]
Dictionary of URLs to SEC Schema Files