One Trading API
REST APIWebSocket API
REST APIWebSocket API
  • Introduction
  • Authenticate
  • Subscribe
  • Ping / Pong
  • Trading
    • Introduction
    • Create Order
    • Cancel All Orders
    • Cancel Order by Client ID
    • Cancel Order by Order ID
    • Order Booked
    • Order Rejected
    • Order Closed
    • Trade Executed
    • Order Fully Filled
    • Balance Adjustment
  • Orderbook
    • Introduction
    • Orderbook Snapshot
    • Orderbook Update
  • Price Ticks
    • Introduction
    • Price Tick
  • Book Ticker
    • Introduction
    • Book Tick

Authenticate

WebSocket URL:
wss://streams.onetrading.com
All private channels require client authentication before subscription. Clients should first send an AUTHENTICATE message containing the API token, after which they can subscribe to any private channel. If the supplied API token is valid, it will be used to authorize subscriptions and requests for all private channels within this WebSocket connection.
An API token can be generated in the One Trading UI.
You must ensure the API token you generate has the Trade permission, otherwise you will receive an AUTH_ERROR.

Authentication Request#

{
  "type": "AUTHENTICATE",
  "api_token": "eyJ..."
}
WebsocketAuthenticateRequest
type
enum<string> 
required
Allowed value:
AUTHENTICATE
api_token
string 
required
API token generated on the UI with Trade permissions

Authentication Response#

Success#

{
  "type": "AUTHENTICATED"
}
WebsocketAuthenticateSuccessResponse
type
enum<string> 
required
Allowed value:
AUTHENTICATED

Error#

{
  "error": "AUTH_ERROR"
}
WebsocketAuthenticateErrorResponse
error
enum<string> 
required
Allowed value:
AUTH_ERROR
Previous
Introduction
Next
Subscribe
Built with