Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt

Use this file to discover all available pages before exploring further.

This Order Creation WebSocket allows you to create, cancel, and modify orders, as well as receive order notifications.

URL

This stream can be subscribed per market and you will need to pass in the market in the URL query. See below.

Authorizations

See Get Access Token on how to retrieve the token. Set Sec-WebSocket-Protocol during the handshake or on connect().
Sec-WebSocket-Protocol
string
required
Example value (authorization token):
authorization#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdGFnaW5nLmZ1bmdpYmxlLnh5eiIsInN1YiI6ImQxM2I1MzBmLWFmNzMtNDBmOS04ZjhlLWVkNzk1OTU3YTU3ZiIsImF1ZCI6WyJzdGFnaW5nLWFwcC5mdW5naWJsZS54eXoiXSwiZXhwIjoxNzAzMzA1NzQwLCJpYXQiOjE3MDMzMDM5NDB9.vsHe4G_yEkRfz8XNoTKcX83udA-LUysWD4q80wfCC8k

Query Parameters

market
string
required
Market name. Example value: ETH-USD. To get all supported markets, call /api/v1/markets endpoint.

Supported Requests and Notifications

All these requests and notifications (except Ping) share the same request and response structure as the Order Creation Stream in WebSocket v2, except for the connection URL.