Overview

Realtime API

bitFlyer supports 2 protocols for real-time updates.

• Socket.IO 2.0 (WebSocket)
• JSON-RPC 2.0 over WebSocket

The Realtime API is divided into Public Channels that do not require API key authentication and Private Channels that require authentication.

Important Technical Notes

You can receive information from the Realtime API from the time you start your subscription. The situations listed below may result in loss of connection. Information that was generated in the period prior to reconnection can not be received retroactively.

• Maintenance, outages, etc. of our system
• Maintenance, communication or route failure, etc. by your network equipment or network provider

Please fully understand the following characteristics of the WebSocket protocol when using the Realtime API :

• Messages will be delivered one by one and the order of message delivery is guaranteed for a given connection.
• While a message with a large data size is being delivered, subsequent messages may be delayed depending on the line speed etc. (we recommend not subscribing to unnecessary channels)
• If delay or packet loss occurs due to factors such as line quality, subsequent messages will also be delayed, and eventually ping responses will time out and the connection will be lost.