概要(Overview)

API密钥生成(Generating API Key)

您必须先在BTSE平台上创建API密钥,然后才能使用经过认证的API。要创建API密钥,您可以按照以下步骤操作:

  1. 使用您的用户名/电子邮件和密码登录BTSE网站
  2. 点击右上角的“帐户”
  3. 选择API标签
  4. 单击“新建API”按钮以创建API密钥和密码短语。(注意:密码短语只会出现一次)
  5. 使用您的API密钥和密码短语来建立签名

基本网址:

产品网址- https://api.btse.com/spot

测试网址- https://testapi.btse.io/spot

认证(Authentication)

认证端点(Authenticated Endpoints)

支持认证过的API.

未完成订单(Open Orders)

GET /spot/api/v3/open_orders

名称

输入

型別

必要性

描述

symbol

query

string

代號

响应(Responses)

状态

意义

描述

结构

200

OK

取得所有待处理订单

Open_order_response

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

委托下单(Place Order)

POST /spot/api/v3/order

参数格式(Parameters)

名称

输入

型別

必要性

描述

body

body

OrderMdl

支持限价单,市价单,选择性委托单(OCO)

响应(Responses)

状态

意义

描述

结构

200

OK

建立限价单

Order_response

201

Created

已建立

None

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

取消订单(Cancel Order)

DELETE /spot/api/v3/order

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

orderID

query

string

订单ID

响应(Responses)

状态

意义

描述

结构

200

OK

删除待处理订单

Inline

204

No Content

请求已经成功,且没有需要响应的内容

None

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

响应结构(Response Schema)

状态码 200

名称

型別

必要性

限制

描述

anonymous

[Order_response]

none

[/api/v3/order/limit]

» Order response

Order_response

none

/api/v3/order/limit

»» message

string

none

订单响应信息

»» orderID

string

none

订单id

»» orderType

integer(int32)

none

76: 限价单

77: 市价单

»» price

number(double)

none

订单价格

»» side

string

none

买或卖

»» size

number(double)

none

原始订单数量

»» status

integer(int32)

none

2: 订单插入(ORDER_INSERTED),

6: 订单取消( Order cancelled)

»» symbol

string

none

代号, 例如:BTC-USD,ETH-USD

»» timestamp

integer(int64)

none

订单时间戳

»» trigger

boolean

none

触发与否

»» triggerPrice

number(double)

none

触发价格

列举值(Enumerated Values)

属性

side

BUY/SELL

费用(Fees)

GET /spot/api/v3/user/fees

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

响应(Responses)

状态

意义

描述

结构

200

OK

大部分用户的费用清单

Fees_response

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

交易历史(Trade History)

GET /spot/api/v3/user/trade_history

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

startTime

query

integer(int64)

起始时间

endTime

query

integer(int64)

结束时间

beforeSerialId

query

integer(int64)

之前序列Id

afterSerialId

query

integer(int64)

之后序列Id

count

query

integer(int32)

数量

includeOld

query

boolean

包含旧交易历史

响应(Responses)

状态

意义

描述

结构

200

OK

取得使用者交易记录

RecentTradeMd

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

钱包历史(Wallet History)

GET /spot/api/v3/user/wallet_history

参数格式(Parameters)

名称

输入

型別

必要性

描述

startTime

query

integer(int64)

起始时间

endTime

query

integer(int64)

结束时间

count

query

integer(int32)

数量

currency

query

string

货币

响应(Responses)

状态

意义

描述

结构

200

OK

取得用戶交易历史

WalletHistoryMdl

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

公开端点(Public Endpoints)

支援公开的API.

市场概況(MarketSummary)

GET /spot/api/v3/market_summary

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

响应(Responses)

状态

意义

描述

结构

200

OK

得大部分市场概况清单

Market_Summary_response

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

美国线(OHLCV)

GET /spot/api/v3/ohlcv

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

start

query

integer(int64)

开始

end

query

integer(int64)

结束

resolution

query

integer(int32)

解析度

响应(Responses)

状态

意义

描述

结构

200

OK

取得美国线

Inline

400

Bad Request

错误亲戚

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

等级1订单簿(OrderBook (L1))

GET /spot/api/v3/orderbook

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

group

query

integer(int32)

深度

limit_bids

query

integer(int32)

买入限价

limit_asks

query

integer(int32)

卖出限价

响应(Responses)

状态

意义

描述

结构

200

OK

取得订单簿清单

OrderbookMdl

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

等级2订单簿(OrderBook (L2))

GET /spot/api/v3/orderbook/L2

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

depth

query

integer(int32)

深度

响应(Responses)

状态

意义

描述

结构

200

OK

取得订单簿清单

OrderbookMdl

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

价格(Price)

GET /spot/api/v3/price

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

响应(Responses)

状态

意义

描述

结构

200

OK

取得大部分价格清单

Price_response

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

时间(Time)

GET /spot/api/v3/price

响应(Responses)

