合约交易

公共

安全类型: None

公共下方的接口不需要API-key或者签名就能自由访问

测试连接

GET https://futuresopenapi.xxx.com/fapi/v1/ping

测试REST API的连通性

{}

获取服务器时间

GET https://futuresopenapi.xxx.com/fapi/v1/time

{
    "timezone": "China Standard Time",
    "serverTime": 1704962055664
}
名称
类型
例子
描述

timezone

string

China Standard Time

服务器时区

serverTime

long

1607702400000

服务器时间戳

合约列表

GET https://futuresopenapi.xxx.com/fapi/v1/contracts

[
    {
        "symbol": "E-ETC-USDT",
        "pricePrecision": 3,
        "side": 1,
        "maxMarketVolume": 200000,
        "multiplier": 1.0000000000000000,
        "minOrderVolume": 1,
        "maxMarketMoney": 500000.0000000000000000,
        "type": "E",
        "maxLimitVolume": 300000,
        "maxValidOrder": 10,
        "multiplierCoin": "ETC",
        "minOrderMoney": 1.0000000000000000,
        "maxLimitMoney": 500000.0000000000000000,
        "status": 1
    },
    {
        "symbol": "E-ATOM-USDT",
        "pricePrecision": 3,
        "side": 1,
        "maxMarketVolume": 100000,
        "multiplier": 1.0000000000000000,
        "minOrderVolume": 1,
        "maxMarketMoney": 200000.0000000000000000,
        "type": "E",
        "maxLimitVolume": 200000,
        "maxValidOrder": 10,
        "multiplierCoin": "ATOM",
        "minOrderMoney": 20.0000000000000000,
        "maxLimitMoney": 2000000.0000000000000000,
        "status": 1
    }
]
名称
类型
例子
描述

symbol

string

E-BTC-USDT

大写合约名称

pricePrecision

number

4

价格精度

status

number

1

合约状态（0：不可交易，1：可交易

type

string

S

合约类型 (E:永续合约，S:模拟合约，其他为混合合约)

side

number

1

合约方向 (0: 反向，1：正向)

multiplier

number

0.50

合约面值

minOrderVolume

number

10

最小下单量

minOrderMoney

number

10

最小下单金额

maxMarketVolume

number

100000

市价单最大下单数量

maxMarketMoney

number

100000.00

市价最大下单金额

maxLimitVolume

number

100000

限价单最大下单数量

maxLimitMoney

number

100000.00

限价最大下单金额

maxValidOrder

number

100000

最大有效委托的订单数量

行情相关

安全类型: None

行情下方的接口不需要API-Key或者签名就能自由访问

订单薄

GET https://futuresopenapi.xxx.com/fapi/v1/depth

市场订单薄深度信息

Query Parameters

Name
Type
Description

limit

integer

默认100; 最大100

contractName

string

大写合约名称 如 E-BTC-USDT

{
  "asks": [
    [
      "4.00000200",  // 价格
      "12.00000000"  // 数量
    ],
    [
      "5.10000000",
      "28.00000000"
    ]
  ],
  "bids": [
    [
      "3.90000000",   // 价格
      "431.00000000"  // 数量
    ],
    [
      "4.00000000",
      "431.00000000"
    ]
  ],
  "time":1704962463000
}
名称
类型
例子
描述

time

long

1595563624731

当前时间(Unix Timestamp, 毫秒ms)

bids

list

[[2100,13],[1990,3]]

订单薄买盘信息，数组第一位为价格，类型为float；第二位为当前价格对应的数量，类型为float

asks

list

[[2100,13],[1990,3]]

订单薄卖盘信息，数组第一位为价格，类型为float；第二位为当前价格对应的数量，类型为float

bids和asks所对应的信息代表了订单薄的所有价格以及价格对应的数量的信息, 由最优价格从上到下排列

行情ticker

GET https://futuresopenapi.xxx.com/fapi/v1/ticker

24小时价格变化数据

Query Parameters

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

{
    "high": "2500",
    "vol": "0",
    "last": "2500",
    "low": "2500",
    "buy": 2100,
    "sell": 0,
    "rose": "0",
    "time": 1704966225000
}
名称
类型
例子
描述

time

long

1595563624731

时间戳

high

float

9900

最高价

low

float

8800.34

最低价

last

float

8900.23

最新价

vol

float

4999

交易量

rose

string

+0.05

涨跌幅，+为涨，-为跌，+0.05为涨5%

buy

float

2100.01

买一价格

sell

float

2050.01

卖一价格

获取指数/标记价格

GET https://futuresopenapi.xxx.com/fapi/v1/index

Query Parameters

Name
Type
Description

contractName*

string

合约名称大写 如 E-BTC-USDT

limit

string

默认100; 最大1000

{
    "currentFundRate": -0.0037500000000000,
    "indexPrice": 27905.9800000000000000,
    "tagPrice": 27824.4422146875000000,
    "nextFundRate": -0.0037500000000000
}
名称
类型
例子
描述

indexPrice

float

0.055

指数价格

tagPrice

float

0.0578

标记价格

nextFundRate

float

0.343

资金费率价格

currentFundRate

float

0.123

上期资金费率(用于本期结算)

K线/蜡烛图数据

GET https://futuresopenapi.xxx.com/fapi/v1/klines

Query Parameters

Name
Type
Description

contractName*

string

合约名称大写 如 E-BTC-USDT

interval*

string

k线图区间, 可识别的参数值为： 1min,5min,15min,30min,1h,1day,1week,1month（min=分钟，h=小时,day=天，week=星期，month=月）

limit

integer

默认100; 最大300

startTime

long

时间戳，毫秒（ms）

1708617600000

endTime

long

时间戳，毫秒（ms）

1708704000000

[
    {
        "high": "6228.77",
        "vol": "111",
        "low": "6228.77",
        "idx": 1594640340,
        "close": "6228.77",
        "open": "6228.77"
    },
    {
        "high": "6228.77",
        "vol": "222",
        "low": "6228.77",
        "idx": 1587632160,
        "close": "6228.77",
        "open": "6228.77"
    },
    {
        "high": "6228.77",
        "vol": "333",
        "low": "6228.77",
        "idx": 1587632100,
        "close": "6228.77",
        "open": "6228.77"
    }
]
名称
类型
例子
描述

idx

long

1538728740000

开始时间戳，毫秒（ms）

open

float

36.00000

开盘价

close

float

33.00000

收盘价

high

float

36.00000

最高价

low

float

30.00000

最低价

vol

float

2456.00000

成交量

交易相关

安全类型: TRADE

交易下方的接口都需要签名和API-key验证

创建订单

POST https://futuresopenapi.xxx.com/fapi/v1/order

创建单个新订单

Headers

Name
Type
Description

X-CH-TS*

string

时间戳

X-CH-APIKEY*

string

您的API-KEY

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

volume*

number

下单张数，有精度限制，精度由管理员设置, 市价开仓时这里单位是价值

price

number

下单价格,限价单时该字段为必传,有精度限制，精度由管理员设置

contractName*

string

大写合约名称 如 E-BTC-USDT

type*

string

订单类型, LIMIT/MARKET

side*

string

买卖方向, BUY/SELL

open*

string

开平仓方向, OPEN/CLOSE

positionType

number

持仓类型, 1:全仓/2:逐仓

clientOrderId

string

客户端下单标识, 长度小于32位的字符串

timeInForce

string

IOC, FOK, POST_ONLY

{
    "orderId": 256609229205684228
}
名称
类型
例子
描述

orderId

string

256609229205684228

订单ID

创建条件单

POST https://futuresopenapi.xxx.com/fapi/v1/conditionOrder/

Headers

Name
Type
Description

X-CH-TS*

string

时间戳

