com.kucoin.sdk

接口 KucoinPublicWSClient

所有已知实现类:

KucoinPublicWSClientImpl

public interface KucoinPublicWSClient

Created by chenshiwei on 2019/1/10.

方法概要

限定符和类型	方法和说明
void	close() Close client
String	onCandles(KucoinAPICallback<KucoinEvent<CandlesEvent>> callback, String symbolAndType) Subscribe to this topic to get the K-line data of the specified type for the specified symbol.
String	onIndicatorIndex(KucoinAPICallback<KucoinEvent<IndicatorEvent>> callback, String... symbols) Subscribe to this topic to get the index prices used for leveraged trading.
String	onIndicatorMarkPrice(KucoinAPICallback<KucoinEvent<IndicatorEvent>> callback, String... symbols) Subscribe to this topic to get the mark prices used for leveraged trading.
String	onLevel2Data(int depth, KucoinAPICallback<KucoinEvent<Level2Event>> callback, String... symbols) Subscribe this topic to get Level2 order book data.
String	onLevel2Data(KucoinAPICallback<KucoinEvent<Level2ChangeEvent>> callback, String... symbols) Subscribe this topic to get Level2 order book data.
String	onLevel3Data_V2(KucoinAPICallback<KucoinEvent<Level3Event>> callback, String... symbols) Subscribe this topic to get the updated data for orders and trades.
String	onLevel3Data(KucoinAPICallback<KucoinEvent<Level3ChangeEvent>> callback, String... symbols) 已过时。 instead use the method onLevel3Data_V2
String	onMarginFundingBook(KucoinAPICallback<KucoinEvent<FundingBookEvent>> callback, String... currency) Subscribe to this topic to get the changes of leveraged trading borrowing and selling orders.
String	onMatchExecutionData(KucoinAPICallback<KucoinEvent<MatchExcutionChangeEvent>> callback, String... symbols) Subscribe this topic to fully get the updata data for orders and trades.
String	onSnapshot(KucoinAPICallback<KucoinEvent<SnapshotEvent>> callback, String target) Subscribe to get snapshot data for a single symbol or a market
String	onTicker(KucoinAPICallback<KucoinEvent<TickerChangeEvent>> callback, String... symbols) Subscribe this topic to get the realtime push of BBO changes.
String	ping(String requestId) To prevent the TCP link being disconnected by the server, the client side needs to send ping messages to the server to keep alive the link.
String	unsubscribe(PublicChannelEnum channelEnum, String... symbols) Unsubscribe from topics you have subscribed to.

方法详细资料

onTicker

String onTicker(KucoinAPICallback<KucoinEvent<TickerChangeEvent>> callback,
                String... symbols)

Subscribe this topic to get the realtime push of BBO changes. The ticker channel provides real-time price updates every time a match happens. It batches updates in case of cascading matches, greatly reducing bandwidth requirements.

参数:

callback -

symbols -

返回:

The subscription UUID, or null if sending failed.

onCandles

String onCandles(KucoinAPICallback<KucoinEvent<CandlesEvent>> callback,
                 String symbolAndType)

Subscribe to this topic to get the K-line data of the specified type for the specified symbol.

参数:

callback -

symbolAndType -

返回:

onLevel2Data

String onLevel2Data(KucoinAPICallback<KucoinEvent<Level2ChangeEvent>> callback,
                    String... symbols)

Subscribe this topic to get Level2 order book data. After the conducts, the system would send the increment change data pushed by websocket to you.

参数:

callback -

symbols -

返回:

The subscription UUID, or null if sending failed.

onLevel2Data

String onLevel2Data(int depth,
                    KucoinAPICallback<KucoinEvent<Level2Event>> callback,
                    String... symbols)

Subscribe this topic to get Level2 order book data. After the conducts, the system would send the order book data pushed by websocket to you every 100ms.

参数:

depth - top N data, right now, only 5 and 50 are available.

callback -

symbols -

返回:

onMatchExecutionData

String onMatchExecutionData(KucoinAPICallback<KucoinEvent<MatchExcutionChangeEvent>> callback,
                            String... symbols)

Subscribe this topic to fully get the updata data for orders and trades. The full channel provides real-time updates on orders and trades. These updates can be applied on to a level 3 order book snapshot to maintain an accurate and up-to-date copy of the exchange order book.

参数:

callback -

symbols -

返回:

The subscription UUID, or null if sending failed.

onLevel3Data_V2

String onLevel3Data_V2(KucoinAPICallback<KucoinEvent<Level3Event>> callback,
                       String... symbols)

Subscribe this topic to get the updated data for orders and trades.

This channel provides real-time updates on orders and trades. These updates can be applied on to a Level 3 order book snapshot for users to maintain an accurate and up-to-date copy of the exchange order book.

参数:

callback -

symbols -

返回:

The subscription UUID, or null if sending failed.

onLevel3Data

@Deprecated
String onLevel3Data(KucoinAPICallback<KucoinEvent<Level3ChangeEvent>> callback,
                                String... symbols)

已过时。 instead use the method onLevel3Data_V2

Subsribe this topic to fully get the updata data for orders and trades. The full channel provides real-time updates on orders and trades. These updates can be applied on to a level 3 order book snapshot to maintain an accurate and up-to-date copy of the exchange order book.

参数:

callback -

symbols -

返回:

The subscription UUID, or null if sending failed.

ping

String ping(String requestId)

To prevent the TCP link being disconnected by the server, the client side needs to send ping messages to the server to keep alive the link. After the ping message is sent to the server, the system would return a pong message to the client side.

参数:

requestId -

返回:

The original request id, or null if sending failed.

unsubscribe

String unsubscribe(PublicChannelEnum channelEnum,
                   String... symbols)

Unsubscribe from topics you have subscribed to.

参数:

channelEnum -

symbols -

返回:

The unsubscribe request UUID, or null if sending failed.

close

void close()
    throws IOException

Close client

抛出:

IOException

onSnapshot

String onSnapshot(KucoinAPICallback<KucoinEvent<SnapshotEvent>> callback,
                  String target)

Subscribe to get snapshot data for a single symbol or a market

参数:

callback -

target - symbol or market

返回:

onIndicatorIndex

String onIndicatorIndex(KucoinAPICallback<KucoinEvent<IndicatorEvent>> callback,
                        String... symbols)

Subscribe to this topic to get the index prices used for leveraged trading.

参数:

callback -

symbols -

返回:

onIndicatorMarkPrice

String onIndicatorMarkPrice(KucoinAPICallback<KucoinEvent<IndicatorEvent>> callback,
                            String... symbols)

Subscribe to this topic to get the mark prices used for leveraged trading.

参数:

callback -

symbols -

返回:

onMarginFundingBook

String onMarginFundingBook(KucoinAPICallback<KucoinEvent<FundingBookEvent>> callback,
                           String... currency)

Subscribe to this topic to get the changes of leveraged trading borrowing and selling orders.

参数:

callback -

currency -

返回: