New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for Websocket API #1256
Add documentation for Websocket API #1256
Conversation
{ | ||
"jwt": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ" | ||
} | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need the list of subscription channels and information between what message goes on public channel and which ones on private channel @yivo @ashanaakh
docs/api/websocket_api.md
Outdated
| `created_at` | Order create time in iso8601 format. | | ||
| `origin_volume` | The amount user wnt to sell/buy. | | ||
| `trades_count` | Number of trades. | | ||
| `trades` | List of trades. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe there is other message types.
@mod as I see in the websocket protocol source code, here is no private/public channels. and here: I think it is initialized only once on the websocket connection. Also for me important to mention, that API has on three main types of messages:
|
@@ -0,0 +1,124 @@ | |||
# Peatio WebSocket API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ashanaakh Can you add some small Ruby script into this doc to demonstrate usage?
I don't understand how to use this as API by reading this md file, use more English words please describe make a drawing, do whatever it takes |
No description provided.