X-CH-APIKEY*

string

您的API-KEY

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

triggerType

string

条件的类型，1:止损/2:止盈/3:追涨/4:杀跌

triggerPrice

string

触发价

clientOrderId

string

客户端下单标识，长度小于32位的字符串

positionType

number

持仓类型，1：全仓/2.逐仓

open

string

开平仓方向，OPEN/CLOSE

side

string

买卖方向，BUY/SELL

type

string

订单类型, LIMIT/MARKET

contractName

string

大写合约名称 如 E-BTC-USDT

price

number

下单价格，有精度限制，精度由管理员设置

volume

number

下单数量,市价开仓时这里单位是价值,有精度限制,精度由管理员设置

{
    "code": "0",
    "msg": "Success",
    "data": {
        "triggerIds": [
            "1322738336974712847"
        ],
        "ids": [],
        "cancelIds": []
    },
    "succ": true
}

如果该接口返回与期望不符，请联系技术团队，我们会为您提供相关帮助

取消订单

POST https://futuresopenapi.xxx.com/fapi/v1/cancel

限速规则: 20次/2s

Headers

Name
Type
Description

X-CH-SIGN*

string

签名

X-CH-APIKEY*

string

您的API-key

X-CH-TS*

integer

时间戳

Request Body

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

orderId*

string

订单ID

{
    "orderId": 256609229205684228
}

订单详情

GET https://futuresopenapi.xxx.com/fapi/v1/order

Query Parameters

Name
Type
Description

contractName*

string

大写合约名称 如E-BTC-USDT

orderId*

string

订单ID

clientOrderId*

string

客户端唯一标识，默认为0

{
    "side": "BUY",
    "executedQty": 0,
    "orderId": 2006628907041292645,
    "price": 2000.0000000000000000,
    "origQty": 2.0000000000000000,
    "avgPrice": 0E-8,
    "transactTime": 1704967622000,
    "action": "OPEN",
    "contractName": "E-BTC-USDT",
    "type": "LIMIT",
    "timeInForce": "",
    "status": "NEW"
}
名称
类型
例子
描述

orderId

long

150695552109032492

订单ID（系统生成

contractName

string

E-BTC-USDT

大写合约名称

price

float

10.50

委托价格

origQty

float

10.50

委托数量

executedQty

float

10.10

成交数量

avgPrice

float

10.50

成交均价

status

string

NEW

订单状态。可能出现的值为：NEW(新订单，无成交)、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）

side

string

NEW

订单方向。可能出现的值只能为：BUY（买入做多） 和 SELL（卖出做空）

action

string

OPEN

OPEN/CLOSE

transactTime

long

1607702400000

订单创建时间

type

string

LIMIT

订单类型LIMIT/MARKET

timeInForce

integer

2

条件单有效方式1 limit， 2 market，3 IOC，4 FOK，5 POST_ONLY

fills

[ ]

成交记录

当前订单

GET https://futuresopenapi.xxx.com/fapi/v1/openOrders

限速规则: 获取当前合约, 该用户的当前委托

Query Parameters

Name
Type
Description

contractName

string

需大写合约名称 如E-BTC-USDT

Headers

Name
Type
Description

X-CH-SIGN

string

签名

X-CH-APIKEY

string

您的API-key

X-CH-TS

string

时间戳

[
    {
       "side": "BUY",
       "executedQty": 0,
       "orderId": 259396989397942275,
       "price": 10000.0000000000000000,
       "origQty": 1.0000000000000000,
       "avgPrice": 0E-8,
       "transactTime": "1607702400000",
       "action": "OPEN",
       "contractName": "E-BTC-USDT",
       "type": "LIMIT",
       "status": "INIT"
    }
]
名称
类型
例子
描述

orderId

long

150695552109032492

订单ID（系统生成）

contractName

string

E-BTC-USDT

大写合约名称

price

float

4765.29

订单价格

origQty

float

1.01

订单数量

