English
NAV
HTTP SHELL JAVA GO PYTHON PHP Node.js

文档说明

接口示例

下方接口为获取服务器时间的接口，以该接口作为示例，展示接口格式、访问链接和参数说明描述。

获取服务器时间

GET https://openapi.fameex.net/sapi/v1/time

获取服务器时间

请求示例

GET https://openapi.fameex.net/sapi/v1/time

返回示例

{
    "timezone": "China Standard Time",
    "serverTime": 1705039779880
}

返回参数

参数名 类型 示例 描述
timezone string China Standard Time 服务器时区
serverTime long 1705039779880 服务器时间戳

文档入参规范

入参名称的带有红色*号，说明该参数为必传，反之为非必传。

接口对入参字符大小写敏感，在接口中会明确指明。如写明需要输入大写的币对名称，则需要输入BTCUSDT，输入小写的btcusdt是不被允许的。

文档中的入参有明确的类型说明，需要按照指定的类型输入。如integer类型只能输入数字类型，3的输入是正确的，但"3"的输入是不被允许的。

接口是否需要签名验证

接口类型分为：公共、行情、交易、账户。

返回码的类型

见 返回码类型

API基本信息

HTTP返回代码

返回示例

{
    "code": -1121,
    "msg": "Invalid symbol."
}

接口通用信息

访问限制

接口鉴权类型

鉴权类型 描述
NONE 不需要鉴权的接口
TRADE 需要有效的API-KEY和签名
USER_DATA 需要有效的API-KEY和签名
USER_STREAM 需要有效的API-KEY
MARKET_DATA 需要有效的API-KEY

需要签名的接口 (TRADE 与 USER_DATA)

时间同步安全

if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow) {
  // process request
} else {
  // reject request
}

POST /sapi/v1/order/test 的示例

以下是在linux bash环境下使用echo，openssl和curl工具实现的一个调用接口下单的示例，其中apikey、secretKey仅供示范，请将其替换为您的真实apiKey和secretKey。

Key Value
apiKey vmPUZE6mv9SD5V5e14y7Ju91duEh8A
secretKey 902ae3cb34ecee2779aa4d3e1d226686
参数名 取值
symbol BTCUSDT
side BUY
type LIMIT
volume 1
price 9300

签名示例

body

{"symbol":"BTCUSDT","price":"9300","volume":"1","side":"BUY","type":"LIMIT"}

HMAC-SHA256 签名

echo -n "1588591856950POST/sapi/v1/order/test{\"symbol\":\"BTCUSDT\",\"price\":\"9300\",\"volume\":\"1\",\"side\":\"BUY\",\"type\":\"LIMIT\"}" | openssl dgst -sha256 -hmac "902ae3cb34ecee2779aa4d3e1d226686"
(stdin)= c50d0a74bb9427a9a03933d0eded03af9bf50115dc5b706882a4fcf07a26b761

curl

curl -H "X-CH-APIKEY: c3b165fd5218cdd2c2874c65da468b1e" -H "X-CH-SIGN: c50d0a74bb9427a9a03933d0eded03af9bf50115dc5b706882a4fcf07a26b761

返回码类型

异常码和错误码的描述和原因

10XX - 通用服务器和网络错误

Code:-1000 UNKNOWN

msg：处理请求时发生未知错误

原因：处理请求时发生未知错误

Code:-1001 DISCONNECTED

msg：内部错误；无法处理您的请求。请再试一次

原因：内部错误；无法处理您的请求

Code:-1002 UNAUTHORIZED

msg：您无权执行此请求。请求需要发送API Key，我们建议在所有的请求头附加X-CH-APIKEY

原因：请求头中缺少X-CH-APIKEY

Code:-1003 TOO_MANY_REQUESTS

msg：请求过于频繁超过限制

原因：请求过于频繁超过限制

Code:-1004 NO_THIS_COMPANY

msg：您无权执行此请求 user not exit

原因：您无权执行此请求 user not exit

Code:-1006 UNEXPECTED_RESP

msg：接收到了不符合预设格式的消息，下单状态未知

原因：接收到了不符合预设格式的消息，下单状态未知

Code:-1007 TIMEOUT

msg：等待后端服务器响应超时。发送状态未知；执行状态未知

原因：请求超时

Code:-1014 UNKNOWN_ORDER_COMPOSITION

msg：不支持的订单组合

原因：订单组合不存在或输入了错误的订单组合

Code:-1015 TOO_MANY_ORDERS

msg：订单太多。请减少你的订单数量

原因：下单数量超过最大数量限制

Code:-1016 SERVICE_SHUTTING_DOWN

msg：服务器下线

原因：服务器已下线，无法访问该接口

Code:-1017 NO_CONTENT_TYPE

msg：我们建议在所有的请求头附加Content-Type，并设置成application/json

原因：请求头中缺少Content-Type

Code:-1020 UNSUPPORTED_OPERATION

msg：不支持此操作

原因：进行了错误的请求操作，需要同技术团队进行对接解决

Code:-1021 INVALID_TIMESTAMP

msg：无效的时间戳，时间偏移过大

原因：时间戳偏移偏大，服务器根据请求中的时间戳判定客户端时间比服务器时间提前了1秒钟以上

Code:-1022 INVALID_SIGNATURE

msg：无效的签名

原因：签名验证失败

Code:-1023 UNAUTHORIZED

msg：您无权执行此请求。请求需要发送timestamp，我们建议在所有的请求头附加X-CH-TS

原因：请求头中缺少X-CH-TS

Code:-1024 UNAUTHORIZED

msg：您无权执行此请求。请求需要发送sign，我们建议在所有的请求头附加X-CH-SIGN

原因：请求头中缺少X-CH-SIGN

11XX - 请求内容中的问题

Code:-1100 ILLEGAL_CHARS

msg：请求中存在非法字符

原因：请求中存在非法字符

Code:-1101 TOO_MANY_PARAMETERS

msg：发送的参数太多

原因：参数内容过多或检测到的参数值重复

Code:-1102 MANDATORY_PARAM_EMPTY_OR_MALFORMED

msg：强制参数{0}未发送，为空/或格式错误

原因：参数为空，必传参数未传或不正确的入参格式

Code:-1103 UNKNOWN_PARAM

msg：发送了未知参数

原因：请求参数中的参数内容或者格式错误，请检查是否字段中包含空格

Code:-1104 UNREAD_PARAMETERS

