身份验证

端点

下载Schema

用API key登录 (USER_DATA)

使用提供的API密钥进行WebSocket连接身份验证。

在调用session.logon后，将来的需要apiKey和signature参数的请求可以省略它们。

请注意，只能认证一个API密钥。多次调用session.logon将更改当前已认证的API密钥。

注意： 仅支持 Ed25519 密钥用于此功能。

WSS

session.logon

wss://ws-api.binance.com:443/ws-api/v3

用API key登录 (USER_DATA) › 授权

这是一个签名端点，必须在请求参数中包含签名。了解如何生成有效签名，请参考端点安全类型

用API key登录 (USER_DATA) › 请求权重

此端点消耗基于IP的请求权重。较重的端点会消耗更多您的IP速率限制容量。

请在限速说明章节中了解更多信息。

IP 权重2

用API key登录 (USER_DATA) › 请求参数可选

id

string · 必须

客户端生成的请求标识符。

示例： 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · 必须

WebSocket API 方法名称。

枚举值:

session.logon

示例： session.logon

object · 必须

timestamp

integer · int64 · 必须

用于请求签名的 Unix 时间戳，单位为毫秒. 该值必须反映客户端当前时间，并会在签名接口中由服务器进行校验.

示例： 1770736694138

apiKey

string · 必须

访问此接口需要 API Key，并且必须在请求头中携带。关于如何创建 API Key，请参考：https://www.binance.com/cn/support/faq/detail/360002502072。

示例： API_KEY

recvWindow

number · float · max: 60000

最大值为 60000 毫秒。支持最多三位小数的精度（例如 6000.346），以便可以指定微秒。

示例： 5000

用API key登录 (USER_DATA) › 响应

Successful Response

用API key登录

id

string

示例： c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

示例： 200

object

apiKey

string

示例： vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

示例： 1649729878532

connectedSince

integer · int64

示例： 1649729873021

returnRateLimits

boolean

示例： false

serverTime

integer · int64

示例： 1649729878630

userDataStream

boolean

User Data Stream 订阅是否有效？

示例： false

WSSsession.logon

wscat -c wss://ws-api.binance.com:443/ws-api/v3 -x '{
  "id": "7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b",
  "method": "session.logon",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}'

示例请求

{
  "id": "7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b",
  "method": "session.logon",
  "params": {
    "timestamp": 1770736694138,
    "apiKey": "API_KEY"
  }
}

json

application/json

示例响应

{
  "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
  "status": 200,
  "result": {
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "authorizedSince": 1649729878532,
    "connectedSince": 1649729873021,
    "returnRateLimits": false,
    "serverTime": 1649729878630,
    "userDataStream": false
  }
}

json

application/json

退出会话

忘记之前认证的API密钥。如果连接未经身份验证，此请求不会有任何作用。

请注意，session.logout请求后，WebSocket连接仍然保持打开状态。你可以继续使用连接，但现在必须在需要的地方明确提供apiKey和signature参数。

WSS

session.logout

wss://ws-api.binance.com:443/ws-api/v3

退出会话 › 请求权重

此端点消耗基于IP的请求权重。较重的端点会消耗更多您的IP速率限制容量。

请在限速说明章节中了解更多信息。

IP 权重2

退出会话 › 请求参数可选

id

string · 必须

客户端生成的请求标识符。

示例： 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · 必须

WebSocket API 方法名称。

枚举值:

session.logout

示例： session.logout

params

object

退出会话 › 响应

Successful Response

退出会话

id

string

示例： c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

示例： 200

object

apiKey

string

示例： null

authorizedSince

integer · int64

示例： null

connectedSince

integer · int64

示例： 1649729873021

returnRateLimits

boolean

示例： false

serverTime

integer · int64

示例： 1649730611671

userDataStream

boolean

User Data Stream 订阅是否有效？

示例： false

查询会话状态

查询WebSocket连接的状态，检查用于授权请求的API密钥（如果有的话）。

WSS

session.status

wss://ws-api.binance.com:443/ws-api/v3

查询会话状态 › 请求权重

此端点消耗基于IP的请求权重。较重的端点会消耗更多您的IP速率限制容量。

请在限速说明章节中了解更多信息。

IP 权重2

查询会话状态 › 请求参数可选

id

string · 必须

客户端生成的请求标识符。

示例： 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · 必须

WebSocket API 方法名称。

枚举值:

session.status

示例： session.status

params

object

查询会话状态 › 响应

Successful Response

查询会话状态

id

string

示例： b50c16cd-62c9-4e29-89e4-37f10111f5bf

status

integer · int64

示例： 200

object

apiKey

string

示例： vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

示例： 1649729878532

connectedSince

integer · int64

示例： 1649729873021

returnRateLimits

boolean

示例： false

serverTime

integer · int64

示例： 1649730611671

userDataStream

boolean

User Data Stream 订阅是否有效？

示例： true

用API key登录 (USER_DATA)

使用提供的API密钥进行WebSocket连接身份验证。

在调用session.logon后，将来的需要apiKey和signature参数的请求可以省略它们。

请注意，只能认证一个API密钥。多次调用session.logon将更改当前已认证的API密钥。

