合约订单 | API文档-StarEx

# 合约订单

# 下单

POST /v1/contract/order/single

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	提交(SUBMIT)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
symbol	String	是	交易对，eg.BTC/USDT
side	String	是	交易方向，可用值：BUY，SELL
positionType	String	是	持仓类型，可用值：ALL全仓，SINGLE逐仓
positionSide	String	是	持仓方向：可用值：BOTH单一持仓，LONG双向持仓多头，SHORT双向持仓空头
type	String	是	订单类型，可用值LIMIT，MARKET，PLAN_LIMIT，PLAN_MARKET
price	Decimal	否	委托价格
volume	Integer	是	订单数量
triggerType	String	否	计划委托触发类型，可用值：MARK_PRICE标记价格，CONTRACT_PRICE合约最新价格
triggerPrice	Decimal	否	计划委托触发价格
clientOrderId	String	否	用户自编订单号(最大长度32个字符，须保持唯一性)

响应参数

名称	类型	描述
orderId	Long	订单编号
clientOrderId	String	用户自编订单号（如有）

请求示例

POST /v1/contract/order/single
{
    "symbol": "BTC/USDT",
    "side": "BUY",
    "positionType": "SINGLE",
    "positionSide": "LONG",
    "type": "MARKET",
    "volume": 10,
    "clientOrderId": "COI123456"
}

响应示例

{
    "code": "200",
    "message": "OK",
    "timestamp": "1698998877091",
    "data": {
        "orderId": "640581852521111552",
        "clientOrderId": "COI123456"
    }
}

# 批量下单

POST /v1/contract/order/batch

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	提交(SUBMIT)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
	Array	是	参数数组,一个批量最多10张订单
symbol	String	是	交易对，eg.BTC/USDT
side	String	是	交易方向，可用值：BUY，SELL
positionType	String	是	持仓类型，可用值：ALL全仓，SINGLE逐仓
positionSide	String	是	持仓方向：可用值：BOTH单一持仓，LONG双向持仓多头，SHORT双向持仓空头
type	String	是	订单类型，可用值LIMIT，MARKET，PLAN_LIMIT，PLAN_MARKET
price	Decimal	否	委托价格
volume	Integer	是	订单数量
triggerType	String	否	计划委托触发类型，可用值：MARK_PRICE标记价格，CONTRACT_PRICE合约最新价格
triggerPrice	Decimal	否	计划委托触发价格
clientOrderId	String	否	用户自编订单号(最大长度32个字符，须保持唯一性)

响应参数

名称	类型	描述
orderId	Long	订单编号
clientOrderId	String	用户自编订单号（如有）
errCode	String	订单被拒错误码（仅对被拒订单有效）
errMsg	String	订单被拒错误信息（仅对被拒订单有效）

请求示例

POST /v1/contract/order/batch
[
    {
    "symbol": "BTC/USDT",
    "side": "BUY",
    "positionType": "SINGLE",
    "positionSide": "LONG",
    "type": "MARKET",
    "volume": 10,
    "clientOrderId": "COI123456"
    },
    {
    "symbol": "ETH/USDT",
    "side": "BUY",
    "positionType": "SINGLE",
    "positionSide": "SHORT",
    "type": "MARKET",
    "volume": 20,
    "clientOrderId": "COI123123"
    }
]

响应示例

{
    "code": "200",
    "message": "OK",
    "timestamp": "1699003777337",
    "data": [
        {
            "clientOrderId": "COI123456",
            "errCode": "API1100",
            "errMsg": "duplicate clientOrderId：COI123456"
        },
        {
            "orderId": "640603504344637441",
            "clientOrderId": "COI123123"
        }
    ]
}

# 调整开仓杠杆

POST /v1/contract/order/leverage

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	提交(SUBMIT)	币对(SYMBOL)	5

# 参数

名称	类型	必填	描述
symbol	String	是	交易对
leverage	Integer	是	目标杠杆倍数

响应参数

名称	类型	描述
symbol	String	交易对
leverage	Integer	目标杠杆倍数

请求示例

POST /v1/contract/order/leverage
{
	"symbol": "BTC/USDT",
	"leverage": 10
}

响应示例

{
	"code": "200",
	"message": "OK",
	"timestamp": "1698745888704",
	"data": {
		"symbol": "BTC/USDT",
		"leverage": 10
	}
}

# 撤销订单

POST /v1/contract/order/cancel

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	提交(SUBMIT)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
symbol	String	是	交易对
orderId	Long	是	订单编号
clientOrderId	String	否	用户自编订单号(最大长度32个字符，须保持唯一性)

响应参数