msg：并非所有发送的参数都被读取

原因：并非所有发送的参数都被读取；读取了'％s'参数，但被发送了'％s'

Code:-1105 PARAM_EMPTY

msg：参数{0}为空

原因：必传参数为空

Code:-1106 PARAM_NOT_REQUIRED

msg：不需要发送此参数

原因：不需要发送参数'％s'

Code:-1111 BAD_PRECISION

msg：精度超过此资产定义的最大值

原因：精度超过此资产定义的最大值

Code:-1112 NO_DEPTH

msg：交易对没有挂单

原因：需要取消的该订单不存在

Code:-1116 INVALID_ORDER_TYPE

msg：无效订单类型

原因：无效订单类型

Code:-1117 INVALID_SIDE

msg：无效买卖方向

原因：无效买卖方向

Code:-1121 BAD_SYMBOL

msg：无效的合约

原因：币对名称输入错误或合约名称输入错误

Code:-1136 ORDER_QUANTITY_TOO_SMALL

msg：订单数量小于最小值

原因：订单quantity小于最小值

Code:-1138 ORDER_PRICE_WAVE_EXCEED

msg：订单价格超出允许范围

原因：订单价格超出允许范围

Code:-1139 ORDER_NOT_SUPPORT_MARKET

msg：该币对不支持市价交易

原因：该交易对不支持市价交易

Code:-1145 ORDER_NOT_SUPPORT_CANCELLATION

msg：该订单状态不允许撤销

原因：订单不能够被取消

Code:-1147 PRICE_VOLUME_PRESION_ERROR

msg：价格或数量精度超过最大限制

原因：订单的价格或数量超过最大限制

2XXX - 其他相关返回码

Code:-2013 NO_SUCH_ORDER

msg：订单不存在

原因：订单不存在

Code:-2015 REJECTED_API_KEY

msg：无效的API密钥，IP或操作权限

原因：签名或IP不通过

Code:-2016 EXCHANGE_LOCK

msg：交易被冻结

原因：该用户交易被冻结

Code:-2017 BALANCE_NOT_ENOUGH

msg：余额不足

原因：用户该账户中余额不足

Code:-2100 PARAM_ERROR

msg：参数问题

原因：参数输入错误

Code:-2200 ORDER_CREATE_FAILS

msg：Illegal IP

原因：不是信任的IP

Code:35

msg：禁止下单

原因：用户交易可能被限制

枚举类型

交易对

订单状态

订单种类

订单方向

K线间隔

min -> 分钟；h -> 小时；day -> 天；week -> 周；month -> 月

现货交易

公共

安全类型: None

测试连接

GET https://openapi.fameex.netsapi/v1/ping

测试REST API的连通性

请求示例

GET https://openapi.fameex.net/sapi/v1/ping

服务器时间

GET https://openapi.fameex.net/sapi/v1/time

获取服务器时间

请求示例

GET https://openapi.fameex.net/sapi/v1/time

返回示例

{
    "timezone": "GMT+08:00",
    "serverTime": 1595563624731
}

返回参数

参数名 类型 示例 描述
timezone string China Standard Time 服务器时区
serverTime long 1705039779880 服务器时间戳

币对列表

GET https://openapi.fameex.net/sapi/v1/symbols

获取市场支持的币对集合

请求示例

GET https://openapi.fameex.net/sapi/v1/symbols

返回示例

{
    "symbols": [
        {
            "quantityPrecision": 3,
            "limitVolumeMin": 0.0001,
            "symbol": "sccadai",
            "pricePrecision": 6,
            "marketBuyMin": 0.0001,
            "marketSellMin": 0.0001,
            "baseAsset": "SCCA",
            "limitPriceMin": 0.001,
            "quoteAsset": "DAI"
        },
        {
            "quantityPrecision": 8,
            "limitVolumeMin": 0.0001,
            "symbol": "btcusdt",
            "pricePrecision": 2,
            "marketBuyMin": 0.0001,
            "marketSellMin": 0.0001,
            "baseAsset": "BTC",
            "limitPriceMin": 0.001,
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 3,
            "limitVolumeMin": 0.0001,
            "symbol": "bchusdt",
            "pricePrecision": 2,
            "marketBuyMin": 0.0001,
            "marketSellMin": 0.0001,
            "baseAsset": "BCH",
            "limitPriceMin": 0.001,
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "limitVolumeMin": 0.0001,
            "symbol": "etcusdt",
            "pricePrecision": 2,
            "marketBuyMin": 0.0001,
            "marketSellMin": 0.0001,
            "baseAsset": "ETC",
            "limitPriceMin": 0.001,
            "quoteAsset": "USDT"
        },
        {
            "quantityPrecision": 2,
            "limitVolumeMin": 0.0001,
            "symbol": "ltcbtc",
            "pricePrecision": 6,
            "marketBuyMin": 0.0001,
            "marketSellMin": 0.0001,
            "baseAsset": "LTC",
            "limitPriceMin": 0.001,
            "quoteAsset": "BTC"
        }
    ]
}

返回参数

参数名 类型 示例 描述
symbol string btcusdt 小写币对名称
baseAsset string BTC 基准货币
quoteAsset string USDT 计价货币
pricePrecision integer 6 价格精度
quantityPrecision integer 3 数量精度
limitVolumeMin BigDecimal 0.0001 限价单最小数量限制
marketBuyMin BigDecimal 0.0001 市价单最小购买数量
marketSellMin BigDecimal 0.0001 市价单最小卖出数量
limitPriceMin BigDecimal 0.001 限价单最小价格限制

行情

安全类型: None

订单薄

GET https://openapi.fameex.net/sapi/v1/depth

获取市场订单薄深度信息

请求示例

GET https://openapi.fameex.net/sapi/v1/depth?symbol=BTCUSDT&limit=100

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT
limit* integer 默认：100；最大：100

返回示例

{
    "time": 1701658276000,
    "bids": [
        [
            3.90000000,     // 价格
            43.10000000    // 数量
        ],
        [
            4.00000000,
            19.20000000
        ]
    ],
    "asks": [
        [
            4.00000200,     // 价格
            12.00000000     // 数量
        ],
        [
            5.10000000,
            28.00000000
        ]
    ]
}

返回参数

参数名 类型 示例 描述
time long 1595563624731 当前时间戳
bids array [[3.9,43.1],[4.0,19.2]] 订单薄买盘信息，数组长度为2，角标1为价格，类型为float；角标2为当前价格对应的数量，类型为float
asks array [[4.0,12.0],[5.1,28.0]] 订单薄卖盘信息，数组长度为2，角标1为价格，类型为float；角标2为当前价格对应的数量，类型为float

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

行情Ticker

GET https://openapi.fameex.net/sapi/v1/ticker

获取24小时价格变化数据

请求示例

GET https://openapi.fameex.net/sapi/v1/ticker?symbol=BTCUSDT

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT

返回示例

{
    "amount": 22400.0,
    "high": 9900.51,
    "vol": 4691.0,
    "last": 9211.60,
    "low": 9100.34,
    "buy": 9210.0,
    "sell": 9213.0,
    "rose": "+0.05",
    "time": 1595563624731
}

返回参数

参数名 类型 示例 描述
time long 1595563624731 当前时间戳
high float 9900.51 最高价
low float 9100.34 最低价
last float 9211.60 最新成交价
vol float 4691.0 交易量
amount float 22400.0 交易额
buy float 9210.0 买一价格
sell float 9213.0 卖一价格
rose string +0.05 涨跌幅，+为涨，-为跌，+0.05为涨5%

最近成交

GET https://openapi.fameex.net/sapi/v1/trades

获取最近成交数据

请求示例

GET https://openapi.fameex.net/sapi/v1/trades?symbol=BTCUSDT&limit=100

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT
limit* string 默认：100；最大：1000

返回示例

[
    {
        "side": "buy",
        "price": 131.0000000000000000,
        "qty": 0.1000000000000000,
        "time": 1704788645416
    },
    {
        "side": "sell",
        "price": 132.0000000000000000,
        "qty": 0.2000000000000000,
        "time": 1704788282332
    }
]

返回参数

参数名 类型 示例 描述
price float 131.0000000000000000 交易价格
time long 1704788645416 当前时间戳
qty float 0.1000000000000000 数量（张数）
side string buy/sell 主动单方向

K线/蜡烛图数据

GET https://openapi.fameex.net/sapi/v1/klines

获取K线数据

请求示例

GET https://openapi.fameex.net/sapi/v1/klines?symbol=BTCUSDT&interval=1min&limit=100

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT
interval* string K线图区间，可识别发送的值为：1min，5min，15min，30min，60min，1day，1week，1month（min=分钟，day=天，week=星期，month=月）
limit integer 默认：100；最大：300

返回示例

[
    {
        "high": 6228.77,
        "vol": 2456.11,
        "low": 6220.13,
        "idx": 1594640340000,
        "close": 6225.63,
        "open": 6129.41
    },
    {
        "high": 6228.77,
        "vol": 1700.21,
        "low": 6228.77,
        "idx": 1587632160000,
        "close": 6228.77,
        "open": 6228.77
    },
    {
        "high": 6228.77,
        "vol": 1908.52,
        "low": 6228.77,
        "idx": 1587632100000,
        "close": 6228.77,
        "open": 6228.77
    }
]

返回参数

参数名 类型 示例 描述
idx long 1538728740000 开始时间戳
open float 6129.41 开盘价
close float 6225.63 收盘价
high float 6228.77 最高价
low float 6220.13 最低价
vol float 2456.11 成交量

交易

安全类型: TRADE

创建新订单

POST https://openapi.fameex.net/sapi/v1/order

限速规则: 100次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求示例

POST https://openapi.fameex.net/sapi/v1/order

body
{
    "symbol": "BTCUSDT",
    "volume": 1.00,
    "side": "BUY",
    "type": "LIMIT",
    "price": 65000.00,
    "newClientOrderId": "111000000111"
}

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT
volume* number 订单数量，有精度限制，精度由管理员配置
side* string 订单方向，BUY/SELL
type* string 订单类型，LIMIT/MARKET
price number 订单价格，对于LIMIT订单必须发送，有精度限制，精度由管理员配置
newClientOrderId string 客户端订单标识

返回示例

{
    "symbol": "ETHUSDT",
    "side": "BUY",
    "executedQty": 0,
    "orderId": [
        "2012274607240433332"
    ],
    "price": 47651.29,
    "origQty": 0.01,
    "clientOrderId": "213443",
    "transactTime": 1704959985403,
    "type": "MARKET",
    "status": "NEW"
}

返回参数

参数名 类型 示例 描述
orderId long 2012274607240433332 订单ID（系统生成）
clientOrderId string 213443 订单ID（用户生成）
symbol string BTCUSDT 大写币对名称
transactTime integer 1704959985403 订单创建时间戳
price float 47651.29 订单价格
origQty float 0.01 订单数量
executedQty float 0 已经成交订单数量
type string LIMIT 订单类型。可能出现的值只能为：LIMIT(限价)和MARKET（市价）
side string BUY 订单方向。可能出现的值只能为：BUY（买入做多）和SELL（卖出做空）
status string NEW 订单状态。可能出现的值为：New Order（新订单，无成交）、Partially Filled（部分成交）、Filled（全部成交）

创建测试订单

POST https://openapi.fameex.net/sapi/v1/order/test

创建和验证新订单, 但不会送入撮合引擎

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求示例

POST https://openapi.fameex.net/sapi/v1/order/test

body
{
    "symbol": "BTCUSDT",
    "volume": 1.00,
    "side": "BUY",
    "type": "LIMIT",
    "price": 65000.00,
    "newClientOrderId": "111000001111"
}

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如BTCUSDT
volume* number 订单数量，有精度限制，由管理员配置
side* string 订单方向，BUY/SELL
type* string 订单类型，LIMIT/MARKET
price number 订单价格，对于LIMIT订单必须发送，有精度限制，由管理员配置
newClientOrderId string 客户端订单标识

返回示例

{}

订单查询

GET https://openapi.fameex.net/sapi/v1/order

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求示例

GET https://openapi.fameex.net/sapi/v1/order?symbol=ethusdt&orderID=111000111

请求参数

参数名 类型 描述
orderId* string 订单id
symbol* string 小写币对名称，例如：ethusdt

返回示例

{
    "symbol": "ethusdt",
    "side": "BUY",
    "executedQty": 0,
    "orderId": 150695552109032492,
    "price": 4765.29,
    "origQty": 1.01,
    "avgPrice": 4754.24,
    "transactTime": 1672274311107,
    "type": "LIMIT",
    "status": "New Order"
}

返回参数

