Yellow BoxTrading APIv1 · pre-release

User Data Streams

DELETEClose user data stream (USER_STREAM)

API Description

Invalidates the listenKey and closes every WebSocket connection using it.

HTTP Request

HTTP
DELETE /v1/listenKey

Request Weight

1

Request Parameters

Name Type Mandatory Description
listenKey STRING NO The key to close. Optional — the key's active listenKey is closed when omitted.

Response Example

JSON
{}

Call this on a clean shutdown, and immediately if a listenKey is ever exposed. Deleting a listenKey that is already gone is a success, not -1125 — the endpoint is idempotent.