File size: 20,975 Bytes
203c118 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 |
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated
class ROUTER_regulators_sec(Container):
"""/regulators/sec
cik_map
filing_headers
htm_file
institutions_search
rss_litigation
schema_files
sic_search
symbol_map
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@exception_handler
@validate
def cik_map(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Map a ticker symbol to a CIK number.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
symbol : str
Symbol to get data for.
use_cache : Optional[bool]
Whether or not to use cache for the request, default is True. (provider: sec)
Returns
-------
OBBject
results : CikMap
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
CikMap
------
cik : Optional[Union[int, str]]
Central Index Key (CIK) for the requested entity.
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.cik_map(symbol='MSFT', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/cik_map",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.cik_map",
("sec",),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def filing_headers(
self,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Download the index headers, and cover page if available, for any SEC filing.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
url : str
URL for the SEC filing. The specific URL is not directly used or downloaded, but is used to generate the base URL for the filing. e.g. https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/coke-20240731.htm and https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/ are both valid URLs for the same filing. (provider: sec)
use_cache : bool
Use cache for the index headers and cover page. Default is True. (provider: sec)
Returns
-------
OBBject
results : SecFiling
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SecFiling
---------
base_url : Optional[str]
Base URL of the filing. (provider: sec)
name : Optional[str]
Name of the entity filing. (provider: sec)
cik : Optional[str]
Central Index Key. (provider: sec)
trading_symbols : Optional[list]
Trading symbols, if available. (provider: sec)
sic : Optional[str]
Standard Industrial Classification. (provider: sec)
sic_organization_name : Optional[str]
SIC Organization Name. (provider: sec)
filing_date : Optional[date]
Filing date. (provider: sec)
period_ending : Optional[date]
Date of the ending period for the filing, if available. (provider: sec)
fiscal_year_end : Optional[str]
Fiscal year end of the entity, if available. Format: MM-DD (provider: sec)
document_type : Optional[str]
Specific SEC filing type. (provider: sec)
has_cover_page : Optional[bool]
True if the filing has a cover page. (provider: sec)
description : Optional[str]
Description of attached content, mostly applicable to 8-K filings. (provider: sec)
cover_page : Optional[dict]
Cover page information, if available. (provider: sec)
document_urls : Optional[list]
list of files associated with the filing. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.filing_headers(url='https://www.sec.gov/Archives/edgar/data/317540/000119312524076556/d645509ddef14a.htm', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/filing_headers",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.filing_headers",
("sec",),
)
},
standard_params={},
extra_params=kwargs,
info={"url": {"sec": {"x-widget_config": {"label": "Filing URL"}}}},
)
)
@exception_handler
@validate
def htm_file(
self,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Download a raw HTML object from the SEC website.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
url : str
URL for the SEC filing. (provider: sec)
use_cache : bool
Cache the file for use later. Default is True. (provider: sec)
Returns
-------
OBBject
results : SecHtmFile
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SecHtmFile
----------
url : Optional[str]
URL of the downloaded file. (provider: sec)
content : Optional[str]
Raw content of the HTM/HTML file. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.htm_file(url='https://www.sec.gov/Archives/edgar/data/1723690/000119312525030074/d866336dex991.htm', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/htm_file",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.htm_file",
("sec",),
)
},
standard_params={},
extra_params=kwargs,
)
)
@exception_handler
@validate
def institutions_search(
self,
query: Annotated[str, OpenBBField(description="Search query.")] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Search SEC-regulated institutions by name and return a list of results with CIK numbers.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
use_cache : Optional[bool]
Whether or not to use cache. (provider: sec)
Returns
-------
OBBject
results : list[InstitutionsSearch]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
InstitutionsSearch
------------------
name : Optional[str]
The name of the institution. (provider: sec)
cik : Optional[Union[int, str]]
Central Index Key (CIK) (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.institutions_search(provider='sec')
>>> obb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/institutions_search",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.institutions_search",
("sec",),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def rss_litigation(
self,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
Returns
-------
OBBject
results : list[RssLitigation]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
RssLitigation
-------------
published : Optional[datetime]
The date of publication. (provider: sec)
title : Optional[str]
The title of the release. (provider: sec)
summary : Optional[str]
Short summary of the release. (provider: sec)
id : Optional[str]
The identifier associated with the release. (provider: sec)
link : Optional[str]
URL to the release. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.rss_litigation(provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/rss_litigation",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.rss_litigation",
("sec",),
)
},
standard_params={},
extra_params=kwargs,
)
)
@exception_handler
@validate
def schema_files(
self,
query: Annotated[str, OpenBBField(description="Search query.")] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Use tool for navigating the directory of SEC XML schema files by year.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
url : Optional[str]
Enter an optional URL path to fetch the next level. (provider: sec)
use_cache : Optional[bool]
Whether or not to use cache. (provider: sec)
Returns
-------
OBBject
results : SchemaFiles
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SchemaFiles
-----------
files : Optional[list[str]]
Dictionary of URLs to SEC Schema Files (provider: sec)
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']
""" # noqa: E501
return self._run(
"/regulators/sec/schema_files",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.schema_files",
("sec",),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def sic_search(
self,
query: Annotated[str, OpenBBField(description="Search query.")] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
use_cache : Optional[bool]
Whether or not to use cache. (provider: sec)
Returns
-------
OBBject
results : list[SicSearch]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SicSearch
---------
sic : Optional[int]
Sector Industrial Code (SIC) (provider: sec)
industry : Optional[str]
Industry title. (provider: sec)
office : Optional[str]
Reporting office within the Corporate Finance Office (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.sic_search(provider='sec')
>>> obb.regulators.sec.sic_search(query='real estate investment trusts', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/sic_search",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.sic_search",
("sec",),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def symbol_map(
self,
query: Annotated[str, OpenBBField(description="Search query.")],
use_cache: Annotated[
Optional[bool],
OpenBBField(
description="Whether or not to use cache. If True, cache will store for seven days."
),
] = True,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Map a CIK number to a ticker symbol, leading 0s can be omitted or included.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
use_cache : Optional[bool]
Whether or not to use cache. If True, cache will store for seven days.
Returns
-------
OBBject
results : SymbolMap
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SymbolMap
---------
symbol : Optional[str]
Symbol representing the entity requested in the data. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.symbol_map(query='0000789019', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/symbol_map",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.symbol_map",
("sec",),
)
},
standard_params={
"query": query,
"use_cache": use_cache,
},
extra_params=kwargs,
)
)
|