executedQty

float

1.01

已经成交订单数量

avgPrice

float

4754.24

订单已经成交的平均价格

type

string

LIMIT

订单类型。可能出现的值只能为:LIMIT(限价)和MARKET（市价）

side

string

BUY

订单方向。可能出现的值只能为：BUY（买入做多） 和 SELL（卖出做空）

status

string

NEW

订单状态。可能出现的值为：NEW(新订单，无成交)、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）.

action

string

OPEN

OPEN/CLOSE

transactTime

long

1607702400000

订单创建时间

历史委托

POST https://futuresopenapi.xxx.com/fapi/v1/orderHistorical

Headers

Name
Type
Description

X-CH-SIGN

string

签名

X-CH-APIKEY

string

您的API-key

X-CH-TS

string

时间戳

Request Body

Name
Type
Description

contractName

string

大写合约名称 E-BTC-USDT

limit

string

分页条数, 默认100; 最大1000

fromId

long

从这条记录开始检索

[
    {
        "side":"BUY",
        "clientId":"0",
        "ctimeMs":1632903411000,
        "positionType":2,
        "orderId":777293886968070157,
        "avgPrice":41000,
        "openOrClose":"OPEN",
        "leverageLevel":26,
        "type":4,
        "closeTakerFeeRate":0.00065,
        "volume":2,
        "openMakerFeeRate":0.00025,
        "dealVolume":1,
        "price":41000,
        "closeMakerFeeRate":0.00025,
        "contractId":1,
        "ctime":"2021-09-29T16:16:51",
        "contractName":"E-BTC-USDT",
        "openTakerFeeRate":0.00065,
        "dealMoney":4.1,
        "status":4
    }
]

如果该接口返回与期望不符，请联系技术团队，我们会为您提供相关帮助

盈亏记录

POST https://futuresopenapi.xxx.com/fapi/v1/profitHistorical

如果该接口返回报错，请联系技术团队，我们会为您提供相关帮助

Headers

Name
Type
Description

X-CH-SIGN

string

签名

X-CH-APIKEY

string

您的API-key

X-CH-TS

string

时间戳

Request Body

Name
Type
Description

contractName

string

大写合约名称 如E-BTC-USDT

limit

string

分页条数, 默认100; 最大1000

fromId

long

从这条记录开始检索

[
    {
        "side":"SELL",
        "positionType":2,
        "tradeFee":-5.23575,
        "realizedAmount":0,
        "leverageLevel":26,
        "openPrice":44500,
        "settleProfit":0,
        "mtime":1632882739000,
        "shareAmount":0,
        "openEndPrice":44500,
        "closeProfit":-45,
        "volume":900,
        "contractId":1,
        "historyRealizedAmount":-50.23575,
        "ctime":1632882691000,
        "id":8764,
        "capitalFee":0
    }
]

如果该接口返回与期望不符，请联系技术团队，我们会为您提供相关帮助

交易记录

GET https://futuresopenapi.xxx.com/fapi/v1/myTrades

限速规则: 20次/2s

Query Parameters

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

limit

string

分页条数, 默认100; 最大1000

fromId

long

从这个tradeId开始检索

Headers

Name
Type
Description

X-CH-SIGN

string

签名

X-CH-APIKEY

string

您的API-key

X-CH-TS

integer

时间戳

[
    {
        "amount": 0.30000000000000000000000000000000,
        "side": "BUY",
        "fee": "0.000075",
        "isMaker": true,
        "isBuyer": true,
        "bidId": 1874564572563538130,
        "bidUserId": 10034,
        "price": 10.0000000000000000,
        "qty": 3,
        "askId": 1954072405852309104,
        "contractName": "E-ETH-USDT",
        "time": 1701419186000,
        "tradeId": 1528,
        "askUserId": 10378
    },
    {
        "amount": 1.00000000000000000000000000000000,
        "side": "BUY",
        "fee": "0.00025",
        "isMaker": true,
        "isBuyer": true,
        "bidId": 1874564572563538059,
        "bidUserId": 10034,
        "price": 10.0000000000000000,
        "qty": 10,
        "askId": 1954072405852309104,
        "contractName": "E-ETH-USDT",
        "time": 1701419186000,
        "tradeId": 1527,
        "askUserId": 10378
    }
]
名称
类型
例子
描述