名称	类型	描述
orderId	Long	订单编号
clientOrderId	String	用户自编订单号（如有）
errCode	String	撤销订单错误码（仅对被拒订单有效）
errMsg	String	撤销订单错误信息（仅对被拒订单有效）

请求示例

POST /v1/contract/order/cancel
{
	"symbol": "BTC/USDT",
	"orderId": 640581735625072640,
	"clientOrderId": "COI123456"
}

响应示例

{
	"code": "200",
	"message": "OK",
	"timestamp": "1275594006695",
	"data": {
		"symbol": "BTC/USDT",
		"orderId": "640581735625072640",
		"clientOrderId": "COI123456"
	}
}

# 批量撤销订单

POST /v1/contract/order/cancel/batch

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	提交(SUBMIT)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
symbol	String	是	交易对
orderIds	Array	否	订单编号,以英文逗号分隔,（orderIds和clientOrderIds必须且只能选一个填写，不超过50张订单），建议通过orderIds来撤单，比clientOrderIds更快更稳定,单次不超过50个订单
clientOrderIds	Array	否	订单编号,以英文逗号分隔,（orderIds和clientOrderIds必须且只能选一个填写，不超过50张订单），建议通过orderIds来撤单，比clientOrderIds更快更稳定,单次不超过50个订单

响应参数

名称	类型	描述
orderId	Long	订单编号
clientOrderId	String	用户自编订单号（如有）
errCode	String	撤销订单错误码（仅对被拒订单有效）
errMsg	String	撤销订单错误信息（仅对被拒订单有效）

请求示例

POST /contract/order/cancel/batch
{
	"symbol": "BTC/USDT",
	"orderIds": [
		640581735625072640,
		640603500010741760
	]
}

响应示例

{
	"code": "200",
	"message": "OK",
	"timestamp": "1704179637899",
	"data": [
		{
			"orderId": "640581735625072640"
		},
		{
			"orderId": "640603500010741760"
		}
	]
}

# 查询未成交订单

GET /v1/contract/order/open

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	查询(QUERY)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
symbol	String	是	交易对
direction	String	否	交易方向，可用值：BUY,SELL
positionSide	String	否	持仓方向，可用值：BOTH 单向持仓，LONG 双向持仓多头，SHORT 双向持仓空头
types	Array	否	查询的订单类型组合，使用英文逗号分割，可用值：LIMIT，MARKET，PLAN_LIMIT，PLAN_MARKET
limit	Integer	否	返回订单的数量，最大值500

响应参数

名称	类型	描述
symbol	String	交易对
orderId	Long	订单编号
clientOrderId	String	用户自编订单号
positionType	String	仓位类型：ALL 全仓，SINGLE 逐仓
positionSide	String	持仓方向：BOTH 单向持仓，LONG 双向持仓多头，SHORT 双向持仓空头
type	String	委托类型：LIMIT，MARKET，PLAN_LIMIT，PLAN_MARKET
side	String	买卖方向: BUY,SELL
price	BigDecimal	委托价格
volume	Integer	委托数量
triggerPrice	BigDecimal	计划委托单触发价格
triggerType	Integer	计划委托单触发类型，1：标记价格，2：最新价格
dealVolume	Integer	已成交数量
leverageLevel	Integer	杠杆倍数
multiplier	BigDecimal	合约面值
avgPrice	BigDecimal	成交均价
freezeAmount	BigDecimal	冻结保证金
feeAmount	BigDecimal	手续费
feeRateMaker	Double	挂单手续费率
feeRateTaker	Double	吃单手续费率

请求示例

GET /v1/contract/order/open?symbol=BTC/USDT&direction=BUY&positionSide=LONG

响应示例

{
    "code": "200",
    "message": "OK",
    "timestamp": "1704336500885",
    "data": [
        {
            "symbol": "BTC/USDT",
            "orderId": "644549923592282112",
            "clientOrderId": "OO202401031820",
            "positionType": "SINGLE",
            "positionSide": "LONG",
            "type": "LIMIT",
            "side": "BUY",
            "price": "36666.9",
            "volume": 10,
            "triggerPrice": "0",
            "triggerType": 0,
            "dealVolume": 10,
            "leverageLevel": 1,
            "multiplier": "0.0001",
            "avgPrice": "36667",
            "freezeAmount": "36.66910001",
            "feeRateMaker": 0.0,
            "feeRateTaker": 0.0
        }
    ]
}

# 查询历史订单

GET /v1/contract/order/history

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	查询(QUERY)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
symbol	String	是	交易对
direction	String	否	交易方向，可用值：BUY,SELL
positionSide	String	否	持仓方向，可用值：BOTH 单向持仓，LONG 双向持仓多头，SHORT 双向持仓空头
types	Array	否	查询的订单类型组合，使用英文逗号分割，可用值：LIMIT，MARKET，PLAN_LIMIT，PLAN_MARKET
limit	Integer	否	返回订单的数量，默认100，最大500

