Skip to main content
WSS
get_symbols lists the symbols you can trade and the chains each one can be bought on; a symbol listed on more than one chain needs chainId on place_order. get_redemption_address answers where to send a CET’s tokens before selling, get_redemption_balance how many of the ones you sent you can still sell, and get_redemption_balances the same for every CET at once: see Sell shares and redeem CETs. An ack to place_order means the order was taken, not that it filled. A buy the account cannot pay for, or a sell your redemption balance cannot cover, is refused with INVALID_ORDER before it reaches the broker. Once taken, its fills arrive as order_updated and trade_updated, pushed at most once and never replayed. After any gap, get_order says where an order stands. See Track, cancel and reconcile orders.
ed25519Signature
type:asymmetricEncryption

Each client registers an Ed25519 public key with Securitize beforehand; the private key never leaves the client. hello, place_order, cancel_order, submit_crypto_funding, sandbox_deposit and sandbox_withdraw carry timestamp (Unix seconds) and signature = base58( Ed25519-Sign( privateKey, timestamp + "." + type + "." + payloadBytes ) ), where payloadBytes are the exact bytes of payload as sent on the wire. The timestamp must be within 30 seconds of the server clock. Other messages ride on the session hello opens.

place_order
type:object

Buys or sells shares. Signed.

get_symbols
type:object

Lists the symbols you can trade, and the chains each one can be bought on.

get_redemption_address
type:object

The redemption wallet of one CET, where its tokens go before you sell the shares they stand for.

get_redemption_balance
type:object

Your own balance in one CET's redemption wallet, which your sells of that CET are checked against.

get_redemption_balances
type:object

Your own balance in the redemption wallet of every CET you can trade, in one read.

cancel_order
type:object

Requests a cancellation. Signed.

get_order
type:object

Reads where an order stands, by orderId or by externalRef.

ack (place_order)
type:object

The order was taken, refused, or never acknowledged. Not a fill.

ack (get_symbols)
type:object

One entry per symbol, sorted by symbol, each with its chains sorted by chainId.

ack (get_redemption_address)
type:object

The CET's token address and its redemption wallet on that chain.

ack (get_redemption_balance)
type:object

What you sent to the CET's redemption wallet, what of it is burned or spoken for, and what you can still sell.

ack (get_redemption_balances)
type:object

Your balance in each CET's redemption wallet, sorted by symbol and then chain.

ack (cancel_order)
type:object

The cancellation request was taken, refused, or never acknowledged.

ack (get_order)
type:object

The order as it stands, with any extra detail you asked for.

error
type:object

A request was refused. Most errors leave the socket open.

order_updated
type:object

Pushed whenever an order on the account changes.

trade_updated
type:object

Pushed once per execution, from the broker's ledger.