15 Commits
14 changed files with 1753 additions and 80 deletions

No files matched your search

+16 -12
View File
@@ -2,6 +2,7 @@
# Imports #
# ========================================|======================================== #
from .__utils import RetriableAsyncClient
from httpx import (
AsyncClient ,
Timeout ,
@@ -126,20 +127,23 @@ class AuthAsyncClient:
headers = {'origin' : 'https://core.hedgetech.ir'}
headers.update(token)
httpx_Client = AsyncClient(
verify=True ,
http1=False ,
http2=True ,
headers=headers,
cookies=httpx_Client.cookies,
timeout=Timeout(
connect=.5,
read=1,
write=1,
pool=.5,
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
+19 -15
View File
@@ -2,6 +2,7 @@
# Imports #
# ========================================|======================================== #
from .__utils import RetriableSyncClient
from httpx import (
Client ,
Timeout ,
@@ -128,24 +129,27 @@ class AuthSyncClient:
token = login_res.json()
headers = {'origin' : 'https://core.hedgetech.ir'}
headers.update(token)
httpx_Client = Client(
verify=True ,
http1=False ,
http2=True ,
headers=headers,
cookies=httpx_Client.cookies,
timeout=Timeout(
connect=.5,
read=1,
write=1,
pool=.5,
),
)
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 = login_res.json()
token = token
)
else :
@@ -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 *
@@ -1,8 +1,3 @@
from .__requests import (
SymbolNames,
SymbolIsins,
)
from .__response import(
SecuritiesAndFunds,
StockFutures,
@@ -1,47 +0,0 @@
# ========================================|======================================== #
# Imports #
# ========================================|======================================== #
from typing import (
List,
TypedDict
)
# ========================================|======================================== #
# Class Definitions #
# ========================================|======================================== #
class SymbolNames(TypedDict):
"""
Represents a collection of instrument symbol names for batch API requests.
Attributes:
symbol_names (List[str]): A list of instrument symbol names (strings) to be queried.
Example:
>>> symbols: SymbolNames = {"symbol_names": ["ETF001", "FUT002", "STK003"]}
>>> symbols["symbol_names"][0]
'ETF001'
"""
symbol_names: List[str]
# +--------------------------------------------------------------------------------------+ #
class SymbolIsins(TypedDict):
"""
Represents a collection of instrument ISIN identifiers for batch API requests.
Attributes:
symbol_isins (List[str]): A list of instrument ISIN codes (strings) to be queried.
Example:
>>> isins: SymbolIsins = {"symbol_isins": ["IR0001234567", "IR0009876543"]}
>>> isins["symbol_isins"][1]
'IR0009876543'
"""
symbol_isins: List[str]
# +--------------------------------------------------------------------------------------+ #
+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
+2 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "HedgeTech"
version = "0.1.0"
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"
@@ -54,6 +54,7 @@ dependencies = [
"zstd<=1.5.7.2",
"PyJWT<=2.10.1",
"websockets<=15.0.1",
"pillow<=12.0.0",
]
[project.urls]