响应参数

名称	类型	描述
symbol	String	交易对
orderId	Long	订单编号
clientOrderId	String	用户自编订单号
positionType	String	仓位类型：ALL 全仓，SINGLE 逐仓
positionSide	String	持仓方向：BOTH 单向持仓，LONG 双向持仓多头，SHORT 双向持仓空头
type	String	委托类型：LIMIT，MARKET，PLAN_LIMIT，PLAN_MARKET
side	String	买卖方向：BUY,SELL
price	BigDecimal	委托价格
volume	Integer	委托数量
triggerPrice	BigDecimal	计划委托单触发价格
triggerType	Integer	计划委托单触发类型，1：标记价格，2：最新价格
dealVolume	Integer	已成交数量
leverageLevel	Integer	杠杆倍数
multiplier	BigDecimal	合约面值
avgPrice	BigDecimal	成交均价
freezeAmount	BigDecimal	冻结保证金
feeAmount	BigDecimal	手续费
feeRateMaker	Double	挂单手续费率
feeRateTaker	Double	吃单手续费率
realizedAmount	BigDecimal	已实现盈亏
refundMarginAmount	BigDecimal	退还保证金
status	Integer	订单状态：2 全部成交，3 部分成交，4 已撤销，8 已执行, 9 执行失败
canceledVolume	Integer	已撤单数量
canceledUserType	Integer	撤单操作人类型，0: 未撤销，1：系统撤销，2：用户撤销
canceledDate	Date	撤单时间
earningRate	BigDecimal	收益率

请求示例

GET /v1/contract/order/history?symbol=BTC/USDT

响应示例

{
    "code": "200",
    "message": "OK",
    "timestamp": "1704362423621",
    "data": [
        {
            "symbol": "BTC/USDT",
            "orderId": "644549923592282112",
            "clientOrderId": "OO202401041520",
            "positionType": "SINGLE",
            "positionSide": "LONG",
            "type": "MARKET",
            "side": "BUY",
            "price": "36666.9",
            "volume": 10,
            "triggerPrice": "0",
            "triggerType": 0,
            "dealVolume": 10,
            "leverageLevel": 1,
            "multiplier": "0.0001",
            "avgPrice": "36667",
            "freezeAmount": "36.66910001",
            "feeAmount": "0.00220002",
            "feeRateMaker": 0.0,
            "feeRateTaker": 0.0,
            "realizedAmount": "0",
            "refundMarginAmount": "0",
            "status": 2,
            "canceledVolume": 0,
            "canceledUserType": 0,
            "earningRate": "0"
        },
        {
            "symbol": "BTC/USDT",
            "orderId": "644550281194024961",
            "clientOrderId": "OO202401041530",
            "positionType": "SINGLE",
            "positionSide": "LONG",
            "type": "MARKET",
            "side": "SELL",
            "price": "36681.5",
            "volume": 10,
            "triggerPrice": "0",
            "triggerType": 0,
            "dealVolume": 10,
            "leverageLevel": 1,
            "multiplier": "0.0001",
            "avgPrice": "36681.4",
            "freezeAmount": "0",
            "feeAmount": "0.00220088",
            "feeRateMaker": 0.0,
            "feeRateTaker": 0.0,
            "realizedAmount": "1.13185",
            "refundMarginAmount": "0",
            "status": 2,
            "canceledVolume": 0,
            "canceledUserType": 0,
            "earningRate": "0.0319"
        }
    ]
}

# 查询用户手续费率

GET /v1/contract/order/fee-rate

所属模块	所属类型	资源隔离类型	速率限制
合约订单(CONTRACT_ORDER)	提交(QUERY)	币对(SYMBOL)	5

参数

名称	类型	必填	描述
symbol	String	是	交易对

响应参数

名称	类型	描述
symbol	String	交易对
openTakerFeeRate	BigDecimal	开仓taker手续费率
openMakerFeeRate	BigDecimal	开仓marker手续费率
closeTakerFeeRate	BigDecimal	平仓taker手续费率
closeMakerFeeRate	BigDecimal	平仓maker手续费率

请求示例

GET /v1/contract/order/fee-rate?symbol=BTC/USDT

响应示例

{
    "code": "200",
    "message": "OK",
    "timestamp": "1704336500885",
    "data": [
        {
            "symbol": "BTC/USDT",
            "openTakerFeeRate": "0.0005",
            "openMakerFeeRate": "0.0002",
            "closeTakerFeeRate": "0.0005",
            "closeMakerFeeRate": "0.0002"
        }
    ]
}

← 合约行情合约websocket →