59 Commits
Author SHA1 Message Date
mtrshirazi21 22f8ea17d6 update version 2026-02-05 01:06:23 +03:30
mtrshirazi21 440c7947cc Function constructor variable modifications 2026-02-05 01:03:30 +03:30
mtrshirazi21 312f230b08 Updating the structure and design in EMS 2026-02-05 00:57:34 +03:30
mtrshirazi21 aa4d4bbabb define Retriable Client & edit name class EmsEngine_TseIfb_AsyncClient 2026-01-20 20:47:57 +03:30
mtrshirazi21 569a36edaa edit versions 2026-01-12 22:41:39 +03:30
mtrshirazi21 6b5e8ece84 del property -> order is valid from oeder class 2026-01-12 21:18:18 +03:30
mtrshirazi21 74f2a1e857 debug to create new order class & del property -> order is valid from oeder class 2026-01-12 21:16:57 +03:30
mtrshirazi21 870d660130 update OrderStatus TypedDict -> fild: order_status 2026-01-12 21:15:24 +03:30
mtrshirazi21 4de7e9b60a update and define status in EmsEngine sync ans async client 2025-12-29 18:25:44 +03:30
mtrshirazi21 d96a32165d update pyproject.toml to pre-release from pypi 2025-12-29 15:51:05 +03:30
mtrshirazi21 1d8fa8aac9 edit coment on syncclient and update AsyncClient 2025-12-28 00:57:04 +03:30
mtrshirazi21 cb65c00066 edit order 2025-12-27 12:51:11 +03:30
mtrshirazi21 02b63bc08e add new func 2025-12-27 11:47:05 +03:30
mtrshirazi21 b04d690189 add EmsEngine tseifb async and sync -- client 2025-12-26 16:22:27 +03:30
mtrshirazi21 3e2dbfd381 define EmsEngine 2025-12-25 16:23:49 +03:30
mtrshirazi21 a592139f25 upgrade version 2025-11-21 18:41:27 +03:30
mtrshirazi21 ad75e49165 edit dependencies 2025-11-21 18:01:18 +03:30
mtrshirazi21 98938e074b update Readme 2025-11-21 17:38:02 +03:30
mtrshirazi21 c1bad73a1f edit readme 2025-11-21 16:37:57 +03:30
mtrshirazi21 e2c69bd3af edit readme 2025-11-21 16:30:25 +03:30
mtrshirazi21 3012cba332 edit readme.md 2025-11-21 16:17:53 +03:30
mtrshirazi21 785f5ead28 edit redme 2025-11-21 16:14:45 +03:30
mtrshirazi21 8ee4a0ad9b edit toml file for new version 2025-11-21 16:09:07 +03:30
mtrshirazi21 0bda01a33e add readme 2025-11-21 16:00:08 +03:30
mtrshirazi21 82fb01c8be edit doc 2025-11-21 15:49:32 +03:30
mtrshirazi21 aff75d2175 edit 2025-11-21 15:34:09 +03:30
mtrshirazi21 ebc7f080b2 update readme 2025-11-21 15:24:56 +03:30
mtrshirazi21 7198bb5ba7 add doc to sync client 2025-11-21 15:11:55 +03:30
mtrshirazi21 929a3d95f0 edit doc 2025-11-21 01:02:12 +03:30
mtrshirazi21 4b4db162ec add doc to async client 2025-11-21 01:00:21 +03:30
mtrshirazi21 b802599674 add doc to auth app 2025-11-20 23:57:48 +03:30
mtrshirazi21 d8deba13e8 add doc to type class 2025-11-20 23:53:34 +03:30
mtrshirazi21 0218899d5a add close to ws 2025-11-19 21:01:29 +03:30
mtrshirazi21 5a72ba634f add websocket to sync client 2025-11-19 20:54:34 +03:30
mtrshirazi21 937ebd2eac add websocket func in async client 2025-11-19 20:25:08 +03:30
mtrshirazi21 fa3712a7d5 add OHLCV live 2025-11-19 19:54:49 +03:30
mtrshirazi21 57db8d7c79 define more types for ws 2025-11-19 16:14:15 +03:30
mtrshirazi21 a2a6b16aba edit sync Client 2025-11-19 15:38:37 +03:30
mtrshirazi21 a26dc814ea edit response 2025-11-19 14:06:00 +03:30
mtrshirazi21 a151a22f7b edit req types 2025-11-19 10:33:25 +03:30
mtrshirazi21 aaadfcd3cd edit types 2025-11-19 01:03:47 +03:30
mtrshirazi21 0c6278c6dc add historical data handler fron sync and async client 2025-11-19 00:15:21 +03:30
mtrshirazi21 972217337a add more types 2025-11-18 23:20:51 +03:30
mtrshirazi21 56f0f0389e define req func in async and sync client 2025-11-18 21:43:54 +03:30
mtrshirazi21 cf40d7200a del init py file fron root 2025-11-18 21:43:13 +03:30
mtrshirazi21 822b4a67c2 edit io types 2025-11-18 20:54:45 +03:30
mtrshirazi21 bb9adb77ee define type 2025-11-18 20:48:37 +03:30
mtrshirazi21 8132c73110 define Get_instruments_by_isin 2025-11-18 20:35:02 +03:30
mtrshirazi21 2657d0f4f6 edit calss name 2025-11-18 20:28:52 +03:30
mtrshirazi21 885644c0c7 define DataEngine_TseIfb sync and async client class 2025-11-18 19:52:07 +03:30
mtrshirazi21 98d98c09ab append * to all test py file 2025-11-18 19:49:49 +03:30
mtrshirazi21 9560e764b6 edit auth calss 2025-11-18 19:23:06 +03:30
mtrshirazi21 d834a4a00a edit auth calss 2025-11-18 18:33:48 +03:30
mtrshirazi21 45a01ff7f6 define auth class 2025-11-18 15:49:53 +03:30
mtrshirazi21 27dbc4cb36 add test 2025-11-18 11:42:04 +03:30
mtrshirazi21 6797cfe325 update pyproject.toml 2025-11-18 10:24:30 +03:30
mtrshirazi21 3e6688cc70 rename auth 2025-11-18 00:33:57 +03:30
mtrshirazi21 8e54971730 auth 2025-11-18 00:33:21 +03:30
mtrshirazi21 8d38af517e define DataEngine tse-ifb Structure 2025-11-17 12:26:36 +03:30
22 changed files with 7303 additions and 11 deletions