tradeId

number

28457

交易ID

bidId

long

150695552109032492

买方订单ID

askId

long

150695552109032493

卖方订单ID

bidUserId

integer

10024

买方用户ID

askUserId

integer

10025

卖方用户ID

price

float

4.01

成交价格

qty

float

12

交易数量

amount

float

5.38

成交金额

time

number

1499865549590

交易时间戳

fee

number

0.001

交易手续费

side

string

buy

当前订单方向 BUY 买入, SELL 卖出

contractName

string

E-BTC-USDT

大写合约名称

isMaker

boolean

true

是否是maker

isBuyer

boolean

true

是否买方

更改持仓模式

POST https://futuresopenapi.xxx.com/fapi/v1/edit_user_position_model

Headers

Name
Type
Description

X-CH-TS*

integer

时间戳

X-CH-APIKEY*

string

您的API-key

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

positionModel*

integer

持仓模式 （1.净持仓 2.双向持仓）传入1或者2

{ 
    "code": "0", 
    "msg": "成功", 
    "data": null 
}

更改保证金模式

POST https://futuresopenapi.xxx.com/fapi/v1/edit_user_margin_model

Headers

Name
Type
Description

X-CH-TS*

integer

时间戳

X-CH-APIKEY*

string

您的API-key

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

marginModel*

integer

保证金模式 （1.全仓 2.逐仓）传入1或者2

{ 
    "code": "0", 
    "msg": "成功", 
    "data": null 
}

更改杠杆倍数

POST https://futuresopenapi.xxx.com/fapi/v1/edit_lever

Headers

Name
Type
Description

X-CH-TS*

integer

时间戳

X-CH-APIKEY*

string

您的API-key

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

nowLevel*

integer

需要修改的杠杆倍数 如50

{ 
    "code": "0", 
    "msg": "成功", 
    "data": null 
}

获取当前条件单

POST https://futuresopenapi.xxx.com/fapi/v1/trigger_order_list

Headers

Name
Type
Description

X-CH-TS*

integer

时间戳

X-CH-APIKEY*

string

您的API-key

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

page

integer

当前页数，默认为1

limit

integer

分页条数,默认1000条

{
    "code":"0",
    "msg":"成功",
    "data":{
        "count":2,
        "trigOrderList":[
            {
                "mtime":1706513208000,
                "price":0,
                "ctime":1706513208000,
                "contractName":"BTCUSDT",
                "id":"895",
                "triggerOrderId":"1322738336974712829",
                "pricePrecision":3,
                "side":"BUY",
                "triggerPrice":11111,
                "multiplier":0.0001,
                "marginCoin":"USDT",
                "volume":100,
                "expireTime":1707722808000,
                "contractId":127,
                "triggerType":4,
                "open":"OPEN",
                "status":0
            },
            {
                "mtime":1705978532000,
                "price":0,
                "ctime":1705978532000,
                "contractName":"BTCUSDT",
                "id":"782",
                "triggerOrderId":"1322738336974712828",
                "pricePrecision":3,
                "side":"SELL",
                "triggerPrice":10000,
                "multiplier":0.0001,
                "marginCoin":"USDT",
                "volume":10,
                "expireTime":1707188132000,
                "contractId":127,
                "triggerType":1,
                "open":"CLOSE",
                "status":0
            }
        ]
    }
}
名称
类型
例子
描述

id

long

782

条件单归集表id

triggerOrderId

long

1322738336974712828

条件单id

contractId

long

127

合约id

contractName

string

BTCUSDT

