Skip to content

Latest commit

 

History

History
111 lines (100 loc) · 5.95 KB

open_orders_stream.md

File metadata and controls

111 lines (100 loc) · 5.95 KB
Raw

Open Orders Stream

This channel pushes messages with active orders.

Note: When you initially establish a websocket connection, you will receive active orders from all trading pairs. After that, the websocket server will only push the updated active orders from the single trading pair.

Ws Request

GET wss://stream.bitopro.com:443/ws/v1/pub/auth/orders

Authentication For Private Websocket Connection

| Security scheme | Header parameter    |
| :-------------- | :------------------ |
| API Key         | X-BITOPRO-APIKEY    |
| Payload         | X-BITOPRO-PAYLOAD   |
| Signature       | X-BITOPRO-SIGNATURE |

You can find how to create payload and signature from authentication document.

Ws Response

Response:

0 Field Type Description
0 event string String literal for event name
0 eventID string event id for debug usage
0 timestamp integer Unix Timestamp in milliseconds (seconds * 1000)
0 datetime string ISO8601 datetime string with milliseconds
1 id string
1 action string BUY or SELL
1 price string
1 avgExecutionPrice string
1 type string LIMIT, Market or STOP_LIMIT
1 createdTimestamp integer Unix Timestamp in milliseconds (seconds * 1000)
1 updatedTimestamp integer Unix Timestamp in milliseconds (seconds * 1000)
1 status integer see order status
1 originalAmount string
1 remainingAmount string
1 executedAmount string
1 stopPrice string
1 condition string stop limit trigger condition
1 pair string lowercase string underscore-delimited literal of a pair of currencies
1 fee string
1 feeSymbol string
1 bitoFee string bito currency fee
1 total string total trading quote currency amount
1 seq string order sequence number
1 timeInForce string Time in force condition for orders. If type is MARKET, this will always be GTC.
1 clientID integer This information help users distinguish their orders.

To get detailed order model explanation, refer to order model explanation.

Response Example:

{
    "event": "ACTIVE_ORDERS",
    "eventID": "dadf4ac1-665a-4f39-a139-ab95da102374",
    "timestamp": 1639552073346,
    "datetime": "2021-12-15T07:07:53.346Z",
    "data": {
        "sol_usdt": [
            {
                "id": "8917255503",
                "pair": "sol_usdt",
                "price": "107",
                "avgExecutionPrice": "0",
                "action": "SELL",
                "type": "LIMIT",
                "timestamp": 1639386803663,
                "updatedTimestamp": 1639386803663,
                "createdTimestamp": 1639386803663,
                "status": 0,
                "originalAmount": "0.02",
                "remainingAmount": "0.02",
                "executedAmount": "0",
                "fee": "0",
                "feeSymbol": "usdt",
                "bitoFee": "0",
                "total": "0",
                "seq": "SOLUSDT3273528249",
                "timeInForce": "GTC"
            }
        ],
        "usdc_twd": [
            {
                "id": "3452766477",
                "pair": "usdc_twd",
                "price": "10",
                "avgExecutionPrice": "0",
                "action": "BUY",
                "type": "LIMIT",
                "timestamp": 1638258713957,
                "updatedTimestamp": 1639386803663,
                "createdTimestamp": 1639386803663,
                "status": 0,
                "originalAmount": "0.01",
                "remainingAmount": "0.01",
                "executedAmount": "0",
                "fee": "0",
                "feeSymbol": "usdc",
                "bitoFee": "0",
                "total": "0",
                "seq": "USDCTWD2310459465"
                "timeInForce": "GTC"
            }
        ]
    }
}

Back