# Peatio WebSocket API

Peatio WebSocket API connections are handled by Ranger service provided by peatio gem.

# API

There are two types of channels:

• Public: accessible by anyone
• Private: accessible only by given member

GET request parameters:

List of supported public streams:

• <market>.update (global state updates)
• <market>.trades
• <market>.kline-PERIOD (available periods are "1m", "5m", "15m", "30m", "1h", "2h", "4h", "6h", "12h", "1d", "3d", "1w")
• global.tickers

List of supported private streams (requires authentication):

• order
• trade

You can find a format of these events below in the doc.

#Public channels architecture

#Private channels architecture

# Authentication

Authentication happens on websocket message with following JSON structure.

{
  "jwt": "Bearer <Token>"
}

If authenticaton was done, server will respond successfully

{
  "success": {
    "message": "Authenticated."
  }
}

Otherwise server will return an error

{
  "error": {
    "message": "Authentication failed."
  }
}

If authentication JWT token has invalid type, server return an error

{
  "error": {
    "message": "Token type is not provided or invalid."
  }
}

If other error occured during the message handling server throws an error

{
  "error": {
    "message": "Error while handling message."
  }
}

Note: Peatio websocket API supports authentication only Bearer type of JWT token.

Example of authentication message:

{
  "jwt": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
}

When user successfully authenticated server subsribes client to given streams passed as GET request parameter ?stream= (can be specified multiple times)

When order or trade done, websocket server send message to client with object details.

Depending on what trade happend server will send the ask and bid details.

# Public streams

#Update

Here is structure of <market.update> event:

Example:

{
  asks: [[0.4e1, 0.1e-1], [0.3e1, 0.401e1]], # first is price & second is total volume
  bids: [[0.5e1, 0.4e1]]
}

#Trades

Here is structure of <market.trades> event expose as array with trades:

#Kline point

Kline point as array of numbers:

1. Timestamp.
2. Open price.
3. Max price.
4. Min price.
5. Last price.
6. Period volume

Example:

[1537370580, 0.0839, 0.0921, 0.0781, 0.0845, 0.5895]

#Tickers

Here is structure of global.tickers event expose as array with all markets pairs:

# Private streams

#Order

Here is structure of Order event:

#Trade

Here is structure of Trade event:

# Development

Start ranger websocket server using following command in peatio-core gem:

$ ./bin/peatio service start ranger

Now we can test authentication with wscat:

#Connect to public channel:

$ wscat -n -c 'ws://ws.app.local:8080/api/ranger/v2?stream=usdeth'

#Connect to private channel:

Authorization header will be injected automatically by ambassador so we could subscribe to private channels.

$ wscat -n -c 'ws://ws.app.local:8080/api/ranger/v2?stream=trade'

# Examples

There is also example of working with Ranger service using NodeJS.