参数名 类型 示例 描述
orderId long 150695552109032492 订单ID（系统生成）
clientOrderId string 213443 订单ID（用户生成）
symbol string ethusdt 小写币对名称
price float 4765.29 订单价格
origQty float 1.01 订单数量
executedQty float 0 已经成交订单数量
avgPrice float 4754.24 订单已经成交的平均价格
type string LIMIT 订单类型。可能出现的值只能为：LIMIT(限价)和MARKET（市价）
transactTime long 1672274311107 时间戳
side string BUY 订单方向。可能出现的值只能为：BUY（买入做多）和SELL（卖出做空）
status string New Order 订单状态。可能出现的值为：New Order(新订单，无成交)、Partially Filled（部分成交）、Filled（全部成交）

撤销订单

POST https://openapi.fameex.net/sapi/v1/cancel

限速规则: 100次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求示例

POST https://openapi.fameex.net/sapi/v1/cancel

body
{
    "symbol": "ethusdt",
    "orderId": "111000111"
}

请求参数

参数名 类型 描述
orderId* string 订单id
symbol* string 小写币对名称，例如：ethusdt

返回示例

{
    "symbol": "ethusdt",
    "orderId": [
        "1938321163093079425"
    ],
    "status": "PENDING_CANCEL"
}

返回参数

参数名 类型 示例 描述
orderId long 1938321163093079425 订单ID（系统生成）
symbol string ethusdt 币对名称
status string PENDING_CANCEL 订单状态：PENDING_CANCEL

批量撤销订单

POST https://openapi.fameex.net/sapi/v1/batchCancel

限速规则: 50次/2s 一次批量最多10个订单

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求示例

POST https://openapi.fameex.net/sapi/v1/batchCancel

body
{
    "symbol": "BTCUSDT",
    "oderIds": [111000111, 111000112]
}

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT
orderIds* array 要取消的订单id集合，id值以数字格式输入[123,456]

成功返回数据

{
    "success": [
        165964665990709251,
        165964665990709252,
        165964665990709253
    ],
    "failed": [ // 取消失败一般是因为订单不存在或订单状态已经到终态
        165964665990709250
    ]
}

失败返回数据

{} //通常是因为订单号错误，需要检查orderIds里的内容是否正确

当前订单

GET https://openapi.fameex.net/sapi/v1/openOrders

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求参数

参数名 类型 描述
symbol* string 小写币对名称，例如：ethusdt
limit* integer 最大1000

返回示例

[
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "executedQty": "0",
        "orderId": 1938321163093077686,
        "price": "0",
        "origQty": "0.10",
        "avgPrice": "0",
        "time": 1701240367864,
        "type": "MARKET",
        "status": "NEW_"
    },
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "executedQty": "0",
        "orderId": 1938321163093078022,
        "price": "0",
        "origQty": "0.01",
        "avgPrice": "0",
        "time": 1701243281850,
        "type": "MARKET",
        "status": "NEW_"
    }
]

返回参数

参数名 类型 示例 描述
orderId long 150695552109032492 订单ID（系统生成）
symbol string ETHUSDT 币对名称
price float 4765.29 订单价格
origQty float 1.01 订单数量
executedQty float 1.01 已经成交订单数量
avgPrice float 4754.24 订单已经成交的平均价格
type string LIMIT 订单类型。可能出现的值只能为：LIMIT(限价)和MARKET（市价）
time long 1701243281850 时间戳
side string BUY 订单方向。可能出现的值只能为：BUY（买入做多）和SELL（卖出做空）
status string New Order 订单状态。可能出现的值为：New Order(新订单，无成交)、Partially Filled（部分成交）、Filled（全部成交）

交易记录

GET https://openapi.fameex.net/sapi/v1/myTrades

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求示例

GET https://openapi.fameex.net/sapi/v1/myTrades?symbol=BTCUSDT&limit=100

请求参数

参数名 类型 描述
symbol* string 大写币对名称，例如：BTCUSDT
limit* string 默认：100；最大：1000

返回示例

[
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "fee": 0.00000000428,
        "isMaker": false,
        "isBuyer": true,
        "bidId": 1954603951049381893,
        "bidUserId": 10083,
        "feeCoin": "ETH",
        "price": 2334,
        "qty": 0.00000428,
        "askId": 1856176838352995447,
        "id": 159,
        "time": 1701623660989,
        "isSelf": false,
        "askUserId": 10671
    },
    {
        "symbol": "ETHUSDT",
        "side": "BUY",
        "fee": 0.00000004284,
        "isMaker": false,
        "isBuyer": true,
        "bidId": 1938321163093068889,
        "bidUserId": 10083,
        "feeCoin": "ETH",
        "price": 2334,
        "qty": 0.00004284,
        "askId": 1856176838352995447,
        "id": 158,
        "time": 1701165091964,
        "isSelf": false,
        "askUserId": 10671
    }
]

返回参数

参数名 类型 示例 描述
symbol string ETHBTC 大写币种名称
id integer 159 交易ID
bidId long 1954603951049381893 买方订单ID
askId long 1856176838352995447 卖方订单ID
price integer 2334 交易价格
qty float 0.00004284 交易数量
time number 1701165091964 交易时间戳
isBuyer boolean true true=Buyer，false=Seller
isMaker boolean false true=Maker，false=Taker
feeCoin string ETH 交易手续费币种
fee number 0.00000000428 交易手续费
bidUserId integer 10083 买方用户uid
askUserId integer 10671 卖方用户uid
isSelf boolean false 是否为自成交，true=是自成交，false=不是自成交
side string BUY 主动单方向BUY/SELL

账户

安全类型: USER_DATA

账户信息

GET https://openapi.fameex.net/sapi/v1/account

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

返回示例

{
    "balances": [
        {
            "asset": "ABAT",
            "free": "10.00",
            "locked": "20.00"
        },
        {
            "asset": "DOT",
            "free": "10.00",
            "locked": "10.00"
        },
        {
            "asset": "TT",
            "free": "50.00",
            "locked": "50.00"
        }
    ]
}

返回参数

参数名 类型 描述
balances array 账户余额集合
asset string 交易对
free string 可用余额
locked string 冻结余额

合约交易

公共

安全类型: None

测试连接

GET https://futuresopenapi.fameex.net/fapi/v1/ping

测试REST API的连通性

获取服务器时间

GET https://futuresopenapi.fameex.net/fapi/v1/time

返回示例

{
    "timezone": "China Standard Time",
    "serverTime": 1704962055664
}