合约名

marginCoin

string

USDT

保证金币种

multiplier

float

0.0001

合约面值

triggerPrice

float

10000

触发价格

price

float

0

下单价格

pricePrecision

integer

3

价格精度

volume

float

100

下单数量

open

string

OPEN

开平仓方向(open 开仓，close 平仓)

side

string

BUY

买卖方向（buy 买入，sell 卖出）

status

integer

0

有效状态 0有效

expireTime

long

1707722808000

订单过期时间

ctime

long

1705978532000

创建时间

mtime

long

1705978532000

修改时间

triggerType

integer

1

条件单类型1 stop loss，2 take profit，3 stop loss limit，4 take profit limit

取消条件单

POST https://futuresopenapi.xxx.com/v1/inner/trigger_order_cancel

Headers

Name
Type
Description

X-CH-TS*

integer

时间戳

X-CH-APIKEY*

string

您的API-key

X-CH-SIGN*

string

签名

Request Body

Name
Type
Description

contractName*

string

大写合约名称 如 E-BTC-USDT

orderId*

long

1322738336974712828

{ 
    "code": "0", 
    "msg": "成功", 
    "data": null 
}

账户

安全类型: USER_DATA

账户下方的接口都需要签名和API-key验证

账户信息

GET https://futuresopenapi.xxx.com/fapi/v1/account

限速规则: 20次/2s

Headers

Name
Type
Description

X-CH-SIGN

string

签名

X-CH-APIKEY

string

您的API-key

X-CH-TS

integer

时间戳

{
    "account": [
        {
            "marginCoin": "USDT",
            "accountNormal": 999.5606,
            "accountLock": 23799.5017,
            "partPositionNormal": 9110.7294,
            "totalPositionNormal": 0,
            "achievedAmount": 4156.5072,
            "unrealizedAmount": 650.6385,
            "totalMarginRate": 0,
            "totalEquity": 99964804.560,
            "partEquity": 13917.8753,
            "totalCost": 0,
            "sumMarginRate": 873.4608,
            "positionVos": [
                {
                    "contractId": 1,
                    "contractName": "E-BTC-USDT",
                    "contractOtherName": "BTC-USDT",
                    "contractSymbol": "BTC-USDT",
                    "positions": [
                        {
                            "id": 13603,
                            "uid": 10023,
                            "contractId": 1,
                            "positionType": 2,
                            "side": "BUY",
                            "volume": 69642.0,
                            "openPrice": 11840.2394,
                            "avgPrice": 11840.3095,
                            "closePrice": 12155.3005,
                            "leverageLevel": 24,
                            "openAmount": 0.0600000000000000,
                            "holdAmount": 7014.2111,
                            "closeVolume": 40502.0,
                            "pendingCloseVolume": 0,
                            "realizedAmount": 8115.9125,
                            "historyRealizedAmount": 1865.3985,
                            "tradeFee": -432.0072,
                            "capitalFee": 2891.2281,
                            "closeProfit": 8117.6903,
                            "shareAmount": 0.1112,
                            "freezeLock": 0,
                            "status": 1,
                            "ctime": "2020-12-11T17:42:10",
                            "mtime": "2020-12-18T20:35:43",
                            "brokerId": 21,
                            "lockTime": "2023-12-05T13:53:04",
                            "marginRate": 0.2097,
                            "reducePrice": 9740.8083,
                            "returnRate": 0.3086,
                            "unRealizedAmount": 2164.5289,
                            "openRealizedAmount": 2165.0173,
                            "positionBalance": 82458.2839,
                            "settleProfit": 0.4883,
                            "totalMargin": 0.8351780179968750,
                            "indexPrice": 12151.1175,
                            "keepRate": 0.005,
                            "maxFeeRate": 0.0025
                        }
                    ]
                }
            ]
        }
    ]
}
名称
类型
描述

account

[]

余额集合

Previous现货交易NextWebsocket推送

Last updated