Skip to content

Support MARKET order type #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ex10ded merged 13 commits into from
Mar 27, 2026
Merged

Support MARKET order type #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3210527
Support TPSL order type
alexex10 Mar 17, 2026
b5da96f
Support TPSL order type
alexex10 Mar 17, 2026
b01bae5
Support TPSL order type
alexex10 Mar 17, 2026
6deb2b0
Support TPSL order type
alexex10 Mar 17, 2026
0108276
Support MARKET order type
alexex10 Mar 27, 2026
c927bf9
Support MARKET order type
alexex10 Mar 27, 2026
7e426c1
Support MARKET order type
alexex10 Mar 27, 2026
29dc388
Support MARKET order type
alexex10 Mar 27, 2026
823249b
Support MARKET order type
alexex10 Mar 27, 2026
4ff9dcd
Support MARKET order type
alexex10 Mar 27, 2026
892fd47
Support MARKET order type
alexex10 Mar 27, 2026
46e5fcd
Support MARKET order type
alexex10 Mar 27, 2026
40ed9e9
Support MARKET order type
alexex10 Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions examples/create_market_order.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import logging
from asyncio import run
from decimal import Decimal

from examples.init_env import init_env
from x10.config import BTC_USD_MARKET
from x10.perpetual.accounts import StarkPerpetualAccount
from x10.perpetual.configuration import TESTNET_CONFIG
from x10.perpetual.order_object import create_order_object
from x10.perpetual.orders import OrderSide, OrderType, TimeInForce
from x10.perpetual.trading_client import PerpetualTradingClient
from x10.utils.order import get_price_with_slippage

LOGGER = logging.getLogger()
MARKET_NAME = BTC_USD_MARKET
ENDPOINT_CONFIG = TESTNET_CONFIG
SLIPPAGE = Decimal(0.0075)


async def run_example():
env_config = init_env()
stark_account = StarkPerpetualAccount(
api_key=env_config.api_key,
public_key=env_config.public_key,
private_key=env_config.private_key,
vault=env_config.vault_id,
)
trading_client = PerpetualTradingClient(ENDPOINT_CONFIG, stark_account)
markets_dict = await trading_client.markets_info.get_markets_dict()
market_stats = await trading_client.markets_info.get_market_statistics(market_name=MARKET_NAME)

market = markets_dict[MARKET_NAME]

order_side = OrderSide.SELL
order_size = market.trading_config.min_order_size

best_market_price = market_stats.data.ask_price if order_side == OrderSide.BUY else market_stats.data.bid_price
order_price = get_price_with_slippage(
Copy link
Copy Markdown
Contributor Author

@alexex10 alexex10 Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

explicit for now

side=order_side,
price=best_market_price,
min_price_change=market.trading_config.min_price_change,
slippage=SLIPPAGE,
)

LOGGER.info("Creating MARKET order object for market: %s", market.name)

new_order = create_order_object(
account=stark_account,
order_type=OrderType.MARKET,
starknet_domain=ENDPOINT_CONFIG.starknet_domain,
market=market,
side=order_side,
amount_of_synthetic=order_size,
price=order_price,
time_in_force=TimeInForce.IOC,
reduce_only=False,
post_only=False,
)

LOGGER.info("Placing order...")

placed_order = await trading_client.orders.place_order(order=new_order)

LOGGER.info("Order is placed: %s", placed_order.to_pretty_json())


if __name__ == "__main__":
run(main=run_example())
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "x10-python-trading-starknet"
version = "1.0.0"
version = "1.1.0"
description = "Python client for X10 API"
authors = ["X10 <tech@ex10.org>"]
repository = "https://github.com/x10xchange/python_sdk"
Expand Down
259 changes: 1 addition & 258 deletions tests/perpetual/test_order_object.py → ...l/order_object/test_limit_order_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import pytest
from freezegun import freeze_time
from hamcrest import assert_that, equal_to, has_entries
from hamcrest import assert_that, equal_to
from pytest_mock import MockerFixture

from x10.perpetual.configuration import TESTNET_CONFIG
Expand All @@ -12,7 +12,6 @@
OrderSide,
OrderTpslType,
OrderTriggerPriceType,
OrderType,
SelfTradeProtectionLevel,
)
from x10.utils.date import utc_now
Expand Down Expand Up @@ -410,259 +409,3 @@ async def test_create_buy_order_with_position_tpsl(
}
),
)


@freeze_time("2024-01-05 01:08:56.860694")
@pytest.mark.asyncio
async def test_create_buy_partial_tpsl_order(mocker: MockerFixture, create_trading_account, create_btc_usd_market):
mocker.patch("x10.utils.nonce.generate_nonce", return_value=FROZEN_NONCE)