返回参数

参数名 类型 示例 描述
timezone string China Standard Time 服务器时区
serverTime long 1607702400000 服务器时间戳

合约列表

GET https://futuresopenapi.fameex.net/fapi/v1/contracts

请求示例

GET https://futuresopenapi.fameex.net/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 3 价格精度
status number 1 合约状态（0：不可交易，1：可交易）
type string E 合约类型（E：永续合约，S：模拟合约，其他为混合合约）
side number 1 合约方向（0：反向，1：正向）
multiplier number 1.0000000000000000 合约面值
minOrderVolume number 1 最小下单量
minOrderMoney number 1.0000000000000000 最小下单金额
maxMarketVolume number 200000 市价单最大下单数量
maxMarketMoney number 500000.0000000000000000 市价最大下单金额
maxLimitVolume number 300000 限价单最大下单数量
maxLimitMoney number 500000.0000000000000000 限价最大下单金额
maxValidOrder number 10 最大有效委托的订单数量

行情

安全类型: None

订单薄

GET https://futuresopenapi.fameex.net/fapi/v1/depth

市场订单薄深度信息

请求示例

GET https://futuresopenapi.fameex.net/fapi/v1/depth?contractName=E-BTC-USDT&limit=100

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
limit integer 默认：100；最大：100

返回示例

{
    "time": 1704962463000,
    "bids": [
        [
            3.90000000,     //价格
            16.10000000     //数量
        ],
        [
            4.00000000,
            29.30000000
        ]
    ],
    "asks": [
        [
            4.00000200,     //价格
            12.00000000     //数量
        ],
        [
            5.10000000,
            28.00000000
        ]
    ]
}

返回参数

参数名 类型 示例 描述
time long 1595563624731 当前时间戳
bids list [[3.9,16.1],[4.0,29.3]] 订单薄买盘信息，数组第一位为价格，类型为float；第二位为当前价格对应的数量，类型为float
asks list [[4.00000200,12.0],[5.1,28.0]] 订单薄卖盘信息，数组第一位为价格，类型为float；第二位为当前价格对应的数量，类型为float

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

行情Ticker

GET https://futuresopenapi.fameex.net/fapi/v1/ticker

24小时价格变化数据

请求示例

GET https://futuresopenapi.fameex.net/fapi/v1/ticker?contractName=E-BTC-USDT

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT

返回示例

{
    "high": 56120.22,
    "vol": 51.21,
    "last": 55989.93,
    "low": 55982.24,
    "buy": 55988.10,
    "sell": 55990.10,
    "rose": "+0.05",
    "time": 1704966225000
}

返回参数

参数名 类型 示例 描述
time long 1595563624731 时间戳
high float 56120.22 最高价
low float 55982.24 最低价
last float 55989.93 最新价
vol float 51.21 交易量
rose string +0.05 涨跌幅，+为涨，-为跌，+0.05为涨5%
buy float 55988.10 买一价格
sell float 55990.10 卖一价格

获取指数/标记价格

GET https://futuresopenapi.fameex.net/fapi/v1/index

请求示例

GET https://futuresopenapi.fameex.net/fapi/v1/index?contractName=E-BTC-USDT

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
limit string 默认：100；最大：1000

返回示例

{
    "currentFundRate": -0.0037500000000000,
    "indexPrice": 27905.9800000000000000,
    "tagPrice": 27824.4422146875000000,
    "nextFundRate": -0.0037500000000000
}

返回参数

名称 类型 例子 描述
indexPrice float 27905.9800000000000000 指数价格
tagPrice float 27824.4422146875000000 标记价格
nextFundRate float -0.0037500000000000 资金费率价格
currentFundRate float -0.0037500000000000 上期资金费率（用于本期结算）

K线/蜡烛图数据

GET https://futuresopenapi.fameex.net/fapi/v1/klines

请求示例

GET https://futuresopenapi.fameex.net/fapi/v1/klines?contractName=E-BTC-USDT&interval=1min&limit=100&startTime=1111111100000&endTime=222222222000000

请求参数

参数名 类型 描述
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 开始时间戳
endTime long 结束时间戳

返回示例

[
    {
        "high": 6228.77,
        "vol": 111,
        "low": 6190.48,
        "idx": 15946403400000,
        "close": 6210.51,
        "open": 6195.80
    },
    {
        "high": 6228.77,
        "vol": 222,
        "low": 6228.77,
        "idx": 15876321600000,
        "close": 6228.77,
        "open": 6228.77
    },
    {
        "high": 6228.77,
        "vol": 333,
        "low": 6228.77,
        "idx": 15876321000000,
        "close": 6228.77,
        "open": 6228.77
    }
]

返回参数

参数名 类型 示例 描述
idx long 15946403400000 开始时间戳
open float 6195.80 开盘价
close float 6210.51 收盘价
high float 6228.77 最高价
low float 6190.48 最低价
vol float 111 成交量

交易

安全类型: TRADE

创建订单

POST https://futuresopenapi.fameex.net/fapi/v1/order

创建单个新订单

请求头

参数名 类型 描述
X-CH-TS* string 时间戳
X-CH-APIKEY* string 您的API-KEY
X-CH-SIGN* string 签名

请求示例

POST https://futuresopenapi.fameex.net/fapi/v1/order

body
{
    "contractName": "E-BTC-USDT",
    "price": 65000.00,
    "volume": 1.00,
    "type": "LIMIT",
    "side": "BUY",
    "open": "OPEN",
    "positionType": 1,
    "clientOrderId": "111000111",
    "timeInForce": "IOC"
}

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
price number 下单价格，限价单时该字段为必传，有精度限制，精度由管理员设置
volume* number 下单张数，有精度限制，精度由管理员设置，市价开仓时这里单位是价值
type* string 订单类型，LIMIT/MARKET
side* string 买卖方向，BUY/SELL
open* string 开平仓方向，OPEN/CLOSE
positionType* number 持仓类型，1:全仓/2:逐仓
timeInForce string IOC, FOK, POST_ONLY
clientOrderId string 客户端下单标识，长度小于32位的字符串

返回示例

{
    "orderId": 256609229205684228
}

返回参数

参数名 类型 示例 描述
orderId string 256609229205684228 订单ID

创建条件单

POST https://futuresopenapi.fameex.net/fapi/v1/conditionOrder

请求头

参数名 类型 描述
X-CH-TS* string 时间戳
X-CH-APIKEY* string 您的API-KEY
X-CH-SIGN* string 签名

