API Trading SDK
Here we describe how to create a new self-hosted strategy, open and close positions using the Mizar python SDK
Self-hosted strategies are strategies hosted by quants/trading firms on their own servers.
from mizar import Mizar
mizar_client = Mizar()
mizar_client.create_self_hosted_strategy(
name="My Strategy",
description="My Strategy works this way",
exchanges=["binance"],
symbols=["BTCUSDT"],
market="SPOT"
)
The strategy creation returns a dictionary with the following format
{
'creation_timestamp': 1625571350830,
'exchange': 'binance',
'market': 'SPOT',
'name': 'My Strategy',
'strategy_id': 1,
'symbols': [
{
'base_asset': 'BTC',
'quote_asset': 'USDT',
'symbol': 'BTCUSDT'
}
]
}
strategy_id is a unique identifier for your strategy which is used to open and close positions.
Open a new position using the
open_position method mizar_client.open_position(
strategy_id=1,
base_asset="BTC",
quote_asset="USDT",
size=0.3,
is_long=True
)
size indicates the relative size of the position. If you are sure that the position will bring profit use 1, otherwise scale down the size to reduce risks.
If the position opening is successful it will return a dictionary with the following format
{
'base_asset': 'BTC',
'is_long': True,
'open_price': '34209.480000000000',
'open_timestamp': 1625572116854,
'position_id': '1',
'quote_asset': 'USDT',
'size': 0.3,
'strategy_id': '1'
}
Close an existing open position using the
close_position method mizar_client.close_position(
position_id=1
)
If the position is closed successfully you will receive
{
'base_asset': 'BTC',
'close_price': '33914.640000000000',
'close_timestamp': 1625572999043,
'is_long': True,
'open_price': '33914.640000000000',
'open_timestamp': 1625572973963,
'position_id': '1',
'quote_asset': 'USDT',
'size': 0.3,
'strategy_id': '1'
}
Get all the open positions using
get_all_open_positions methodmizar_client.get_all_open_positions(
strategy_id=1
)
Will return
{'open_positions': [
{
'base_asset': 'BTC',
'is_long': True,
'open_price': '33871.070000000000',
'open_timestamp': 1625573293041,
'position_id': '1',
'quote_asset': 'USDT',
'size': 1.0,
'strategy_id': '1'
},
{
'base_asset': 'BTC',
'is_long': True,
'open_price': '33871.070000000000',
'open_timestamp': 1625573294312,
'position_id': '2',
'quote_asset': 'USDT',
'size': 1.0,
'strategy_id': '1'
},
{
'base_asset': 'BTC',
'is_long': True,
'open_price': '33871.070000000000',
'open_timestamp': 1625573295016,
'position_id': '3',
'quote_asset': 'USDT',
'size': 1.0,
'strategy_id': '1'
}
]
}
Close all the positions using
close_all_positions methodmizar_client.get_all_open_positions(
strategy_id=1
)
Will return
{'closed_positions': [
{
'base_asset': 'BTC',
'close_price': '34146.340000000000',
'close_timestamp': 1625574840982,
'is_long': True,
'open_price': '33871.070000000000',
'open_timestamp': 1625573293041,
'position_id': '1',
'quote_asset': 'USDT',
'size': 1.0,
'strategy_id': '`'
},
{
'base_asset': 'BTC',
'close_price': '34146.340000000000',
'close_timestamp': 1625574841018,
'is_long': True,
'open_price': '33871.070000000000',
'open_timestamp': 1625573294312,
'position_id': '2',
'quote_asset': 'USDT',
'size': 1.0,
'strategy_id': '1'
},
{'base_asset': 'BTC',
'close_price': '34146.340000000000',
'close_timestamp': 1625574841045,
'is_long': True,
'open_price': '33871.070000000000',
'open_timestamp': 1625573295016,
'position_id': '3',
'quote_asset': 'USDT',
'size': 1.0,
'strategy_id': '1'
}
]
}
Last modified 1yr ago