状态

意义

描述

结构

200

OK

取得系统时间

TimeMdl

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

交易(Trades)

GET /spot/api/v3/trades

参数格式(Parameters)

名称

输入

型別

必要性

描述

symbol

query

string

代号

startTime

query

integer(int64)

起始时间

endTime

query

integer(int64)

结束时间

beforeSerialId

query

integer(int64)

之前序列Id

afterSerialId

query

integer(int64)

之后序列Id

count

query

integer(int32)

数量

includeOld

query

boolean

包含旧交易

响应(Responses)

状态

意义

描述

结构

200

OK

取得无用户情况下的交易数据

RecentTradeMd

400

Bad Request

错误请求

Error_response

401

Unauthorized

未经授权

Error_response

403

Forbidden

禁止

Error_response

404

Not Found

未找到

None

500

Internal Server Error

内部服务器错误

Error_response

503

Service Unavailable

暂停服务

Error_response

Websocket信息(Websocket Messages)

本节所提及的主题是提供给订阅用.WebSocket是持久连接的.信息是采用非同步地发送和接收.为了正确处理WebSocket信息,需要建立一个收听器(listener)以针对连接去执行适当动作.

订单簿(Orderbook)

为了订阅特定市场的订单簿摘要(feed),需要经由订阅orderBookApi主题,并附加交易市场名称和订单簿等级的设定.其中,交易市场名称可以从市场概况API取得,而订单簿摘要(feed)为每60毫秒更新一次.

交易(Trades)

为了订阅最近交易摘要(feed),需要经由订阅tradeHistory主题,并附加交易市场名称的设定.其中,交易市场名称可以从市场概况API取得.而Websocket摘要(feed)将可发送50笔最近交易的快照(snapshot),并更新随后的交易数据.

身份認證(Authentication)

某些Websocket主题需要通过身份认证.因此,假如您订阅了需要认证的主题,那么您在没通过认证下将不会收到任何信息.而为了要进行身份认证,必须在连接Websocket之后发送authKeyExpires信息.如同JS代码示例,它提供了一段身份认证的代码.

通知(Notifications)

经由订阅notificationApi主题可以接收到交易通知.Websocket摘要(feed)会将交易等级通知推送给订户.如果订阅了主题但未通过身份验证,则不会发送任何信息.

结构(Schemas)

CustomQuote

属性(Properties)

名称

型別

必要性

限制

描述

culmulativeTotal

string

price

string

size

string

CustomResponse

属性(Properties)

名称

型別

必要性

限制

描述

buyQuote

[CustomQuote]

currency

string

gain

integer(int32)

gainVal

number(double)

lastPrice

string

lastSize

number(double)

name

string

pegIndexPrice

string

sellQuote

[CustomQuote]

symbol

string

timestamp

integer(int64)

totalVolume

number(double)

OrderMdl

属性(Properties)

名称

型別

必要性

限制

描述

cancel_after

string

[可选项*] min,hour,day

funds

number

[可选项*] 想要使用的货币数量

postOnly

boolean

被动委托

price

number

订单价格

side

string

订单买或卖

size

number

订单数量

stopPrice

number

当使用选择性委托单(OCO)时,此参数不能为空

symbol

string

tag

string

标签

time_in_force

string

GTC, IOC, FIVEMIN, HOUR, TWELVEHOUR, DAY, WEEK, MONTH

trailValue

number(double)

追踪值

triggerPrice

number

当使用选择性委托单(OCO)时,此参数不能为空

txType

string

LIMIT, STOP, TRIGGER

type

string

LIMIT, MARKET, OCO

列举值(Enumerated Values)

属性

数值

side

BUY/SELL(买/卖)

time_in_force

IOC(立即或取消订单)

time_in_force

GTC(取消前皆有效订单)

time_in_force

FIVEMIN(五分钟)

time_in_force

HOUR(一小时)

time_in_force

TWELVEHOUR(12小时)

time_in_force

DAY(一天)

time_in_force

WEEK(一星期)

time_in_force

MONTH(一个月)

txType

LIMIT

txType

STOP

txType

TRIGGER

txType

OCO

txType

Limit

txType

Stop

txType

Trigger

txType

Oco

txType

limit

txType

stop

txType

trigger

txType

oco

type

LIMIT/MARKET/OCO

OrderbookMdl

属性(Properties)

名称

型別

必要性

限制

描述

buyQuote

[PriceQuote]

购买订单簿清单

sellQuote

[PriceQuote]

销售订单簿清单

symbol

string

代号

timestamp

integer(int64)

时间戳

PriceQuote

属性(Properties)

名称

型別

必要性

限制

描述

culmulativeTotal

number(double)

id

string

mode

string

parametersMap

object

» additionalProperties

object

price

number(double)

size

number(double)

timestamp

integer(int64)

RecentTradeMd

属性(Properties)

名称

型別

必要性

限制

描述

price

number(double)

serialId

integer(int64)

side