注意： 仅支持 Ed25519 密钥用于此功能。

WSS

session.logon

wss://ws-api.binance.com:443/ws-api/v3

用API key登录 (USER_DATA) › 授权

这是一个签名端点，必须在请求参数中包含签名。了解如何生成有效签名，请参考端点安全类型

用API key登录 (USER_DATA) › 请求权重

此端点消耗基于IP的请求权重。较重的端点会消耗更多您的IP速率限制容量。

请在限速说明章节中了解更多信息。

IP 权重2

用API key登录 (USER_DATA) › 请求参数可选

id

string · 必须

客户端生成的请求标识符。

示例： 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · 必须

WebSocket API 方法名称。

枚举值:

session.logon

示例： session.logon

object · 必须

timestamp

integer · int64 · 必须

用于请求签名的 Unix 时间戳，单位为毫秒. 该值必须反映客户端当前时间，并会在签名接口中由服务器进行校验.

示例： 1770736694138

apiKey

string · 必须

访问此接口需要 API Key，并且必须在请求头中携带。关于如何创建 API Key，请参考：https://www.binance.com/cn/support/faq/detail/360002502072。

示例： API_KEY

recvWindow

number · float · max: 60000

最大值为 60000 毫秒。支持最多三位小数的精度（例如 6000.346），以便可以指定微秒。

示例： 5000

用API key登录 (USER_DATA) › 响应

Successful Response

用API key登录

id

string

示例： c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

示例： 200

object

apiKey

string

示例： vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

示例： 1649729878532

connectedSince

integer · int64

示例： 1649729873021

returnRateLimits

boolean

示例： false

serverTime

integer · int64

示例： 1649729878630

userDataStream

boolean

User Data Stream 订阅是否有效？

示例： false

退出会话

忘记之前认证的API密钥。如果连接未经身份验证，此请求不会有任何作用。

请注意，session.logout请求后，WebSocket连接仍然保持打开状态。你可以继续使用连接，但现在必须在需要的地方明确提供apiKey和signature参数。

WSS

session.logout

wss://ws-api.binance.com:443/ws-api/v3

退出会话 › 请求权重

此端点消耗基于IP的请求权重。较重的端点会消耗更多您的IP速率限制容量。

请在限速说明章节中了解更多信息。

IP 权重2

退出会话 › 请求参数可选

id

string · 必须

客户端生成的请求标识符。

示例： 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · 必须

WebSocket API 方法名称。

枚举值:

session.logout

示例： session.logout

params

object

退出会话 › 响应

Successful Response

退出会话

id

string

示例： c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

示例： 200

object

apiKey

string

示例： null

authorizedSince

integer · int64

示例： null

connectedSince

integer · int64

示例： 1649729873021

returnRateLimits

boolean

示例： false

serverTime

integer · int64

示例： 1649730611671

userDataStream

boolean

User Data Stream 订阅是否有效？

示例： false

查询会话状态

查询WebSocket连接的状态，检查用于授权请求的API密钥（如果有的话）。

WSS

session.status

wss://ws-api.binance.com:443/ws-api/v3

查询会话状态 › 请求权重

此端点消耗基于IP的请求权重。较重的端点会消耗更多您的IP速率限制容量。

请在限速说明章节中了解更多信息。

IP 权重2

查询会话状态 › 请求参数可选

id

string · 必须

客户端生成的请求标识符。

示例： 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · 必须

WebSocket API 方法名称。

枚举值:

session.status

示例： session.status

params

object

查询会话状态 › 响应

Successful Response

查询会话状态

id

string

示例： b50c16cd-62c9-4e29-89e4-37f10111f5bf

status

integer · int64

示例： 200

object

apiKey

string

示例： vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

示例： 1649729878532

connectedSince

integer · int64

示例： 1649729873021

returnRateLimits

boolean

示例： false

serverTime

integer · int64

示例： 1649730611671

userDataStream

boolean

User Data Stream 订阅是否有效？

示例： true

身份验证

用API key登录 (USER_DATA)

用API key登录 (USER_DATA) › 授权

用API key登录 (USER_DATA) › 请求权重

用API key登录 (USER_DATA) › 请求参数 可选

用API key登录 (USER_DATA) › 响应

退出会话

退出会话 › 请求权重

退出会话 › 请求参数 可选

退出会话 › 响应

查询会话状态

查询会话状态 › 请求权重

查询会话状态 › 请求参数 可选

查询会话状态 › 响应

身份验证

用API key登录 (USER_DATA)

用API key登录 (USER_DATA) › 授权

用API key登录 (USER_DATA) › 请求权重

用API key登录 (USER_DATA) › 请求参数 可选

用API key登录 (USER_DATA) › 响应

退出会话

退出会话 › 请求权重

退出会话 › 请求参数 可选

退出会话 › 响应

查询会话状态

查询会话状态 › 请求权重

查询会话状态 › 请求参数 可选

查询会话状态 › 响应

用API key登录 (USER_DATA) › 请求参数可选

退出会话 › 请求参数可选

查询会话状态 › 请求参数可选

用API key登录 (USER_DATA) › 请求参数可选

退出会话 › 请求参数可选

查询会话状态 › 请求参数可选