from x10.perpetual.order_object import OrderTpslTriggerParam, create_order_object

trading_account = create_trading_account()
btc_usd_market = create_btc_usd_market()
order_obj = create_order_object(
account=trading_account,
market=btc_usd_market,
order_type=OrderType.TPSL,
amount_of_synthetic=btc_usd_market.trading_config.min_order_size,
price=Decimal("0"),
side=OrderSide.SELL,
reduce_only=True,
expire_time=utc_now() + timedelta(days=14),
self_trade_protection_level=SelfTradeProtectionLevel.CLIENT,
starknet_domain=TESTNET_CONFIG.starknet_domain,
tp_sl_type=OrderTpslType.ORDER,
take_profit=OrderTpslTriggerParam(
trigger_price=Decimal("49000"),
trigger_price_type=OrderTriggerPriceType.MARK,
price=Decimal("50000"),
price_type=OrderPriceType.LIMIT,
),
stop_loss=OrderTpslTriggerParam(
trigger_price=Decimal("40000"),
trigger_price_type=OrderTriggerPriceType.MARK,
price=Decimal("39000"),
price_type=OrderPriceType.LIMIT,
),
)

assert_that(
order_obj.to_api_request_json(),
equal_to(
{
"id": "2302927936354168859785231329337424926774195696889032018790365367779325970821",
"market": "BTC-USD",
"type": "TPSL",
"side": "SELL",
"qty": "0.0001",
"price": "0",
"reduceOnly": True,
"postOnly": False,
"timeInForce": "GTT",
"expiryEpochMillis": 1705626536861,
"fee": "0.0005",
"nonce": "1473459052",
"selfTradeProtectionLevel": "CLIENT",
"cancelId": None,
"settlement": None,
"trigger": None,
"tpSlType": "ORDER",
"takeProfit": {
"triggerPrice": "49000",
"triggerPriceType": "MARK",
"price": "50000",
"priceType": "LIMIT",
"settlement": {
"signature": {
"r": "0x513b8c6540b171c6e85e2992046ce697b6056793ace2ea0e46c04cba1b72aa0",
"s": "0x25684458e72e276bbaa87a6787bfab11ed4b117c4f6ffa7cea2781c13648667",
},
"starkKey": "0x61c5e7e8339b7d56f197f54ea91b776776690e3232313de0f2ecbd0ef76f466",
"collateralPosition": "10002",
},
"debuggingAmounts": {"collateralAmount": "5000000", "feeAmount": "2500", "syntheticAmount": "-100"},
},
"stopLoss": {
"triggerPrice": "40000",
"triggerPriceType": "MARK",
"price": "39000",
"priceType": "LIMIT",
"settlement": {
"signature": {
"r": "0x30227b00607a0f671db245c734a9d9152c58af0ec0fbc83ac8c50d41b6dc2e5",
"s": "0xb355fcce280b7c82c8e6b23106df57d98aba5b3616a791a4db226063693b5d",
},
"starkKey": "0x61c5e7e8339b7d56f197f54ea91b776776690e3232313de0f2ecbd0ef76f466",
"collateralPosition": "10002",
},
"debuggingAmounts": {"collateralAmount": "3900000", "feeAmount": "1950", "syntheticAmount": "-100"},
},
"debuggingAmounts": {"collateralAmount": "0", "feeAmount": "0", "syntheticAmount": "-100"},
"builderFee": None,
"builderId": None,
}
),
)


@freeze_time("2024-01-05 01:08:56.860694")
@pytest.mark.asyncio
async def test_create_buy_position_tpsl_order(mocker: MockerFixture, create_trading_account, create_btc_usd_market):
mocker.patch("x10.utils.nonce.generate_nonce", return_value=FROZEN_NONCE)

from x10.perpetual.order_object import OrderTpslTriggerParam, create_order_object

trading_account = create_trading_account()
btc_usd_market = create_btc_usd_market()
order_obj = create_order_object(
account=trading_account,
market=btc_usd_market,
order_type=OrderType.TPSL,
amount_of_synthetic=Decimal("0"),
price=Decimal("0"),
side=OrderSide.SELL,
reduce_only=True,
expire_time=utc_now() + timedelta(days=14),
self_trade_protection_level=SelfTradeProtectionLevel.CLIENT,
starknet_domain=TESTNET_CONFIG.starknet_domain,
tp_sl_type=OrderTpslType.POSITION,
take_profit=OrderTpslTriggerParam(
trigger_price=Decimal("49000"),
trigger_price_type=OrderTriggerPriceType.MARK,
price=Decimal("50000"),
price_type=OrderPriceType.LIMIT,
),
stop_loss=OrderTpslTriggerParam(
trigger_price=Decimal("40000"),
trigger_price_type=OrderTriggerPriceType.MARK,
price=Decimal("39000"),
price_type=OrderPriceType.LIMIT,
),
)

