Skip to content

Commit

Permalink
Re-build static prior to version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
piiq committed Dec 19, 2023
1 parent 0da933c commit 7a72359
Show file tree
Hide file tree
Showing 10 changed files with 1,385 additions and 724 deletions.
3 changes: 3 additions & 0 deletions openbb_platform/openbb/package/__extensions__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ class Extensions(Container):
- regulators@1.0.0
- benzinga@1.0.0
- federal_reserve@1.0.0
- finra@1.0.0
- fmp@1.0.0
- fred@1.0.0
- government_us@1.0.0
- intrinio@1.0.0
- oecd@1.0.0
- polygon@1.0.0
Expand Down
292 changes: 10 additions & 282 deletions openbb_platform/openbb/package/economy.py

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions openbb_platform/openbb/package/equity.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ class ROUTER_equity(Container):
"""/equity
/calendar
/compare
/darkpool
/discovery
/estimates
/fundamental
Expand Down Expand Up @@ -45,6 +46,15 @@ def compare(self):

return equity_compare.ROUTER_equity_compare(command_runner=self._command_runner)

@property
def darkpool(self):
# pylint: disable=import-outside-toplevel
from . import equity_darkpool

return equity_darkpool.ROUTER_equity_darkpool(
command_runner=self._command_runner
)

@property
def discovery(self):
# pylint: disable=import-outside-toplevel
Expand Down
91 changes: 91 additions & 0 deletions openbb_platform/openbb/package/equity_darkpool.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###

from typing import List, Literal, Optional, Union

from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated


class ROUTER_equity_darkpool(Container):
"""/equity/darkpool
otc
"""

def __repr__(self) -> str:
return self.__doc__ or ""

@validate
def otc(
self,
symbol: Annotated[
Union[str, List[str]],
OpenBBCustomParameter(description="Symbol to get data for."),
] = None,
provider: Optional[Literal["finra"]] = None,
**kwargs
) -> OBBject:
"""Weekly aggregate trade data for Over The Counter deals.
ATS and non-ATS trading data for each ATS/firm
with trade reporting obligations under FINRA rules.
Parameters
----------
symbol : str
Symbol to get data for.
provider : Optional[Literal['finra']]
The provider to use for the query, by default None.
If None, the provider specified in defaults is selected or 'finra' if there is
no default.
tier : Literal['T1', 'T2', 'OTCE']
"T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products;
T2 - All other NMS stocks; OTC - Over-the-Counter equity securities (provider: finra)
is_ats : bool
ATS data if true, NON-ATS otherwise (provider: finra)
Returns
-------
OBBject
results : List[OTCAggregate]
Serializable results.
provider : Optional[Literal['finra']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra: Dict[str, Any]
Extra info.
OTCAggregate
------------
update_date : date
Most recent date on which total trades is updated based on data received from each ATS/OTC.
share_quantity : float
Aggregate weekly total number of shares reported by each ATS for the Symbol.
trade_quantity : float
Aggregate weekly total number of trades reported by each ATS for the Symbol
Example
-------
>>> from openbb import obb
>>> obb.equity.darkpool.otc()
""" # noqa: E501

return self._run(
"/equity/darkpool/otc",
**filter_inputs(
provider_choices={
"provider": provider,
},
standard_params={
"symbol": ",".join(symbol) if isinstance(symbol, list) else symbol,
},
extra_params=kwargs,
)
)
Loading

0 comments on commit 7a72359

Please sign in to comment.