Files
OpenBB/website/content/platform/data_models/SchemaFiles.md

1.9 KiB
Vendored

title, description
title description
Schema Files A tool for navigating the directory of SEC XML schema files by year

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';


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

Name Type Description Default Optional
query str Search query. True
use_cache bool Whether or not to use cache. If True, cache will store for seven days. True True
provider Literal['sec'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. sec True
Name Type Description Default Optional
query str Search query. True
use_cache bool Whether or not to use cache. If True, cache will store for seven days. True True
provider Literal['sec'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. sec True
url str Enter an optional URL path to fetch the next level. None True

Data

Name Type Description
Name Type Description
files List[str] Dictionary of URLs to SEC Schema Files