کلاینت ناهمگام#

AsyncClient همتای ناهمگام کلاینت همگامه. Oxtapus حلقهٔ رویداد (event loop) رو نمی‌سازه و کنترل نمی‌کنه؛ متدها رو داخل حلقهٔ رویداد برنامه یا با await مستقیم Jupyter صدا بزن.

>>> from oxtapus import AsyncClient
>>> async with AsyncClient() as client:
...     usd = await client.assets.history("دلار")

AsyncClient#

class oxtapus.api.async_client.AsyncClient(settings=None, *, transport=None)[source]#

Bases: object

کلاینت ناهمگام با اتصال قابل‌استفادهٔ مجدد و فضاهای نام عمومی.

Parameters:

  • settings (Settings | None)

  • transport (AsyncTransport | None)

async aclose()[source]#

منابع انتقال متعلق به کلاینت را می‌بندد.

Return type:

None

property closed: bool#

اگر کلاینت بسته شده باشد True برمی‌گرداند.

capabilities()[source]#

قابلیت‌های تأییدشدهٔ فراهم‌کننده‌ها را بدون درخواست شبکه برمی‌گرداند.

Return type:

tuple[ProviderCapability, …]

AsyncMarketNamespace#

class oxtapus.api.async_client.AsyncMarketNamespace(service, settings)[source]#

متدهای ناهمگام قیمت، تابلو، سفارش‌ها و بازار.

Parameters:

  • service (AsyncMarketDataService)

  • settings (Settings)

async daily_prices(symbols, start=None, end=None, *, adjusted=False, progress=None)[source]#

برای symbols در بازهٔ تاریخ، دیتافریم قیمت روزانه برمی‌گرداند.

Parameters:

  • symbols (Sequence[str])

  • start (date | str | None)

  • end (date | str | None)

  • adjusted (bool)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_daily_prices(symbols, start=None, end=None, *, adjusted=False, progress=None)[source]#

قیمت روزانه را همراه فرادادهٔ کامل عملیاتی برمی‌گرداند.

Parameters:

  • symbols (Sequence[str])

  • start (date | str | None)

  • end (date | str | None)

  • adjusted (bool)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async market_watch(instrument_types=('equity', 'etf'), *, progress=None)[source]#

برای نوع ابزارهای خواسته‌شده، آخرین تصویر لحظه‌ای بازار را برمی‌گرداند.

Parameters:

  • instrument_types (Sequence[str])

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_market_watch(instrument_types=('equity', 'etf'), *, progress=None)[source]#

تصویر لحظه‌ای بازار را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • instrument_types (Sequence[str])

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async quote(identifier, *, progress=None)[source]#

برای identifier، دیتافریم تک‌ردیفی آخرین اطلاعات تابلو را برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_quote(identifier, *, progress=None)[source]#

اطلاعات تابلو را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async market_depth(identifier, *, progress=None)[source]#

برای identifier، حداکثر پنج سطح فعلی دفتر سفارش‌ها را برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_market_depth(identifier, *, progress=None)[source]#

سطح‌های دفتر سفارش‌ها را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async investor_activity(identifier, *, progress=None)[source]#

آمار فعلی خرید و فروش حقیقی و حقوقی identifier را برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_investor_activity(identifier, *, progress=None)[source]#

آمار حقیقی/حقوقی را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async option_chain(underlying, *, progress=None)[source]#

برای underlying، یک ردیف استاندارد برای هر قرارداد اختیار برمی‌گرداند.

Parameters:

  • underlying (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_option_chain(underlying, *, progress=None)[source]#

قراردادهای اختیار را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • underlying (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

AsyncInstrumentNamespace#

class oxtapus.api.async_client.AsyncInstrumentNamespace(service, settings)[source]#

متدهای ناهمگام جست‌وجو، هویت و اطلاعات ابزار.

Parameters:

  • service (AsyncInstrumentService)

  • settings (Settings)

async search(term, *, progress=None)[source]#

ابزارهای منطبق با term را در یک دیتافریم برمی‌گرداند.

Parameters:

  • term (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

نتیجهٔ جست‌وجو را همراه فرادادهٔ منبع برمی‌گرداند.

Parameters:

  • term (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async info(identifier, *, progress=None)[source]#

داده‌های پایهٔ نماد یا ابزار معاملاتی را برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_info(identifier, *, progress=None)[source]#

اطلاعات ابزار را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

async identity(identifier, *, progress=None)[source]#

هویت، بازار، صنعت و زیرصنعت identifier را برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_identity(identifier, *, progress=None)[source]#

هویت ابزار را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

AsyncAssetNamespace#

class oxtapus.api.async_client.AsyncAssetNamespace(service, settings)[source]#

متدهای ناهمگام تاریخچهٔ ارز و سکه.

Parameters:

  • service (AsyncAssetPriceService)

  • settings (Settings)

async history(asset, start=None, end=None, *, progress=None)[source]#

برای asset و بازهٔ تاریخ، دیتافریم روزانهٔ OHLC برمی‌گرداند.

Parameters:

  • asset (str)

  • start (date | str | None)

  • end (date | str | None)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_history(asset, start=None, end=None, *, progress=None)[source]#

تاریخچهٔ دارایی را همراه فرادادهٔ منبع، کیفیت، تلاش‌های مجدد و lineage برمی‌گرداند.

Parameters:

  • asset (str)

  • start (date | str | None)

  • end (date | str | None)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult

AsyncGovernanceNamespace#

class oxtapus.api.async_client.AsyncGovernanceNamespace(service, settings)[source]#

متدهای ناهمگام افشاهای راهبری شرکتی.

Parameters:

  • service (AsyncGovernanceService)

  • settings (Settings)

async board_members(identifier, *, progress=None)[source]#

تاریخچهٔ اعضای هیئت‌مدیرهٔ identifier را به‌شکل تخت برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

DataFrame

async fetch_board_members(identifier, *, progress=None)[source]#

تاریخچهٔ هیئت‌مدیره را همراه فرادادهٔ عملیاتی برمی‌گرداند.

Parameters:

  • identifier (str)

  • progress (bool | ProgressReporter | Callable[[OperationStarted | TransferStarted | TransferAdvanced | ItemStarted | RetryScheduled | ItemCompleted | ItemFailed | OperationCompleted | OperationCancelled], None] | None)

Return type:

FetchResult