请求示例

POST https://futuresopenapi.fameex.net/fapi/v1/conditionOrder

body
{
    "contractName": "E-BTC-USDT"
}

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
price* number 下单价格，有精度限制，精度由管理员设置
volume* number 下单数量，市价开仓时这里单位是价值，有精度限制，精度由管理员设置
type* string 订单类型，LIMIT/MARKET
side* string 买卖方向，BUY/SELL
positionType* number 持仓类型，1：全仓，2：逐仓
open* string 开平仓方向，OPEN/CLOSE
triggerType* string 条件的类型，1：止损，2：止盈，3：追涨，4：杀跌
triggerPrice* string 触发价
clientOrderId string 客户端下单标识，长度小于32位的字符串

返回示例

{
    "code": "0",
    "msg": "Success",
    "data": {
        "triggerIds": [
            "1322738336974712847"
        ],
        "ids": [

        ],
        "cancelIds": [

        ]
    },
    "succ": true
}

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

取消订单

POST https://futuresopenapi.fameex.net/fapi/v1/cancel

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
orderId* string 订单ID

返回示例

{
    "orderId": "256609229205684228"
}

取消条件单

POST https://futuresopenapi.fameex.net/fapi/v1/cancel_trigger_order

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
orderId* string 订单ID
clientOrderId string 客户端唯一标识，默认：0

返回示例

{
    "orderId": "256609229205684228"
}

订单详情

GET https://futuresopenapi.fameex.net/fapi/v1/order

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
orderId* string 订单ID
clientOrderId* string 客户端唯一标识，默认：0

返回示例

{
    "side": "BUY",
    "executedQty": 0,
    "orderId": 2006628907041292645,
    "price": 67000.0000000000000000,
    "origQty": 2.0000000000000000,
    "avgPrice": 0,
    "transactTime": 1704967622000,
    "action": "OPEN",
    "contractName": "E-BTC-USDT",
    "type": "LIMIT",
    "timeInForce": "1",
    "status": "NEW",
    "fills": [

    ]
}

返回参数

参数名 类型 示例 描述
orderId long 2006628907041292645 订单ID（系统生成
contractName string E-BTC-USDT 大写合约名称
price float 67000.0000000000000000 委托价格
origQty float 2.0000000000000000 委托数量
executedQty float 0 成交数量
avgPrice float 0 成交均价
status string NEW 订单状态。可能出现的值为：NEW（新订单，无成交）、PARTIALLY_FILLED（部分成交）、FILLED（全部成交）、CANCELED（已取消）和REJECTED（订单被拒绝）
side string BUY 订单方向。可能出现的值只能为：BUY（买入做多）和SELL（卖出做空）
action string OPEN OPEN/CLOSE
transactTime long 1704967622000 订单创建时间
type string LIMIT 订单类型LIMIT/MARKET
timeInForce integer 1 条件单有效方式，1：limit，2：market，3：IOC，4：FOK，5： POST\_ONLY
fills array 成交记录

当前订单

GET https://futuresopenapi.fameex.net/fapi/v1/openOrders

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* string 时间戳

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT

返回示例

[
    {
        "side": "BUY",
        "executedQty": 0.5,
        "orderId": 259396989397942275,
        "price": 72000.0000000000000000,
        "origQty": 1.0000000000000000,
        "avgPrice": 71990.0,
        "transactTime": 1607702400000,
        "action": "OPEN",
        "contractName": "E-BTC-USDT",
        "type": "LIMIT",
        "status": "NEW"
    }
]

返回参数

参数名 类型 示例 描述
orderId long 259396989397942275 订单ID（系统生成）
contractName string E-BTC-USDT 大写合约名称
price float 72000.0000000000000000 订单价格
origQty float 1.0000000000000000 订单数量
executedQty float 0.5 已经成交订单数量
avgPrice float 71990.0 订单已经成交的平均价格
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.fameex.net/fapi/v1/orderHistorical

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* string 时间戳

请求参数

参数名 类型 描述
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.fameex.net/fapi/v1/profitHistorical

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

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* string 时间戳

请求参数

参数名 类型 描述
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.fameex.net/fapi/v1/myTrades

限速规则: 20次/2s

请求头

参数名 类型 描述
X-CH-SIGN* string 签名
X-CH-APIKEY* string 您的API-key
X-CH-TS* integer 时间戳

请求参数

参数名 类型 描述
contractName* string 大写合约名称，例如：E-BTC-USDT
limit string 分页条数，默认：100；最大：1000
fromId long 从这个tradeId开始检索

返回示例