assert_that(
order_obj.to_api_request_json(),
equal_to(
{
"id": "2740618205716882280724217633173981437193188033910023585411792989580464995593",
"market": "BTC-USD",
"type": "TPSL",
"side": "SELL",
"qty": "0",
"price": "0",
"reduceOnly": True,
"postOnly": False,
"timeInForce": "GTT",
"expiryEpochMillis": 1705626536861,
"fee": "0.0005",
"nonce": "1473459052",
"selfTradeProtectionLevel": "CLIENT",
"cancelId": None,
"settlement": None,
"trigger": None,
"tpSlType": "POSITION",
"takeProfit": {
"triggerPrice": "49000",
"triggerPriceType": "MARK",
"price": "50000",
"priceType": "LIMIT",
"settlement": {
"signature": {
"r": "0x9ec78c951d0397e31873bb1f5ede330dffc05a6be918007fac3299a122bc37",
"s": "0x1962207a67b6b6d77216d363af31ca5ea37d371ac762aa13bd5366634337b86",
},
"starkKey": "0x61c5e7e8339b7d56f197f54ea91b776776690e3232313de0f2ecbd0ef76f466",
"collateralPosition": "10002",
},
"debuggingAmounts": {
"collateralAmount": "500000000000000",
"feeAmount": "250000000000",
"syntheticAmount": "-10000000000",
},
},
"stopLoss": {
"triggerPrice": "40000",
"triggerPriceType": "MARK",
"price": "39000",
"priceType": "LIMIT",
"settlement": {
"signature": {
"r": "0x4b5a05de5d0c07956398de50b846037250dee8cd85c35944fd97f0b3dad3e5b",
"s": "0x76aa8c382b73c0f516c8398e4d648d2dad411e8b6a9a7e81fbae3656bed6d78",
},
"starkKey": "0x61c5e7e8339b7d56f197f54ea91b776776690e3232313de0f2ecbd0ef76f466",
"collateralPosition": "10002",
},
"debuggingAmounts": {
"collateralAmount": "499999999980000",
"feeAmount": "249999999990",
"syntheticAmount": "-12820512820",
},
},
"debuggingAmounts": {"collateralAmount": "0", "feeAmount": "0", "syntheticAmount": "0"},
"builderFee": None,
"builderId": None,
}
),
)


@freeze_time("2024-01-05 01:08:56.860694")
@pytest.mark.asyncio
async def test_cancel_previous_order(mocker: MockerFixture, create_trading_account, create_btc_usd_market):
mocker.patch("x10.utils.nonce.generate_nonce", return_value=FROZEN_NONCE)

from x10.perpetual.order_object import create_order_object

trading_account = create_trading_account()
btc_usd_market = create_btc_usd_market()
order_obj = create_order_object(
account=trading_account,
market=btc_usd_market,
amount_of_synthetic=Decimal("0.00100000"),
price=Decimal("43445.11680000"),
side=OrderSide.BUY,
expire_time=utc_now() + timedelta(days=14),
previous_order_external_id="previous_custom_id",
starknet_domain=TESTNET_CONFIG.starknet_domain,
)

assert_that(
order_obj.to_api_request_json(),
has_entries(
{
"cancelId": equal_to("previous_custom_id"),
}
),
)


@freeze_time("2024-01-05 01:08:56.860694")
@pytest.mark.asyncio
async def test_external_order_id(mocker: MockerFixture, create_trading_account, create_btc_usd_market):
mocker.patch("x10.utils.nonce.generate_nonce", return_value=FROZEN_NONCE)

from x10.perpetual.order_object import create_order_object

trading_account = create_trading_account()
btc_usd_market = create_btc_usd_market()
order_obj = create_order_object(
account=trading_account,
market=btc_usd_market,
amount_of_synthetic=Decimal("0.00100000"),
price=Decimal("43445.11680000"),
side=OrderSide.BUY,
expire_time=utc_now() + timedelta(days=14),
order_external_id="custom_id",
starknet_domain=TESTNET_CONFIG.starknet_domain,
)

assert_that(
order_obj.to_api_request_json(),
has_entries(
{
"id": equal_to("custom_id"),
}
),
)
Loading
Loading