مستندات Oxtapus#

Oxtapus یک SDK تایپ‌شده و مبتنی بر Polars برای داده‌های بازار مالی ایرانه. داده‌های ابزارهای بورس تهران از TSETMC و تاریخچهٔ ارز و سکه از TGJU به‌شکل polars.DataFrame برمی‌گردن.

مسیر معمول استفاده از نصب و شروع سریع شروع می‌شه. مرجع API پایتون فهرست کامل توابع و متدهای عمومی رو با امضا، ورودی، خروجی، مثال قابل‌کپی و نمونهٔ خروجی ارائه می‌کنه.

یک نمونهٔ کوتاه#

>>> import oxtapus as ox
>>> usd = ox.tgju.daily_prices("دلار", start="1403/10/12")
>>> usd.select("trading_date", "close_price").tail(3)
shape: (3, 2)
┌──────────────┬─────────────┐
│ trading_date ┆ close_price │
│ ---          ┆ ---         │
│ date         ┆ i64         │
╞══════════════╪═════════════╡
│ …            ┆ …           │
└──────────────┴─────────────┘

Note

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

شروع کار

مرجع API پایتون

راهنماها

مرجع داده

Architecture and development (English)