Files
montezdesousa 33d186f8ea [Feature] - Router descriptions (#6288)
* First try

* add routers to reference.json

* fix apploader

* add some router descriptions

* rebuild

* remove pydocstyle fixes

* minor fix

* docstring

* new descriptions

* undo sub routers

---------

Co-authored-by: Henrique Joaquim <henriquecjoaquim@gmail.com>
2024-04-05 11:21:35 +00:00

36 lines
1.0 KiB
Python

"""Crypto 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_crypto.price.price_router import router as price_router
router = Router(prefix="", description="Cryptocurrency market data.")
router.include_router(price_router)
# pylint: disable=unused-argument
@router.command(
model="CryptoSearch",
examples=[
APIEx(parameters={"provider": "fmp"}),
APIEx(parameters={"query": "BTCUSD", "provider": "fmp"}),
],
)
async def search(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Search available cryptocurrency pairs within a provider."""
return await OBBject.from_query(Query(**locals()))