No files matched your search

+2 -1
View File
@@ -207,4 +207,5 @@ marimo/_lsp/
__marimo__/
*.env*
*.ipynb
requirements.txt
requirements.txt
*test*.py
+154
View File
@@ -0,0 +1,154 @@
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from .__utils import RetriableAsyncClient
from httpx import (
AsyncClient ,
Timeout ,
)
from jwt import decode
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class AuthAsyncClient:
"""
Asynchronous client for interacting with the HedgeTech API using JWT-based authentication.
This class provides a high-level interface to authenticate users, manage JWT tokens,
and make authorized HTTP requests using an `httpx.AsyncClient`.
Attributes:
httpx_Client (AsyncClient): An instance of `httpx.AsyncClient` configured with authentication headers.
token (dict[str, str]): Dictionary containing authentication tokens, typically including 'Authorization'.
Example:
>>> client = await AuthAsyncClient.login(
... UserName_or_Email="user@example.com",
... Password="secure_password"
... )
>>> client.token['Authorization'][:10]
'eyJ0eXAiOi'
>>> client.Permissions # Decoded JWT payload
{'sub': 'user_id', 'exp': 1700350200, ...}
"""
def __init__(
self,
*,
httpx_Client:AsyncClient,
token:dict[str,str],
):
"""
Initialize the AuthAsyncClient with an existing httpx.AsyncClient and authentication token.
Args:
httpx_Client (AsyncClient): Preconfigured AsyncClient for making authorized requests.
token (dict[str, str]): Dictionary containing authentication tokens.
"""
self.httpx_Client : AsyncClient = httpx_Client
self.token : dict[str,str] = token
self.UpdatePermission
@property
def UpdatePermission(self)-> None:
"""
Decodes the JWT 'Authorization' token to extract user permissions.
Raises:
ValueError: If the JWT cannot be decoded.
"""
try :
self.Permissions = decode(
jwt=self.token['Authorization'].encode(),
algorithms='HS256',
options={"verify_signature": False},
)
except Exception as e:
raise ValueError(e)
@classmethod
async def login(
cls,
*,
UserName_or_Email : str,
Password : str
)-> "AuthAsyncClient":
"""
Authenticate a user and return an instance of `AuthAsyncClient`.
This method performs the login request to the HedgeTech API, retrieves JWT tokens,
and configures an `httpx.AsyncClient` with authentication headers and cookies.
Args:
UserName_or_Email (str): The username or email of the user.
Password (str): The user's password.
Returns:
AuthAsyncClient: An initialized client ready to make authorized requests.
Raises:
ValueError: If the login attempt fails (e.g., wrong credentials).
Example:
>>> client = await AuthAsyncClient.login(
... UserName_or_Email="user@example.com",
... Password="secure_password"
... )
>>> client.token['Authorization'][:10]
'eyJ0eXAiOi'
"""
httpx_Client = AsyncClient(verify=True ,http1=False ,http2=True)
login_res = await httpx_Client.post(
url='https://core.hedgetech.ir/auth/user/token/issue',
data={
'UserName_or_Email' : UserName_or_Email,
'Password' : Password
}
)
if login_res.status_code == 201:
token = login_res.json()
headers = {'origin' : 'https://core.hedgetech.ir'}
headers.update(token)
httpx_Client = RetriableAsyncClient(
client = AsyncClient(
verify=True ,
http1=False ,
http2=True ,
headers=headers,
cookies=httpx_Client.cookies,
timeout=Timeout(
connect=.250,
read=1.5,
write=1.5,
pool=.250,
),
),
retries= 10
)
return cls(
httpx_Client = httpx_Client,
token = token
)
else :
raise ValueError(login_res.json().get('detail'))
+157
View File
@@ -0,0 +1,157 @@
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from .__utils import RetriableSyncClient
from httpx import (
Client ,
Timeout ,
)
from jwt import decode
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class AuthSyncClient:
"""
Synchronous client for interacting with the HedgeTech API using JWT-based authentication.
This class provides a high-level interface to authenticate users, manage JWT tokens,
and make authorized HTTP requests using an `httpx.Client`.
Attributes:
httpx_Client (Client): An instance of `httpx.Client` configured with authentication headers.
token (dict[str, str]): Dictionary containing authentication tokens, typically including 'Authorization'.
Example:
>>> client = AuthSyncClient.login(
... UserName_or_Email="user@example.com",
... Password="secure_password"
... )
>>> client.token['Authorization'][:10]
'eyJ0eXAiOi'
>>> client.Permissions # Decoded JWT payload
{'sub': 'user_id', 'exp': 1700350200, ...}
"""
def __init__(
self,
*,
httpx_Client:Client,
token:dict[str,str],
):
"""
Initialize the AuthSyncClient with an existing httpx.Client and authentication token.
Args:
httpx_Client (Client): Preconfigured Client for making authorized requests.
token (dict[str, str]): Dictionary containing authentication tokens.
"""
self.httpx_Client : Client = httpx_Client
self.token : dict[str,str] = token
self.UpdatePermission
@property
def UpdatePermission(self)-> None:
"""
Decodes the JWT 'Authorization' token to extract user permissions.
Raises:
ValueError: If the JWT cannot be decoded.
"""
try :
self.Permissions = decode(
jwt=self.token['Authorization'].encode(),
algorithms='HS256',
options={"verify_signature": False},
)
except Exception as e:
raise ValueError(e)
@classmethod
def login(
cls,
*,
UserName_or_Email : str,
Password : str
)-> "AuthSyncClient":
"""
Authenticate a user synchronously and return an instance of `AuthSyncClient`.
This method performs the login request to the HedgeTech API, retrieves JWT tokens,
and configures an `httpx.Client` with authentication headers and cookies.
Args:
UserName_or_Email (str): The username or email of the user.
Password (str): The user's password.
Returns:
AuthSyncClient: An initialized client ready to make authorized requests.
Raises:
ValueError: If the login attempt fails (e.g., wrong credentials).
Example:
>>> client = AuthSyncClient.login(
... UserName_or_Email="user@example.com",
... Password="secure_password"
... )
>>> client.token['Authorization'][:10]
'eyJ0eXAiOi'
"""
httpx_Client = Client(verify=True ,http1=False ,http2=True)
login_res = httpx_Client.post(
url='https://core.hedgetech.ir/auth/user/token/issue',
data={
'UserName_or_Email' : UserName_or_Email,
'Password' : Password
}
)
if login_res.status_code == 201:
token = login_res.json()
headers = {'origin' : 'https://core.hedgetech.ir'}
headers.update(token)
httpx_Client = RetriableSyncClient(
client = Client(
verify=True ,
http1=False ,
http2=True ,
headers=headers,
cookies=httpx_Client.cookies,
timeout=Timeout(
connect=.250,
read=1.5,
write=1.5,
pool=.250,
),
),
retries= 10
)
return cls(
httpx_Client = httpx_Client,
token = token
)
else :
raise ValueError(login_res.json().get('detail'))
+2
View File
@@ -0,0 +1,2 @@
from .__AuthSyncClient import AuthSyncClient
from .__AuthAsyncClient import AuthAsyncClient
@@ -0,0 +1,63 @@
# ========================================|======================================== #
# Exports #
# ========================================|======================================== #
__all__ = [
'RetriableAsyncClient'
]
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from httpx import (
AsyncClient,
ConnectTimeout,
PoolTimeout,
ReadTimeout,
WriteTimeout,
)
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class RetriableAsyncClient:
def __init__(
self,
client: AsyncClient,
retries: int = 10,
)-> AsyncClient:
self._client = client
self._retries = retries
async def _request(self, method: str, **kwargs):
attempt = self._retries
while True:
try:
return await getattr(self._client, method)(**kwargs)
except (
ConnectTimeout,
PoolTimeout,
ReadTimeout,
WriteTimeout,
):
if attempt <= 0:
raise
attempt -= 1
def __getattr__(self, name: str):
attr = getattr(self._client, name)
if name in {"get", "post", "put", "delete", "patch", "options", "head"}:
async def wrapper(**kwargs):
return await self._request(name, **kwargs)
return wrapper
return attr
@@ -0,0 +1,65 @@
# ========================================|======================================== #
# Exports #
# ========================================|======================================== #
__all__ = [
'RetriableSyncClient'
]
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from httpx import (
Client,
ConnectTimeout,
PoolTimeout,
ReadTimeout,
WriteTimeout,
)
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class RetriableSyncClient:
def __init__(
self,
client: Client,
retries: int = 10,
)-> Client:
self._client = client
self._retries = retries
def _request(self, method: str, **kwargs):
attempt = self._retries
while True:
try:
return getattr(self._client, method)(**kwargs)
except (
ConnectTimeout,
PoolTimeout,
ReadTimeout,
WriteTimeout,
):
if attempt <= 0:
raise
attempt -= 1
def __getattr__(self, name: str):
attr = getattr(self._client, name)
if name in {"get", "post", "put", "delete", "patch", "options", "head"}:
def wrapper(**kwargs):
return self._request(name, **kwargs)
return wrapper
return attr
+2
View File
@@ -0,0 +1,2 @@
from .__RetriableAsyncClient import *
from .__RetriableSyncClient import *
+4
View File
@@ -0,0 +1,4 @@
from .__tse_ifb import (
DataEngine_TseIfb_SyncClient,
DataEngine_TseIfb_AsyncClient
)
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,2 @@
from .__SyncClient import DataEngine_TseIfb_SyncClient
from .__AsyncClient import DataEngine_TseIfb_AsyncClient
@@ -0,0 +1,34 @@
from .__response import(
SecuritiesAndFunds,
StockFutures,
StockOptions,
TreasuryBonds,
Instruments,
BestLimitResponse,
OrderBookResponse,
AggregateResponse,
Institutional_vs_IndividualItemResponse,
ContractInfoResponse,
FundInfoResponse,
OHLCVLast1mResponse,
OverviewResponse,
OHLCVResponse,
CorporateActionResponse,
BestLimit_WS_symbolIsin,
BestLimit_WS_symbolName,
OrderBook_WS_symbolIsin,
OrderBook_WS_symbolName,
Aggregate_WS_symbolIsin,
Aggregate_WS_symbolName,
institutional_vs_individual_WS_symbolIsin,
institutional_vs_individual_WS_symbolName,
ContractInfo_WS_symbolIsin,
ContractInfo_WS_symbolName,
FundInfo_WS_symbolIsin,
FundInfo_WS_symbolName,
OHLCV_WS_symbolIsin,
OHLCV_WS_symbolName,
)
File diff suppressed because it is too large. Load diff
+4
View File
@@ -0,0 +1,4 @@
from .__tse_ifb import (
EmsEngine_TseIfb_SyncClient,
EmsEngine_TseIfb_AsyncClient
)
@@ -0,0 +1,757 @@
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from typing import (
Literal,
)
from .__io_types import (
HexUUID,
OrderStatus,
)
from HedgeTech.Auth import AuthAsyncClient
from PIL.Image import open as image_open
from PIL.ImageFile import ImageFile
from io import BytesIO
from asyncio import sleep
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class Order:
"""
Represents a single trading order in EMS Engine.
This class provides methods to send, edit, check status,
and delete an order after creation.
An Order instance is usually created via
`EmsEngine_TseIfb_AsyncClient` methods.
"""
def __init__(
self,
*,
SendOrder_RequestInfo : dict,
AuthASyncClient : AuthAsyncClient,
SymbolNameOrIsin : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
):
"""
Represents a stock order in the EMS Engine for TSE IFB.
This class allows sending, editing, deleting, and checking the status
of a stock order using an asynchronous client.
Attributes
----------
ValidityType : str
Type of order validity ('DAY', 'GTC', 'GTD', 'FAK', 'FOK').
ValidityDate : int
Expiration date of the order (for 'GTD' type).
SymbolNameOrIsin : str
Symbol name or ISIN code of the security.
Price : int
Order price.
Volume : int
Order volume.
is_deleted : bool
True if the order has been deleted.
OrderId : HexUUID | None
Unique identifier of the order after submission.
Methods
-------
send()
Sends the order asynchronously to the EMS engine.
Edit(Order_ValidityType, ValidityDate, Price, Volume)
Edits the existing order asynchronously.
Status()
Retrieves the current status of the order asynchronously.
Delete()
Deletes the order asynchronously.
"""
self.__AuthASyncClient = AuthASyncClient
self.__SendOrder_RequestInfo = SendOrder_RequestInfo
self.ValidityType : str = Order_ValidityType
self.ValidityDate : int = ValidityDate
self.SymbolNameOrIsin : str = SymbolNameOrIsin
self.Price : int = Price
self.Volume : int = Volume
self.is_deleted : bool = False
self.OrderId : HexUUID | None = None
# +--------------------------------------------------------------------------------------+ #
async def send(self)-> None:
"""
Sends the order to the EMS engine asynchronously.
If the order has not been sent before, it posts the request
using the provided AuthAsyncClient.
Returns
-------
None
Example
-------
>>> order = await client.Buy_by_Name(symbolName="اطلس", Price=100000, Volume=10)
>>> await order.send()
>>> print(order.OrderId)
'953097ac6ced45ca8ef205b76ca6faf2'
"""
if self.OrderId is None :
SendOrder_Response = await self.__AuthASyncClient.httpx_Client.post(**self.__SendOrder_RequestInfo)
match SendOrder_Response.status_code :
case 200 :
self.OrderId = SendOrder_Response.json()['Data']['order_uuid']
return None
case _ : return None
else : return None
# +--------------------------------------------------------------------------------------+ #
async def Edit(
self,
*,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> None:
"""
Edits an existing order asynchronously.
Parameters
----------
Order_ValidityType : str
The new order validity type.
ValidityDate : int
New expiration date if validity type is 'GTD'.
Price : int
New order price.
Volume : int
New order volume.
Returns
-------
None
Example
-------
>>> await order.Edit(Price=105, Volume=15)
"""
if self.OrderId is not None:
Edit_response = await self.__AuthASyncClient.httpx_Client.patch(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/order/edit',
data={
'order_uuid' : self.OrderId,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'Price' : Price,
'Volume' : Volume
}
)
match Edit_response.status_code:
case 200:
Edit_response = Edit_response.json()
self.OrderId = Edit_response['Data']['order_uuid']
self.ValidityType = Edit_response['Data']['order_validity_type']
self.ValidityDate = ValidityDate
self.Price = Edit_response['Data']['order_price']
self.Volume = Edit_response['Data']['order_volume']
return None
case _ : return None
else : return None
# +--------------------------------------------------------------------------------------+ #
async def Status(self)-> OrderStatus | None:
"""
Retrieves the current status of the order asynchronously.
Returns
-------
OrderStatus | None
A dictionary containing the current order status with the following keys:
- order_uuid: HexUUID, unique identifier of the order.
- order_status: 'InQueue' | 'Cancelled' | 'Broken' | 'Settled'
- Price: int, the order price.
- Volume: int, the original order volume.
- RemainedVolume: int, volume remaining unexecuted.
- ExecutedVolume: int, executed volume.
- OrderSide: 'Buy' | 'Sell', the order side.
- ValidityType: 'DAY' | 'GTC' | 'GTD', the type of order validity.
- ValidityDate: int, expiration date if applicable.
Example
-------
>>> status = await order.Status()
>>> print(status)
{
'order_uuid': '953097ac6ced45ca8ef205b76ca6faf2',
'order_status': 'InQueue',
'Price': 100,
'Volume': 10,
'RemainedVolume': 10,
'ExecutedVolume': 0,
'OrderSide': 'Buy',
'ValidityType': 'DAY',
'ValidityDate': 0
}
"""
if self.OrderId is not None:
status_respnse = await self.__AuthASyncClient.httpx_Client.get(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/order/status',
params={'order_uuid' : self.OrderId}
)
match status_respnse.status_code :
case 200:
return status_respnse.json()['Data']
case _ : return None
else : return None
# +--------------------------------------------------------------------------------------+ #
async def Delete(self)-> None:
"""
Deletes the order asynchronously.
Sets `is_deleted` to True if successful.
Returns
-------
None
Example
-------
>>> await order.Delete()
>>> print(order.is_deleted)
True
"""
if self.OrderId is not None:
Delete_respnse = await self.__AuthASyncClient.httpx_Client.delete(
url= 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/delete',
params={'order_uuid' : self.OrderId}
)
match Delete_respnse.status_code :
case 200:
self.is_deleted = True
return None
case _ : return None
else : return None
# ================================================================================= #
class EmsEngine_TseIfb_AsyncClient:
"""
Asynchronous EMS Engine client for TSE/IFB markets.
This client manages authentication, OMS login,
and order creation.
"""
def __init__(
self,
AuthASyncClient : AuthAsyncClient,
):
"""
Asynchronous client for interacting with the EMS Engine (TSE IFB).
Provides methods for logging in, retrieving CAPTCHA, and creating buy/sell orders
by symbol name or ISIN.
Attributes
----------
Customer_FullName : str | None
Full name of the logged-in customer.
Customer_TSEBourseCode : str | None
TSE bourse code of the customer.
oms_session : HexUUID | None
Session token obtained after login.
Methods
-------
Get_Captcha(OMS)
Retrieves the login CAPTCHA image asynchronously.
oms_login(username, password, captcha_value)
Logs into the OMS asynchronously.
Buy_by_Name(Order_ValidityType, ValidityDate, symbolName, Price, Volume)
Creates a new buy order by symbol name asynchronously.
Sell_by_Name(Order_ValidityType, ValidityDate, symbolName, Price, Volume)
Creates a new sell order by symbol name asynchronously.
Buy_by_isin(Order_ValidityType, ValidityDate, symbolIsin, Price, Volume)
Creates a new buy order by ISIN asynchronously.
Sell_by_isin(Order_ValidityType, ValidityDate, symbolIsin, Price, Volume)
Creates a new sell order by ISIN asynchronously.
"""
self.__AuthASyncClient = AuthASyncClient
self.Customer_FullName : str | None = None
self.Customer_TSEBourseCode : str | None = None
self.oms_session : HexUUID | None = None
# +--------------------------------------------------------------------------------------+ #
async def Get_Captcha(
self,
OMS : Literal[
'Omex | Parsian',
'Sahra | Karamad',
]
)-> ImageFile:
"""
Retrieves the CAPTCHA image for the specified OMS asynchronously.
Parameters
----------
OMS : str
OMS identifier ('Omex | Parsian' or 'Sahra | Karamad').
Returns
-------
ImageFile
The CAPTCHA image object.
Raises
------
ValueError
If the request fails or returns an error.
Example
-------
>>> captcha = await client.Get_Captcha('Omex | Parsian')
>>> captcha.show()
"""
Captcha = await self.__AuthASyncClient.httpx_Client.get(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/oms/login',
params={'oms' : OMS }
)
if Captcha.status_code == 200: return image_open(BytesIO(Captcha.content))
else : raise ValueError(Captcha.json()['detail']['Status']['Description']['en'])
# +--------------------------------------------------------------------------------------+ #
async def oms_login(
self,
username: str,
password: str,
captcha_value: str,
) -> None :
"""
Logs into the OMS asynchronously with provided credentials and CAPTCHA.
Parameters
----------
username : str
OMS username.
password : str
OMS password.
captcha_value : str
Solved CAPTCHA value.
Returns
-------
None
Raises
------
ValueError
If login fails or CAPTCHA is invalid.
Example
-------
>>> await client.oms_login("user123", "pass123", "abcd")
>>> print(client.oms_session)
'session_token_here'
"""
response = await self.__AuthASyncClient.httpx_Client.post(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/oms/login',
data={
'username' : username,
'Password' : password,
'Captcha_Value' : captcha_value
},
)
match response.status_code :
case 200 :
data = response.json()
self.Customer_FullName = data['Data']['Customer_FullName']
self.Customer_TSEBourseCode = data['Data']['Customer_TSEBourseCode']
self.oms_session = data['Data']['oms_session']
return None
case 400 :
raise ValueError(response.json()['detail']['Status']['Description']['en'])
case _ :
raise ValueError(response.text)
# +--------------------------------------------------------------------------------------+ #
async def Buy_by_Name(
self,
*,
symbolName : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Creates a new buy order by symbol name asynchronously.
Parameters
----------
Order_ValidityType : str
Order validity type.
ValidityDate : int
Expiration date if validity type is 'GTD'.
symbolName : str
Symbol name of the security.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
A new Order instance if OMS session exists, else None.
Example
-------
>>> order = await client.Buy_by_Name(symbolName="اطلس", Price=100000, Volume=10)
>>> await order.send()
"""
await sleep(0)
if self.oms_session is not None:
return Order(
AuthASyncClient=self.__AuthASyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolName,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/buy/name',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolName' : symbolName,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
async def Sell_by_Name(
self,
*,
symbolName : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Creates a new sell order by symbol name asynchronously.
Parameters
----------
Order_ValidityType : str
Order validity type.
ValidityDate : int
Expiration date if validity type is 'GTD'.
symbolName : str
Symbol name of the security.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
A new Order instance if OMS session exists, else None.
Example
-------
>>> order = await client.Sell_by_Name(symbolName="اطلس", Price=100000, Volume=10)
>>> await order.send()
"""
await sleep(0)
if self.oms_session is not None:
return Order(
AuthASyncClient=self.__AuthASyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolName,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/sell/name',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolName' : symbolName,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
async def Buy_by_isin(
self,
*,
symbolIsin : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Creates a new buy order by symbol isin asynchronously.
Parameters
----------
Order_ValidityType : str
Order validity type.
ValidityDate : int
Expiration date if validity type is 'GTD'.
symbolIsin : str
Symbol name of the security.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
A new Order instance if OMS session exists, else None.
Example
-------
>>> order = await client.Buy_by_isin(symbolIsin="اطلس", Price=100000, Volume=10)
>>> await order.send()
"""
await sleep(0)
if self.oms_session is not None:
return Order(
AuthASyncClient=self.__AuthASyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolIsin,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/buy/isin',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolIsin' : symbolIsin,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
async def Sell_by_isin(
self,
*,
symbolIsin : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Creates a new sell order by symbol isin asynchronously.
Parameters
----------
Order_ValidityType : str
Order validity type.
ValidityDate : int
Expiration date if validity type is 'GTD'.
symbolIsin : str
Symbol name of the security.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
A new Order instance if OMS session exists, else None.
Example
-------
>>> order = await client.Sell_by_isin(symbolIsin="اطلس", Price=100000, Volume=10)
>>> await order.send()
"""
await sleep(0)
if self.oms_session is not None:
return Order(
AuthASyncClient=self.__AuthASyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolIsin,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/sell/isin',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolIsin' : symbolIsin,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
@@ -0,0 +1,790 @@
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from typing import (
Literal,
)
from .__io_types import (
HexUUID,
OrderStatus,
)
from HedgeTech.Auth import AuthSyncClient
from PIL.Image import open as image_open
from PIL.ImageFile import ImageFile
from io import BytesIO
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class Order:
"""
Represents a single trading order in EMS Engine.
This class provides methods to send, edit, check status,
and delete an order after creation.
An Order instance is usually created via
`EmsEngine_TseIfb_SyncClient` methods.
"""
def __init__(
self,
*,
SendOrder_RequestInfo : dict,
AuthSyncClient : AuthSyncClient,
SymbolNameOrIsin : str,
Price : int,
Volume :int,
ValidityDate : int = 0,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
):
"""
Initialize a new Order object.
Parameters
----------
SendOrder_RequestInfo : dict
HTTP request configuration for sending the order.
AuthSyncClient : AuthSyncClient
Authenticated HTTP client.
Order_ValidityType : Literal
Order validity type.
ValidityDate : int
Expiration date (for GTD orders).
SymbolNameOrIsin : str
Symbol name or ISIN code.
Price : int
Order price.
Volume : int
Order volume.
Examples
--------
>>> order = client.Buy_by_Name(
... symbolName="اهرم",
... Price=12000,
... Volume=1000
... )
"""
self.__AuthSyncClient = AuthSyncClient
self.__SendOrder_RequestInfo = SendOrder_RequestInfo
self.ValidityType : str = Order_ValidityType
self.ValidityDate : int = ValidityDate
self.SymbolNameOrIsin : str = SymbolNameOrIsin
self.Price : int = Price
self.Volume : int = Volume
self.is_deleted : bool = False
self.OrderId : HexUUID | None = None
# +--------------------------------------------------------------------------------------+ #
def send(self)-> None:
"""
Send the order to the trading engine.
This method submits the order to EMS Engine
and assigns OrderId on success.
Returns
-------
None
Notes
-----
- Can be called only once.
- Subsequent calls have no effect.
Examples
--------
>>> order.send()
>>> print(order.OrderId)
'0xA23F...'
"""
if self.OrderId is None :
SendOrder_Response = self.__AuthSyncClient.httpx_Client.post(**self.__SendOrder_RequestInfo)
match SendOrder_Response.status_code :
case 200 :
self.OrderId = SendOrder_Response.json()['Data']['order_uuid']
return None
case _ : return None
else : return None
# +--------------------------------------------------------------------------------------+ #
def Edit(
self,
*,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> None:
"""
Edit an existing order.
Parameters
----------
Order_ValidityType : Literal
New validity type.
ValidityDate : int
New expiration date.
Price : int
New order price.
Volume : int
New order volume.
Returns
-------
None
Raises
------
None
Examples
--------
>>> order.Edit(Price=12500, Volume=800)
"""
if self.OrderId is not None:
Edit_response = self.__AuthSyncClient.httpx_Client.patch(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/order/edit',
data={
'order_uuid' : self.OrderId,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'Price' : Price,
'Volume' : Volume
}
)
match Edit_response.status_code:
case 200:
Edit_response = Edit_response.json()
self.OrderId = Edit_response['Data']['order_uuid']
self.ValidityType = Edit_response['Data']['order_validity_type']
self.ValidityDate = ValidityDate
self.Price = Edit_response['Data']['order_price']
self.Volume = Edit_response['Data']['order_volume']
return None
case _ : return None
else : return None
# +--------------------------------------------------------------------------------------+ #
def Status(self)-> OrderStatus | None:
"""
Retrieve the current status of the order.
This method queries the EMS Engine and returns detailed
execution and lifecycle information of the order.
Returns
-------
OrderStatus | None
A dictionary containing order status information.
On success, the returned object contains the following fields:
- order_uuid : HexUUID
Unique identifier of the order.
- order_status : Literal['InQueue', 'Cancelled', 'Broken', 'Settled']
Current lifecycle state of the order.
* InQueue : Order is waiting for execution.
* Cancelled : Order was cancelled.
* Broken : Order was rejected or failed.
* Settled : Order fully executed.
- Price : int
Order price.
- Volume : int
Total requested volume.
- RemainedVolume : int
Remaining unexecuted volume.
- ExecutedVolume : int
Total executed volume.
- OrderSide : Literal['Buy', 'Sell']
Side of the order.
- ValidityType : Literal['DAY', 'GTC', 'GTD']
Order validity type.
- ValidityDate : int
Expiration date (for GTD orders).
Returns None if the request fails or if the order
has not been sent yet.
Raises
------
None
Notes
-----
- This method requires a valid OrderId.
- If OrderId is None, None is returned.
- Network or server errors are silently ignored.
Examples
--------
>>> status = order.Status()
>>> print(status["order_status"])
'Settled'
>>> print(status["ExecutedVolume"])
1000
>>> if status["RemainedVolume"] == 0:
... print("Order fully executed")
Example Output
--------------
{
"order_uuid": "0xA91F23BC...",
"order_status": "Settled",
"Price": 12000,
"Volume": 1000,
"RemainedVolume": 0,
"ExecutedVolume": 1000,
"OrderSide": "Buy",
"ValidityType": "DAY",
"ValidityDate": 0
}
"""
if self.OrderId is not None:
status_respnse = self.__AuthSyncClient.httpx_Client.get(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/order/status',
params={'order_uuid' : self.OrderId}
)
match status_respnse.status_code :
case 200:
return status_respnse.json()['Data']
case _ : return None
else : return None
# +--------------------------------------------------------------------------------------+ #
def Delete(self)-> None :
"""
Cancel/Delete the order.
Sends delete request to EMS Engine.
Returns
-------
None
Notes
-----
After deletion, `is_deleted` becomes True.
Examples
--------
>>> order.Delete()
>>> print(order.is_deleted)
True
"""
if self.OrderId is not None:
Delete_respnse = self.__AuthSyncClient.httpx_Client.delete(
url= 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/delete',
params={'order_uuid' : self.OrderId}
)
match Delete_respnse.status_code :
case 200:
self.is_deleted = True
return None
case _ : return None
else : return None
# ================================================================================= #
class EmsEngine_TseIfb_SyncClient:
"""
Synchronous EMS Engine client for TSE/IFB markets.
This client manages authentication, OMS login,
and order creation.
"""
def __init__(
self,
AuthSyncClient : AuthSyncClient,
):
self.__AuthSyncClient = AuthSyncClient
self.Customer_FullName : str | None = None
self.Customer_TSEBourseCode : str | None = None
self.oms_session : HexUUID | None = None
# +--------------------------------------------------------------------------------------+ #
def Get_Captcha(
self,
OMS : Literal[
'Omex | Parsian',
'Sahra | Karamad',
]
)-> ImageFile:
"""
Fetch captcha image for OMS login.
Parameters
----------
OMS : Literal
OMS provider name.
Returns
-------
ImageFile
Captcha image.
Raises
------
ValueError
If server returns error.
Examples
--------
>>> img = client.Get_Captcha("Omex | Parsian")
>>> img.show()
"""
Captcha = self.__AuthSyncClient.httpx_Client.get(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/oms/login',
params={'oms' : OMS }
)
if Captcha.status_code == 200: return image_open(BytesIO(Captcha.content))
else : raise ValueError(Captcha.json()['detail']['Status']['Description']['en'])
# +--------------------------------------------------------------------------------------+ #
def oms_login(
self,
username: str,
password: str,
captcha_value: str,
) -> None :
"""
Authenticate user in OMS system.
Parameters
----------
username : str
Trading account username.
password : str
Trading account password.
captcha_value : str
Captcha solution.
Returns
-------
None
Raises
------
ValueError
If authentication fails.
Examples
--------
>>> client.oms_login("user1", "pass123", "A7B9")
"""
response = self.__AuthSyncClient.httpx_Client.post(
url='https://core.hedgetech.ir/ems-engine/tse-ifb/oms/login',
data={
'username' : username,
'Password' : password,
'Captcha_Value' : captcha_value
},
)
match response.status_code :
case 200 :
data = response.json()
self.Customer_FullName = data['Data']['Customer_FullName']
self.Customer_TSEBourseCode = data['Data']['Customer_TSEBourseCode']
self.oms_session = data['Data']['oms_session']
return None
case 400 :
raise ValueError(response.json()['detail']['Status']['Description']['en'])
case _ :
raise ValueError(response.text)
# +--------------------------------------------------------------------------------------+ #
def Buy_by_Name(
self,
*,
symbolName : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Create a buy order using symbol name.
Parameters
----------
symbolName : str
Trading symbol name.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
Order instance if logged in, otherwise None.
Examples
--------
>>> order = client.Buy_by_Name(
... symbolName="اهرم",
... Price=12000,
... Volume=1000
... )
>>> order.send()
"""
if self.oms_session is not None:
return Order(
AuthSyncClient=self.__AuthSyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolName,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/buy/name',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolName' : symbolName,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
def Sell_by_Name(
self,
*,
symbolName : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Create a sell order using symbol name.
Parameters
----------
symbolName : str
Trading symbol name.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
Order instance if logged in, otherwise None.
Examples
--------
>>> order = client.Sell_by_Name(
... symbolName="اهرم",
... Price=12000,
... Volume=1000
... )
>>> order.send()
"""
if self.oms_session is not None:
return Order(
AuthSyncClient=self.__AuthSyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolName,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/sell/name',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolName' : symbolName,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
def Buy_by_isin(
self,
*,
symbolIsin : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Create a buy order using symbol isin.
Parameters
----------
symbolIsin : str
Trading symbol isin.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
Order instance if logged in, otherwise None.
Examples
--------
>>> order = client.Buy_by_isin(
... symbolName="اهرم",
... Price=12000,
... Volume=1000
... )
>>> order.send()
"""
if self.oms_session is not None:
return Order(
AuthSyncClient=self.__AuthSyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolIsin,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/buy/isin',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolIsin' : symbolIsin,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
def Sell_by_isin(
self,
*,
symbolIsin : str,
Price : int,
Volume :int,
Order_ValidityType : Literal[
'DAY',
'GTC', # Good Till Cancelled
'GTD', # Good Till Date
'FAK', # Fill And Kill
'FOK', # Fill Or Kill
] = 'DAY',
ValidityDate : int = 0,
)-> Order | None:
"""
Create a sell order using symbol isin.
Parameters
----------
symbolIsin : str
Trading symbol isin.
Price : int
Order price.
Volume : int
Order volume.
Returns
-------
Order | None
Order instance if logged in, otherwise None.
Examples
--------
>>> order = client.Sell_by_isin(
... symbolName="اهرم",
... Price=12000,
... Volume=1000
... )
>>> order.send()
"""
if self.oms_session is not None:
return Order(
AuthSyncClient=self.__AuthSyncClient,
Order_ValidityType=Order_ValidityType,
ValidityDate=ValidityDate,
SymbolNameOrIsin = symbolIsin,
Price=Price,
Volume=Volume,
SendOrder_RequestInfo = {
'url' : 'https://core.hedgetech.ir/ems-engine/tse-ifb/order/new/sell/isin',
'data' : {
'oms_session' : self.oms_session,
'Order_ValidityType' : Order_ValidityType,
'ValidityDate' : ValidityDate,
'symbolIsin' : symbolIsin,
'Price' : Price,
'Volume' : Volume
}
}
)
else : return None
# +--------------------------------------------------------------------------------------+ #
@@ -0,0 +1,2 @@
from .__SyncClient import EmsEngine_TseIfb_SyncClient
from .__AsyncClient import EmsEngine_TseIfb_AsyncClient
@@ -0,0 +1,4 @@
from .__response import (
OrderStatus,
HexUUID,
)
@@ -0,0 +1,29 @@
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from typing import (
NewType,
TypedDict,
Literal,
)
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
HexUUID = NewType("HexUUID", str)
# +--------------------------------------------------------------------------------------+ #
class OrderStatus(TypedDict):
order_uuid : HexUUID
order_status : Literal['InQueue','Cancelled','Broken','Settled']
Price : int
Volume : int
RemainedVolume : int
ExecutedVolume : int
OrderSide : Literal['Buy','Sell']
ValidityType : Literal['DAY','GTC','GTD']
ValidityDate : int
View File
Whitespace-only changes.
+149 -1
View File
@@ -1 +1,149 @@
HedgeTech
# HedgeTech Python SDK
HedgeTech Python SDK is a professional, lightweight, and modular Python package designed to provide seamless access to HedgeTech services. The SDK is crafted for developers, data analysts, and algorithmic traders who want to interact with the Tehran Stock Exchange (TSE & IFB) using a clean, reliable, and easy-to-use API. It supports both synchronous and asynchronous workflows, offering maximum flexibility and performance for different application scenarios.
> **Note:** This SDK requires Python >= 3.10 and is currently in Beta. Some APIs may change in future releases, but it is stable enough for daily use.
## Features
* Secure authentication with both async and sync clients.
* Real-time and historical market data retrieval from TSE & IFB.
* Modular and maintainable architecture, designed to support multiple engines (DataEngine engines, WebSocket clients, etc.).
* Structured request and response types for robust data handling.
* Fully asynchronous support for high-performance applications.
* Easy to integrate into trading bots, analytics pipelines, dashboards, or WebSocket feeds.
## Installation
Install HedgeTech SDK via PyPI:
```
pip install HedgeTech
```
### Updating the Package
To update HedgeTech SDK to the latest version in your environment, use:
```
pip install --upgrade HedgeTech
```
## Usage
The SDK exposes all major clients through the top-level modules, so you generally do **not** need to import internal implementation files directly.
### Authentication
> **Note:** Make sure to use the matching async or sync Auth client depending on your workflow.
#### Async Authentication
```python
from HedgeTech.Auth import AuthAsyncClient
auth_async_client = await AuthAsyncClient.login(
UserName_or_Email='<YOUR UserName_or_Email>',
Password='<YOUR Password>'
)
print(auth_async_client.token)
```
#### Sync Authentication
```python
from HedgeTech.Auth import AuthSyncClient
auth_sync_client = AuthSyncClient.login(
UserName_or_Email='<YOUR UserName_or_Email>',
Password='<YOUR Password>'
)
print(auth_sync_client.token)
```
### DataEngine / TSE IFB
The DataEngine is designed to support multiple engines in a modular way. Each engine provides its own async and sync clients, structured request and response types, and can be integrated with other engines such as WebSocket clients.
> **Important Note on Sync vs Async:** All clients have the **same method names and behavior** in both Sync and Async versions. The only difference is how they execute: Sync runs in a blocking manner, while Async requires `await` and an event loop. This design allows you to switch between Sync and Async without changing the logic or input/output of your code.
#### Async Data Client
```python
from HedgeTech.DataEngine import DataEngine_TseIfb_AsyncClient
client = DataEngine_TseIfb_AsyncClient(auth_async_client)
data = await client.live_best_limit_by_isin(
symbol_isins=['IRT1AHRM0001','IRO1IKCO0001']
)
print(data)
# websocket Example
async for update in client.websocket_by_name(
channels=["best-limit", "order-book"],
symbol_names=["فملی","اطلس"]
):
print(update["data"])
```
#### Sync Data Client
```python
from HedgeTech.DataEngine import DataEngine_TseIfb_SyncClient
client = DataEngine_TseIfb_SyncClient(auth_sync_client)
data = client.historical_ohlcv_by_name(
symbolName='مهرگان',
start_timestamp=0,
end_timestamp='1763411432',
AdjustedPrice=True,
Resolution='D'
)
print(data)
# websocket Example
for update in client.websocket_by_isin(
channels=["best-limit", "order-book"],
symbol_isins=["IR1234567890"]
):
print(update["data"])
```
## Important Notes for Users
* This SDK requires Python >=3.10.
* The SDK is currently in **Beta** — APIs may change in future releases, but it is usable for most workflows.
* Always install dependencies with the specified versions to avoid compatibility issues.
* Async clients require an asyncio event loop.
* All main clients are exposed through top-level modules; you do not need to access internal files.
* Keywords and classifiers are chosen to make the SDK easy to find for developers working in finance, trading, and data analysis.
## Modules Overview
### HedgeTech.Auth
Handles authentication for all HedgeTech clients. The async (`AuthAsyncClient`) and sync (`AuthSyncClient`) clients are exposed through the top-level Auth module.
### HedgeTech.DataEngine
Handles interactions with the Tehran Stock Exchange IFB and other engines. Provides:
* Async and sync clients for fetching market data.
* Structured request and response types for predictable and robust data handling.
* Modular design that allows integration of additional engines, such as WebSocket clients or future data engines, without modifying the main interface.
## Contributing
We welcome contributions from the community! Please follow standard Python coding conventions, write clear documentation for any new features, and submit pull requests for improvements or bug fixes.
## License
This project is licensed under the **Apache License 2.0**. See the LICENSE file for full details.
## Support
For questions or issues, please open a GitHub issue or contact the HedgeTech team directly. We aim to provide timely support and guidance for all developers using the SDK.
+32 -9
View File
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
[project]
name = "HedgeTech"
version = "0.0.0"
description = "Core SDK for integrating with HedgeTech trading and market data APIs"
version = "0.2.2b0"
description = "A unified, high-performance API layer that powers all trading infrastructure across the HedgeTech ecosystem, providing modular, scalable, and real-time interfaces for market data, order management, and execution systems."
readme = "README.md"
requires-python = ">=3.10"
license = { file = "LICENSE" }
@@ -15,26 +15,49 @@ authors = [
]
keywords = [
"hedge", "finance", "trading", "oms", "api",
"market-data", "execution", "orderbook",
"algo-trading", "async", "sdk"
"hedge", "finance", "financial-markets", "stocks", "equities",
"trading", "algo-trading", "algorithmic-trading", "automated-trading",
"oms", "order-management-system", "execution", "orderbook", "real-time",
"high-frequency", "portfolio-management", "risk-management",
"market-data", "exchange-api", "sdk", "python", "async", "websocket"
]
classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Intended Audience :: Financial and Insurance Industry",
"Topic :: Software Development :: Libraries"
"Topic :: Office/Business :: Financial",
"Topic :: Scientific/Engineering :: Information Analysis",
"Topic :: System :: Networking",
"Topic :: Internet :: WWW/HTTP",
"Topic :: Software Development :: Libraries :: Python Modules",
"Framework :: AsyncIO",
"Typing :: Typed"
]
dependencies = [
"httpx[http2]==0.28.1",
"httpx[http2]<=0.28.1",
"brotli<=1.2.0",
"zstd<=1.5.7.2",
"PyJWT<=2.10.1",
"websockets<=15.0.1",
"pillow<=12.0.0",
]
[project.urls]
Homepage = "https://github.com/HedgeTech-ir/HedgeTech"
Homepage = "https://hedgetech.ir/landing/"
Documentation = "https://github.com/HedgeTech-ir/HedgeTech/blob/main/README.md"
Repository = "https://github.com/HedgeTech-ir/HedgeTech"