Files
OpenBB/website/content/current/platform/data_models/SchemaFiles.md
andrewkenreich 7d095fcfd2 heheheheheheeh
2023-11-14 10:31:48 -05:00

1.7 KiB
Vendored

title, description
title description
Get lists of SEC XML schema files by year OpenBB Platform Data Model

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_provider.standard_models. import (
SchemaFilesData,
SchemaFilesQueryParams,
)

Parameters

Name Type Description Default Optional
query str Search query. 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
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 Dictionary of URLs to SEC Schema Files