Skip to main content
POST
/
v3
/
account
/
listenKey
cURL
curl --request POST \
  --url https://api.woox.io/v3/account/listenKey \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-signature: <x-api-signature>' \
  --header 'x-api-timestamp: <x-api-timestamp>' \
  --data '
{
  "type": "WEBSOCKET"
}
'
{
  "success": true,
  "timestamp": 123,
  "data": {
    "authKey": "<string>",
    "expiredTime": 123
  }
}
Limit 5 requests per 10 seconds Create a listen key for private streamings which can be accessed at {base_wss_stream}?key=<listenKey>. If a valid listen key already exists, the system will create a new one and immediately expire the old key. Each listen key remains valid for 24 hours.

Headers

​
x-api-key
string
required

api-key

Example:

"abcdef123456"

​
x-api-signature
string
required

api-signature

Example:

"signaturestring"

​
x-api-timestamp
string
required

api-timestamp

Example:

"1718943200000"

Body

application/json
​
type
string
required

WEBSOCKET

Example:

"WEBSOCKET"

Response

200 - application/json
​
success
boolean

true

​
timestamp
integer

timestamp

​
data
object