Open WebSocket

Connect to WebSocket for a certain chain. It uses WSS, and the Basic auth. credentials are provided in the URL.

  • Enter KAS Auth. in the URL.
    • Example: wss://{kas-access-id}:{kas-secret-key}@node-api.klaytnapi.com/v1/ws/open?chain-id=1001
    • The kas-access-id and kas-secret-key have to be issued later than July 2021.
  • KAS Account ID and Klaytn Network Chain ID are required.


Request
Security:
path Parameters
accountId
required
string

KAS Account ID

query Parameters
chain-id
required
string

KAS Network Chain ID (8217 or 1001)

Example: chain-id=8217
get/v1/ws/open
Request samples
curl -i -X GET \
  -u <username>:<password> \
  'https://node-api.klaytnapi.com/v1/ws/open?chain-id=string'