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

Client اتصال شبکه رو بین درخواست‌ها نگه می‌داره. هر فضای نام (namespace) یک حوزهٔ مشخص از API رو نمایندگی می‌کنه و متدهای ساده و پیشرفتهٔ fetch_... رو کنار هم داره.

Client#

class oxtapus.api.client.Client(settings=None, *, transport=None, storage=None)[source]#

Bases: object

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

Parameters:

  • settings (Settings | None)

  • transport (SyncTransport | None)

  • storage (StorageBackend | None)

close()[source]#

منابع انتقال و ذخیره‌سازی متعلق به کلاینت را می‌بندد.

Return type:

None

property closed: bool#

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

capabilities()[source]#

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

Return type:

tuple[ProviderCapability, …]

MarketNamespace#

class oxtapus.api.client.MarketNamespace(service, settings)[source]#

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

Parameters:

  • service (MarketDataService)

  • settings (Settings)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

InstrumentNamespace#

class oxtapus.api.client.InstrumentNamespace(service, settings)[source]#

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

Parameters:

  • service (InstrumentService)

  • settings (Settings)

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

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

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

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

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

AssetNamespace#

class oxtapus.api.client.AssetNamespace(service, settings)[source]#

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

Parameters:

  • service (AssetPriceService)

  • settings (Settings)

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

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

GovernanceNamespace#

class oxtapus.api.client.GovernanceNamespace(service, settings)[source]#

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

Parameters:

  • service (GovernanceService)

  • settings (Settings)

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

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

IngestionNamespace#

class oxtapus.api.client.IngestionNamespace(service, settings)[source]#

دریافت و ذخیره‌سازی صریح در فضای ذخیره‌سازی تنظیم‌شده.

Parameters:

  • service (IngestionService)

  • settings (Settings)

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

قیمت روزانهٔ symbols را در لایه‌های Bronze و Silver ذخیره می‌کند.

Parameters:

  • symbols (Sequence[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:

IngestionRun

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

دیده‌بان Bronze/Silver و تصویر لحظه‌ای لایهٔ Gold را ذخیره می‌کند.

Parameters:

  • instrument_types (Sequence[str])

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

Return type:

IngestionRun

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

quoteهای اختیار Bronze/Silver و زنجیرهٔ Gold را ذخیره می‌کند.

Parameters:

  • underlying (str)

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

Return type:

IngestionRun