string

size

number(double)

symbol

string

timestamp

integer(int64)

TimeMdl

属性(Properties)

名称

型別

必要性

限制

描述

epoch

integer(int64)

目前系统的epoch时间

iso

string

ISO时间戳

WalletHistoryMdl

属性(Properties)

名称

型別

必要性

限制

描述

amount

number(double)

数量

currency

string

货币

description

string

描述

fees

number(double)

費用

orderId

string

订单Id

status

string

USERCANCELED, COMPLETED, CANCELED, PENDING, PROCESSING, EXPIRED,CONTACT CS

timestamp

integer(int64)

时间戳

type

string

DEPOSIT, WITHDRAW, TRANSFER_IN ,TRANSFER_OUT,REFERRALEARNING

username

string

用户名

wallet

string

钱包

Error_response

属性(Properties)

名称

型別

必要性

限制

描述

errorCode

integer(int32)

错误码

message

string

错误信息

status

integer(int32)

404:错误请求

Fees_response

属性(Properties)

名称

型別

必要性

限制

描述

makerFee

number(double)

挂单手续费百分比/美元(比例:10)

symbol

string

代号

takerFee

number(double)

吃单手续费百分比/美元(比例:10)

Market_Summary_response

属性(Properties)

名称

型別

必要性

限制

描述

active

boolean

例如:比特币(BTC),以太币(ETH),及泰达币(USDT)等等

availableSettlement

[string]

可用的结算

base

string

代号

closeTime

integer(int64)

结束时间

contractEnd

integer(int64)

合约终止

contractSize

number(double)

合约大小

contractStart

integer(int64)

合约开始

fundingRate

number(double)

资金费率

futures

boolean

high24Hr

number(double)

24小时內最高价格

highestBid

number(double)

最高买价

inactiveTime

integer(int64)

闲置时间

last

number(double)

最后价格

low24Hr

number(double)

24小时内最低价格

lowestAsk

number(double)

最低出价

maxOrderSize

number(double)

最大订单量

maxPosition

integer(int64)

最大仓位

maxRiskLimit

integer(int32)

最大风险限额

minOrderSize

number(double)

最小订单量

minPriceIncrement

number(double)

最小价格增量

minRiskLimit

integer(int32)

最小风险限额

minSizeIncrement

number(double)

最小尺寸增量

minValidPrice

number(double)

最低有效价格

openInterest

number(double)

未平仓量

openInterestUSD        

number(double)

美元计价未平仓量

openTime

integer(int64)

开放时间

percentageChange        

number(double)

订单百分比变化

quote

string

支援美元

size

number(double)

size = 0.001意味着当您买一单位的合约的时候,它实际上等于在市场上1 * 0.001的大小

startMatching

integer(int64)

开始撮合

symbol

string

代号

timeBasedContract        

boolean

时间合约

volume

number(double)

订单成交量

Open_order_response

属性(Properties)

名称

型別

必要性

限制

描述

cancelDuration

integer(int64)

0:取消前皆有效订单(GTC)

filledSize

number(double)        

已成交订单数量

orderID

string

订单Id

orderType

integer(int32)

76:限价单,77:市价单

orderValue

number(double)

原始订单数值(美元)

pegPriceDeviation

number(double)

挂勾价偏差

pegPriceMax

number(double)

最高挂勾价

pegPriceMin

number(double)

最小挂勾价

price

number(double)

订单价格

side

string

买或卖

size

number(double)

原始订单大小

symbol

string

订单代号

timestamp

integer(int64)

订单时间戳

trailValue

number(double)

订单追踪数值

triggerOrder

boolean

假如订单尚未被触发,那么它会回传true

triggerOrderType

integer(int32)

1001:触发止损价,1002:触发止盈价

triggerOriginalPrice

number(double)

原始触发价

triggerPrice

number(double)

触发价

triggerStopPrice

number(double)

触发止损价

triggerTrailingStopDeviation        

number(double)

触发追踪止损偏差

triggered

boolean

列举值(Enumerated Values)

属性

数值

side

BUY/SELL(买/卖)

Order_response

属性(Properties)

名称

型別

必要性

限制

描述

message

string

订单响应信息

orderID

string

订单Id

orderType

integer(int32)

76:限价单,77:市价单

price

number(double)

订单价格

side

string

买或卖

size

number(double)

原始订单数量

status

integer(int32)

2:订单插入(ORDER_INSERTED), 6:订单取消(Order cancelled)

symbol

string

代号,例如:BTC-USD,ETH-USD

timestamp

integer(int64)        

订单时间戳

trigger

boolean

触发与否

triggerPrice

number(double)

触发价格

列举值(Enumerated Values)

属性

数值

side

BUY/SELL(买/卖)

Price_response

属性(Properties)

名称

型別

必要性

限制

描述

indexPrice

number(double)

指数价格

lastPrice

number(double)

最后价格

markPrice

number(double)

市场价格

symbol

string

代号