[
    {
        "amount": 0.30000000000000000000000000000000,
        "side": "BUY",
        "fee": 0.001,
        "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 1528 交易ID
bidId long 1874564572563538130 买方订单ID
askId long 1954072405852309104 卖方订单ID
bidUserId integer 10034 买方用户ID
askUserId integer 10378 卖方用户ID
price float 10.0 成交价格
qty float 3 交易数量
amount float 30.0 成交金额
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.fameex.net/fapi/v1/edit_user_position_model

请求头

参数名 类型 描述
X-CH-TS* integer 时间戳
X-CH-APIKEY* string 您的API-key
X-CH-SIGN* string 签名

请求参数

参数名 类型 描述
contractName* string 合约名称，例如：E-BTC-USDT
positionModel* integer 持仓模式，1：净持仓，2：双向持仓

返回示例

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

更改保证金模式

POST https://futuresopenapi.fameex.net/fapi/v1/edit_user_margin_model

请求头

参数名 类型 描述
X-CH-TS* integer 时间戳
X-CH-APIKEY* string 您的API-key
X-CH-SIGN* string 签名

请求参数

参数名 类型 描述
contractName* string 合约名称，例如：E-BTC-USDT
marginModel* integer 持仓模式，1：净持仓，2：双向持仓

返回示例

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

更改杠杆倍数

POST https://futuresopenapi.fameex.net/fapi/v1/edit_lever

请求头

参数名 类型 描述
X-CH-TS* integer 时间戳
X-CH-APIKEY* string 您的API-key
X-CH-SIGN* string 签名

Websocket

概述

WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信，使得数据可以快速地双向传播。通过一次简单的握手就可以建立客户端和服务器连接，服务器根据业务规则可以主动推送信息给客户端。其优点如下：

基本信息

心跳

为了保持连接有效且稳定，建议您进行以下操作：

  1. 每次接收到消息后，用户设置一个定时器，定时N秒，N小于30。

  2. 如果定时器被触发（N秒内没有收到新消息），发送字符串'ping'。

  3. 期待一个文字字符串'pong'作为回应。如果在N秒内未收到，请发出错误或重新连接。

心跳返回

{
    "pong": 15359750
}

Demo

Websocket Demo

订阅/取消订阅参数

event channel description
sub market_$symbol_depth_step0 订阅深度
unsub market_$symbol_depth_step0 取消订阅深度
sub market_$symbol_trade_ticker 订阅实时成交
unsub market_$symbol_trade_ticker 取消订阅实时成交
sub market_$symbol_ticker 订阅24h行情数据
unsub market_$symbol_ticker 取消订阅24h行情数据
sub market_$symbol_kline_1min 订阅1min实时K线信息
req market_$symbol_kline_1month 请求1month历史K线记录

订阅

订阅全量深度

订阅示例

{
    "event": "sub",
    "params": {
        "channel": "market_$symbol_depth_step0", // $symbol E.g. 币币：btcusdt 合约：e_btcusdt
        "cb_id": "1" // 业务id非必填
    }
}

返回示例

{
    "channel": "market_btcusdt_depth_step0",
    "ts": 1506584998239,
    "tick": {
        "asks": [ //卖盘
            [
                10000.19,
                0.93
            ],
            [
                10001.21,
                0.2
            ],
            [
                10002.22,
                0.34
            ]
        ],
        "bids": [ //买盘
            [
                9999.53,
                0.93
            ],
            [
                9998.2,
                0.2
            ],
            [
                9997.19,
                0.21
            ]
        ]
    }
}

订阅实时成交

订阅示例

{
    "event": "sub",
    "params": {
        "channel": "market_$symbol_trade_ticker", // $symbol E.g. 币币: btcusdt，合约: e_btcusdt
        "cb_id": "1" // 业务id非必填
    }
}

返回示例

{
    "channel": "market_$symbol_trade_ticker",
    "ts": 1506584998239, // 请求时间
    "tick": {
        "id": 12121, // data中最大交易ID
        "ts": 1506584998239, // data中最大时间
        "data": [
            {
                "side": "buy", // 买卖方向buy，sell
                "price": 32.233, // 单价
                "vol": 232, // 数量
                "amount": 323, // 总额
                "ds": "2017-09-1023: 12: 21"
            }
        ]
    }
}

订阅K线行情

订阅示例

{
    "event": "sub",
    "params": {
        "channel": "market_$symbol_kline_[1min/5min/15min/30min/60min/1day/1week/1month]", // $symbol E.g. btcusdt
        "cb_id": "1" // 业务id非必填
    }
}

返回示例

{
    "channel": "market_$symbol_kline_1min", // 1min代表1分钟K线
    "ts": 1506584998239, // 请求时间
    "tick": {
        "id": 1506602880, // 时间刻度起始值
        "vol": 1212.12211, // 交易量
        "open": 2233.22, // 开盘价
        "close": 1221.11, // 收盘价
        "high": 22322.22, // 最高价
        "low": 2321.22 // 最低价
    }
}

订阅24h行情Ticker

订阅示例

{
    "event": "sub",
    "params": {
        "channel": "market_$symbol_ticker", // $symbol E.g. 币币：btcusdt 合约：e_btcusdt
        "cb_id": "1" // 业务id非必填
    }
}

返回示例

{
    "channel": "market_$symbol_ticker",
    "ts": 1506584998239, // 请求时间
    "tick": {
        "amount": 123.1221, // 交易额
        "vol": 1212.12211, // 交易量
        "open": 2233.22, // 开盘价
        "close": 1221.11, // 收盘价
        "high": 22322.22, // 最高价
        "low": 2321.22, // 最低价
        "rose": -0.2922, // 涨幅
    }
}

请求K线历史数据

订阅示例

{
    "event": "req",
    "params": {
        "channel": "market_$symbol_kline_[1min/5min/15min/30min/60min/1day/1week/1month]",
        "cb_id": "1",
        "endIdx": "1506602880", // 返回endIdx前pageSize条数据 非必填
        "pageSize": 100 // 非必填
    }
}

返回示例

{
    "event_rep": "rep",
    "channel": "market_$symbol_kline_5min",
    "cb_id": "原路返回",
    "ts": 1506584998239, // 请求时间
    "data": [ // 最多300条
        {
            "id": 1506602880, // 时间刻度起始值
            "amount": 123.1221, // 交易额
            "vol": 1212.12211, // 交易量
            "open": 2233.22, // 开盘价
            "close": 1221.11, // 收盘价
            "high": 22322.22, // 最高价
            "low": 2321.22 // 最低价
        },
        {
            "id": 1506602880, // 时间刻度起始值
            "amount": 123.1221, // 交易额
            "vol": 1212.12211, // 交易量
            "open": 2233.22, // 开盘价
            "close": 1221.11, // 收盘价
            "high": 22322.22, // 最高价
            "low": 2321.22 // 最低价
        }
    ]
}

请求成交记录

请求示例

{
    "event": "req",
    "params": {
        "channel": "market_$symbol_trade_ticker", // $symbol E.g. 币币：btcusdt 合约：e_btcusdt
        "cb_id": "1" // 业务id非必填
    }
}

返回示例

{
    "event_rep": "rep",
    "channel": "market_$symbol_trade_ticker",
    "cb_id": "原路返回",
    "ts": 1506584998239,
    "status": "ok",
    "data": [
        {
            "side": "buy", // 买卖方向buy，sell
            "price": 32.233, // 单价
            "vol": 232, // 数量
            "amount": 323 // 总额
        },
        {
            "side": "buy", // 买卖方向buy，sell
            "price": 32.233, // 单价
            "vol": 232, // 数量
            "amount": 323 // 总额
        }
    ]
}

SDK开发库

签名示例

Java

/**
 * 生成sign
 **/
private String toSign(String timestamp, String method, String requestPath,
                             String queryString, String body, String secretKey) throws Exception {
    // 签名串
    String preHash = preHash(timestamp, method, requestPath, queryString, body);
    byte[] secretKeyBytes = secretKey.getBytes("UTF-8");
    SecretKeySpec secretKeySpec = new SecretKeySpec(secretKeyBytes, "HmacSHA256");
    Mac mac = (Mac) MAC.clone();
    mac.init(secretKeySpec);
    return Hex.encodeHexString(mac.doFinal(preHash.getBytes("UTF-8")));
}

/**
 * 签名串
 **/
private String preHash(String timestamp, String method, String requestPath, String queryString, String body) {

    StringBuilder preHash = new StringBuilder();
    preHash.append(timestamp);
    preHash.append(method.toUpperCase());
    preHash.append(requestPath);
    if (org.apache.commons.lang3.StringUtils.isNotEmpty(queryString)) {
        preHash.append("?").append(queryString);
    }
    if (org.apache.commons.lang3.StringUtils.isNotEmpty(body)) {
        preHash.append(body);
    }
    return preHash.toString();
}

/**
 * queryString
 **/
private String queryString(ServerHttpRequest request) {
    String url = request.getURI().toString();
    String queryString = "";
    if (url.contains("?")) {
        queryString = url.substring(url.lastIndexOf("?") + 1);
    }
    return queryString;
}

创建订单示例

Java

OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"symbol\":\"BTCUSDT\",\"volume\":1,\"side\":\"BUY\",\"type\":\"LIMIT\",\"price\":10000,\"newClientOrderId\":\"\",\"recvWindow\":5000}");
Request request = new Request.Builder()
.url("https://openapi.fameex.net")
.method("POST", body)
.addHeader("X-CH-APIKEY", "Your API key")
.addHeader("X-CH-TS", "1596543296058")
.addHeader("Content-Type", "application/json")
.addHeader("X-CH-SIGN", "encrypt sign")
.build();
Response response = client.newCall(request).execute();

Go

package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
  url := "https://openapi.fameex.net"
  method := "POST"
  payload := strings.NewReader("{\"symbol\":\"BTCUSDT\",\"volume\":1,\"side\":\"BUY\",\"type\":\"LIMIT\",\"price\":10000,\"newClientOrderId\":\"\",\"recvWindow\":5000}")
  client := &http.Client {
}
  req, err := http.NewRequest(method, url, payload)
if err != nil {
    fmt.Println(err)
}
  req.Header.Add("X-CH-APIKEY", "Your API key")
  req.Header.Add("X-CH-TS", "1596543881257")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-CH-SIGN", "encrypt sign")
  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)
  fmt.Println(string(body))
}

Python

import requests
url = "https://openapi.fameex.net"
payload = "{\"symbol\":\"BTCUSDT\",\"volume\":1,\"side\":\"BUY\",\"type\":\"LIMIT\",\"price\":10000,\"newClientOrderId\":\"\",\"recvWindow\":5000}"
headers = {
'X-CH-APIKEY': 'Your API key',
'X-CH-TS': '1596543881257',
'Content-Type': 'application/json',
'X-CH-SIGN': 'encrypt sign'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))

PHP

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://openapi.fameex.net');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'X-CH-APIKEY' => 'Your API key',
'X-CH-TS' => '1596543881257',
'Content-Type' => 'application/json',
'X-CH-SIGN' => 'encrypt sign'
));
$request->setBody('{"symbol":"BTCUSDT","volume":1,"side":"BUY","type":"LIMIT","price":10000,"newClientOrderId":"","recvWindow":5000}');
try {
  $response = $request->send();
if ($response->getStatus() == 200) {
    echo $response->getBody();
}
else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

Node.js

var request = require('request');
var options = {
'method': 'POST',
'url': 'https://openapi.fameex.net',
'headers': {
'X-CH-APIKEY': 'Your API key',
'X-CH-TS': '1596543881257',
'Content-Type': 'application/json',
'X-CH-SIGN': 'encrypt sign'
},
  body: JSON.stringify({"symbol":"BTCUSDT","volume":1,"side":"BUY","type":"LIMIT","price":10000,"newClientOrderId":"","recvWindow":5000})
};
request(options, function (error, response) {
if (error) throw new Error(error);
  console.log(response.body);
});

常见问题

请求接口的timestamp参数和到达服务器时间最大差值是多少？

服务器收到请求时会判断请求中的时间戳，如果是5000毫秒之前发出的，则请求会被认为无效。这个时间窗口值可以通过发送可选参数recvWindow来自定义。

请求头"X-CH-TS"不能为空，如何解决？

首先建议用户打印一下X-CH-TS，出现异常时检查X-CH-TS是否为空，另外建议用户对代码优化，每次请求前先判断X-CH-TS是否为空。

为什么签名认证总返回无效的签名？

可以打印出请求头信息和签名前字符串，重点有以下几点：

请求头示例：

Content-Type: application/json

X-CH-APIKEY: 44c541a1-****-****-****-10fe390df2

X-CH-SIGN: ssseLeefrffraoEQ3yI9qEtI1CZ82ikZ4xSG5Kj8gnl3uw=

X-CH-TS: 1574327555669

GET示例

1588591856950GET/sapi/v1/account

POST示例

1588591856950POST/sapi/v1/order/test{"symbol":"BTCUSDT","price":"9300","volume":"1","side":"BUY","type":"LIMIT"}

调用接口提示ILLEGAL_CONTENT_TYPE(-1017)，是什么原因？

我们建议在所有的请求头附加Content-Type，并设置成'application/json'。

API每秒调用频率有限制吗？

有限制，具体可以看下文档中每个接口的访问频率限制。

API的访问频率是根据什么限制的？

个人数据是根据API-key限制的，公共数据是根据ip限制，需要注意的是，若用户请求公共数据时传入有效的个人信息就根据API-key限制。

HTTP状态码429是怎样造成的？

请求接口超过访问频率限制，建议降低访问频率。

API调用接口报超过访问频率会被封IP吗？封多久？

通常情况下不会的，降低访问频率就可以。

为什么WebSocker出现了断开连接？

用户请求接口报错Time Out？

网络无法连接服务器，建议您检查下网络是否通畅。

如何拿到平台所有的币对

现货交易中的/sapi/v1/symbols接口可以拿到。

批量下单/撤单有条数限制吗？

是的。批量接口会限制10条订单。

newClientOrderId是什么, 有什么作用?

如何获取最新成交价格？

可以通过获取Ticker信息，返回结果中的last就是最新成交价。

Ticker接口中的24小时成交量会出现负增长吗？

会的。因为24小时成交量，为24小时滚动数据（平移窗口大小24小时），有可能会出现后一个窗口内的累计成交量、累计成交额小于前一窗口的情况。

HTTP SHELL JAVA GO PYTHON PHP Node.js