Order status changed

SEND Server to Client on wss://api.valr.com/ws/account

Sent when an open order on the exchange has had a status change event. Includes the order ID, current status, remaining quantity, and other order details.

Authentication

This operation requires API key authentication (HMAC-SHA512 via query parameters or in-band AUTHENTICATE message).

Subscription

This event requires an explicit subscription. Send a SUBSCRIBE message after connecting:

{
    "type": "SUBSCRIBE",
    "subscriptions": [
        {
            "event": "ORDER_STATUS_UPDATE"
        }
    ]
}

Message

Event type: ORDER_STATUS_UPDATE

Payload Schema

Property	Type	Required	Description
orderId	string	Yes	-
orderStatusType	string	Yes	-
currencyPair	string	Yes	-
originalPrice	string	Yes	-
remainingQuantity	string	Yes	-
originalQuantity	string	Yes	-
orderSide	string	Yes	-
orderType	string	Yes	-
failedReason	string	No	-
orderUpdatedAt	string	Yes	-
orderCreatedAt	string	Yes	-
customerOrderId	string	No	-

Example

"{\n    \"type\": \"ORDER_STATUS_UPDATE\",\n    \"data\": {\n        \"orderId\": \"f1e2d3c4-b5a6-7890-1234-567890abcdef\",\n        \"orderStatusType\": \"Filled\",\n        \"currencyPair\": \"BTCZAR\",\n        \"originalPrice\": \"950000\",\n        \"remainingQuantity\": \"0\",\n        \"originalQuantity\": \"0.01000000\",\n        \"orderSide\": \"BUY\",\n        \"orderType\": \"limit\",\n        \"failedReason\": null,\n        \"orderUpdatedAt\": \"2024-09-27T12:01:00.000Z\",\n        \"orderCreatedAt\": \"2024-09-27T12:00:00.000Z\",\n        \"customerOrderId\": \"my-order-1\"\n    }\n}"

Channel

Channel: account Address: wss://api.valr.com/ws/account