Authentication

Endpoint

Download schema

Log in with API key (USER_DATA)

Authenticate WebSocket connection using the provided API key.

After calling session.logon, you can omit apiKey and signature parameters for future requests that require them.

Note that only one API key can be authenticated.

Calling session.logon multiple times changes the current authenticated API key.

Note: Only Ed25519 keys are supported for this feature.

WSS

session.logon

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

Log in with API key (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Log in with API key (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Log in with API key (USER_DATA) › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.logon

Example: session.logon

object · required

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

recvWindow

number · float · max: 60000

The value cannot be greater than 60000. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.

Example: 5000

Log in with API key (USER_DATA) › Responses

Successful Response

id

string

Example: c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

Example: 200

object

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

Example: 1649729878532

connectedSince

integer · int64

Example: 1649729873021

returnRateLimits

boolean

Example: false

serverTime

integer · int64

Example: 1649729878630

userDataStream

boolean

Is User Data Stream subscription active?

Example: 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"
  }
}'

Example Request

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

json

application/json

Example Responses

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

json

application/json

Log out of the session

Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing.

Note that the WebSocket connection stays open after session.logout request. You can continue using the connection, but now you will have to explicitly provide the apiKey and signature parameters where needed.

WSS

session.logout

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

Log out of the session › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Log out of the session › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.logout

Example: session.logout

params

object

Log out of the session › Responses

Successful Response

Log out of the session

id

string

Example: c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

Example: 200

object

apiKey

string

Example: null

authorizedSince

integer · int64

Example: null

connectedSince

integer · int64

Example: 1649729873021

returnRateLimits

boolean

Example: false

serverTime

integer · int64

Example: 1649730611671

userDataStream

boolean

Is User Data Stream subscription active?

Example: false

Query session status

Query the status of the WebSocket connection, inspecting which API key (if any) is used to authorize requests.

WSS

session.status

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

Query session status › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Query session status › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.status

Example: session.status

params

object

Query session status › Responses

Successful Response

Query session status

id

string

Example: b50c16cd-62c9-4e29-89e4-37f10111f5bf

status

integer · int64

Example: 200

object

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

Example: 1649729878532

connectedSince

integer · int64

Example: 1649729873021

returnRateLimits

boolean

Example: false

serverTime

integer · int64

Example: 1649730611671

userDataStream

boolean

Is User Data Stream subscription active?

Example: true

Authenticate WebSocket connection using the provided API key.

After calling session.logon, you can omit apiKey and signature parameters for future requests that require them.

Note that only one API key can be authenticated.

Calling session.logon multiple times changes the current authenticated API key.

Note: Only Ed25519 keys are supported for this feature.

WSS

session.logon

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

Log in with API key (USER_DATA) › Authorization

This is a signed endpoint and a signature must be included in the request parameters.Learn more about how to generate a valid signature in the Endpoint Security Type

Log in with API key (USER_DATA) › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Log in with API key (USER_DATA) › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.logon

Example: session.logon

object · required

timestamp

integer · int64 · required

Unix timestamp in milliseconds used to sign the request. The value must reflect the current client time and is validated by the server for signed endpoints.

Example: 1770736694138

apiKey

string · required

An API Key is required to access this endpoint and must be included in the request headers. To create an API Key, refer to: https://www.binance.com/en/support/faq/detail/360002502072.

Example: API_KEY

recvWindow

number · float · max: 60000

The value cannot be greater than 60000. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.

Example: 5000

Log in with API key (USER_DATA) › Responses

Successful Response

id

string

Example: c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

Example: 200

object

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

Example: 1649729878532

connectedSince

integer · int64

Example: 1649729873021

returnRateLimits

boolean

Example: false

serverTime

integer · int64

Example: 1649729878630

userDataStream

boolean

Is User Data Stream subscription active?

Example: false

Log out of the session

Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing.

WSS

session.logout

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

Log out of the session › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Log out of the session › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.logout

Example: session.logout

params

object

Log out of the session › Responses

Successful Response

Log out of the session

id

string

Example: c174a2b1-3f51-4580-b200-8528bd237cb7

status

integer · int64

Example: 200

object

apiKey

string

Example: null

authorizedSince

integer · int64

Example: null

connectedSince

integer · int64

Example: 1649729873021

returnRateLimits

boolean

Example: false

serverTime

integer · int64

Example: 1649730611671

userDataStream

boolean

Is User Data Stream subscription active?

Example: false

Query session status

Query the status of the WebSocket connection, inspecting which API key (if any) is used to authorize requests.

WSS

session.status

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

Query session status › Request Weight

This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.

Learn more in the Rate limits section.

IP Weight2

Query session status › Request Parameters optional

id

string · required

Client-generated request identifier.

Example: 7d3b9b46-5f4f-4c8b-9a2d-0a8f9a4a0f5b

method

string · enum · required

WebSocket API method name.

Enum values:

session.status

Example: session.status

params

object

Query session status › Responses

Successful Response

Query session status

id

string

Example: b50c16cd-62c9-4e29-89e4-37f10111f5bf

status

integer · int64

Example: 200

object

apiKey

string

Example: vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A

authorizedSince

integer · int64

Example: 1649729878532

connectedSince

integer · int64

Example: 1649729873021

returnRateLimits

boolean

Example: false

serverTime

integer · int64

Example: 1649730611671

userDataStream

boolean

Is User Data Stream subscription active?

Example: true