mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 05:52:23 +00:00
4500132aa3
* add historical market cap * add to equity view * chart things * raise not return * pass all kwargs to line_chart * tests.. * docstring * static assets * black * chart integration test --------- Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
117 lines
3.8 KiB
Python
117 lines
3.8 KiB
Python
"""Equity Router."""
|
|
|
|
from openbb_core.app.model.command_context import CommandContext
|
|
from openbb_core.app.model.example import APIEx
|
|
from openbb_core.app.model.obbject import OBBject
|
|
from openbb_core.app.provider_interface import (
|
|
ExtraParams,
|
|
ProviderChoices,
|
|
StandardParams,
|
|
)
|
|
from openbb_core.app.query import Query
|
|
from openbb_core.app.router import Router
|
|
|
|
from openbb_equity.calendar.calendar_router import router as calendar_router
|
|
from openbb_equity.compare.compare_router import router as compare_router
|
|
from openbb_equity.darkpool.darkpool_router import router as darkpool_router
|
|
from openbb_equity.discovery.discovery_router import router as discovery_router
|
|
from openbb_equity.estimates.estimates_router import router as estimates_router
|
|
from openbb_equity.fundamental.fundamental_router import router as fundamental_router
|
|
from openbb_equity.ownership.ownership_router import router as ownership_router
|
|
from openbb_equity.price.price_router import router as price_router
|
|
from openbb_equity.shorts.shorts_router import router as shorts_router
|
|
|
|
router = Router(prefix="", description="Equity market data.")
|
|
router.include_router(calendar_router)
|
|
router.include_router(compare_router)
|
|
router.include_router(estimates_router)
|
|
router.include_router(darkpool_router)
|
|
router.include_router(discovery_router)
|
|
router.include_router(fundamental_router)
|
|
router.include_router(ownership_router)
|
|
router.include_router(price_router)
|
|
router.include_router(shorts_router)
|
|
|
|
# pylint: disable=import-outside-toplevel, W0613:unused-argument
|
|
|
|
|
|
@router.command(
|
|
model="EquitySearch",
|
|
examples=[
|
|
APIEx(parameters={"provider": "intrinio"}),
|
|
APIEx(
|
|
parameters={
|
|
"query": "AAPL",
|
|
"is_symbol": False,
|
|
"use_cache": True,
|
|
"provider": "nasdaq",
|
|
}
|
|
),
|
|
],
|
|
)
|
|
async def search(
|
|
cc: CommandContext,
|
|
provider_choices: ProviderChoices,
|
|
standard_params: StandardParams,
|
|
extra_params: ExtraParams,
|
|
) -> OBBject:
|
|
"""Search for stock symbol, CIK, LEI, or company name."""
|
|
return await OBBject.from_query(Query(**locals()))
|
|
|
|
|
|
@router.command(
|
|
model="EquityScreener", examples=[APIEx(parameters={"provider": "fmp"})]
|
|
)
|
|
async def screener(
|
|
cc: CommandContext,
|
|
provider_choices: ProviderChoices,
|
|
standard_params: StandardParams,
|
|
extra_params: ExtraParams,
|
|
) -> OBBject:
|
|
"""Screen for companies meeting various criteria.
|
|
|
|
These criteria include market cap, price, beta, volume, and dividend yield.
|
|
"""
|
|
return await OBBject.from_query(Query(**locals()))
|
|
|
|
|
|
@router.command(
|
|
model="EquityInfo",
|
|
examples=[APIEx(parameters={"symbol": "AAPL", "provider": "fmp"})],
|
|
)
|
|
async def profile(
|
|
cc: CommandContext,
|
|
provider_choices: ProviderChoices,
|
|
standard_params: StandardParams,
|
|
extra_params: ExtraParams,
|
|
) -> OBBject:
|
|
"""Get general information about a company. This includes company name, industry, sector and price data."""
|
|
return await OBBject.from_query(Query(**locals()))
|
|
|
|
|
|
@router.command(
|
|
model="MarketSnapshots", examples=[APIEx(parameters={"provider": "fmp"})]
|
|
)
|
|
async def market_snapshots(
|
|
cc: CommandContext,
|
|
provider_choices: ProviderChoices,
|
|
standard_params: StandardParams,
|
|
extra_params: ExtraParams,
|
|
) -> OBBject:
|
|
"""Get an updated equity market snapshot. This includes price data for thousands of stocks."""
|
|
return await OBBject.from_query(Query(**locals()))
|
|
|
|
|
|
@router.command(
|
|
model="HistoricalMarketCap",
|
|
examples=[APIEx(parameters={"provider": "fmp", "symbol": "AAPL"})],
|
|
)
|
|
async def historical_market_cap(
|
|
cc: CommandContext,
|
|
provider_choices: ProviderChoices,
|
|
standard_params: StandardParams,
|
|
extra_params: ExtraParams,
|
|
) -> OBBject:
|
|
"""Get the historical market cap of a ticker symbol."""
|
|
return await OBBject.from_query(Query(**locals()))
|