User management
Symbols and instruments
Marketdata
Portfolio management
Order entry and management
Messages
{
"rid": 1,
"t": "p",
"s": "BTCUSD-PERP",
"d": "B",
"q": 100,
"p": "50000.50",
"tif": "GTC",
"po": false,
"tag": "trade001"
}{
"rid": 2,
"t": "x",
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV"
}{
"rid": 3,
"t": "o"
}{
"rid": 0,
"res": {
"li": "user@example.com",
"o": [
{
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
}
]
},
"err": null
}{
"rid": 1,
"res": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
}{
"rid": 2,
"res": {
"cxl_rx": true
}
}{
"rid": 3,
"res": [
{
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
{
"oid": "O-01BX5ZZKBKACTAV9WEVGEMMVRE",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "ETHUSD-PERP",
"p": "2500.50",
"q": 200,
"xq": 50,
"rq": 150,
"o": "PARTIALLY_FILLED",
"d": "S",
"tif": "GTC",
"ts": 1609459300,
"tn": 500000000
}
]
}{
"t": "h",
"ts": 1609459200,
"tn": 123456789
}{
"t": "e",
"ts": 1609459200,
"tn": 123456789,
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"r": "ORDER_NOT_FOUND",
"txt": "Order not found or already canceled"
}{
"t": "n",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
}
}{
"t": "c",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "CANCELED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"xr": "USER_REQUESTED",
"txt": "Canceled by user"
}{
"t": "r",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50100.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
}
}{
"t": "j",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "REJECTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"r": "INSUFFICIENT_MARGIN",
"txt": "Insufficient margin to place order"
}{
"t": "x",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "EXPIRED",
"d": "B",
"tif": "IOC",
"ts": 1609459200,
"tn": 0
}
}{
"t": "d",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 50,
"rq": 50,
"o": "DONE_FOR_DAY",
"d": "B",
"tif": "DAY",
"ts": 1609459200,
"tn": 0
}
}{
"t": "p",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 50,
"rq": 50,
"o": "PARTIALLY_FILLED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"xs": {
"tid": "T-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"s": "BTCUSD-PERP",
"q": 50,
"p": "50000.00",
"d": "B",
"agg": false
}
}{
"t": "f",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 100,
"rq": 0,
"o": "FILLED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"xs": {
"tid": "T-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"s": "BTCUSD-PERP",
"q": 100,
"p": "50000.00",
"d": "B",
"agg": true
}
}Order entry and management
Websocket orders
WSS
wss://sandbox.x.architect.co
/
orders
/
ws
Messages
{
"rid": 1,
"t": "p",
"s": "BTCUSD-PERP",
"d": "B",
"q": 100,
"p": "50000.50",
"tif": "GTC",
"po": false,
"tag": "trade001"
}{
"rid": 2,
"t": "x",
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV"
}{
"rid": 3,
"t": "o"
}{
"rid": 0,
"res": {
"li": "user@example.com",
"o": [
{
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
}
]
},
"err": null
}{
"rid": 1,
"res": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
}{
"rid": 2,
"res": {
"cxl_rx": true
}
}{
"rid": 3,
"res": [
{
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
{
"oid": "O-01BX5ZZKBKACTAV9WEVGEMMVRE",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "ETHUSD-PERP",
"p": "2500.50",
"q": 200,
"xq": 50,
"rq": 150,
"o": "PARTIALLY_FILLED",
"d": "S",
"tif": "GTC",
"ts": 1609459300,
"tn": 500000000
}
]
}{
"t": "h",
"ts": 1609459200,
"tn": 123456789
}{
"t": "e",
"ts": 1609459200,
"tn": 123456789,
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"r": "ORDER_NOT_FOUND",
"txt": "Order not found or already canceled"
}{
"t": "n",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
}
}{
"t": "c",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "CANCELED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"xr": "USER_REQUESTED",
"txt": "Canceled by user"
}{
"t": "r",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50100.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "ACCEPTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
}
}{
"t": "j",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "REJECTED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"r": "INSUFFICIENT_MARGIN",
"txt": "Insufficient margin to place order"
}{
"t": "x",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 0,
"rq": 100,
"o": "EXPIRED",
"d": "B",
"tif": "IOC",
"ts": 1609459200,
"tn": 0
}
}{
"t": "d",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 50,
"rq": 50,
"o": "DONE_FOR_DAY",
"d": "B",
"tif": "DAY",
"ts": 1609459200,
"tn": 0
}
}{
"t": "p",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 50,
"rq": 50,
"o": "PARTIALLY_FILLED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"xs": {
"tid": "T-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"s": "BTCUSD-PERP",
"q": 50,
"p": "50000.00",
"d": "B",
"agg": false
}
}{
"t": "f",
"ts": 1609459200,
"tn": 123456789,
"eid": "E-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"o": {
"oid": "O-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"u": "550e8400-e29b-41d4-a716-446655440000",
"s": "BTCUSD-PERP",
"p": "50000.00",
"q": 100,
"xq": 100,
"rq": 0,
"o": "FILLED",
"d": "B",
"tif": "GTC",
"ts": 1609459200,
"tn": 0
},
"xs": {
"tid": "T-01ARZ3NDEKTSV4RRFFQ69G5FAV",
"s": "BTCUSD-PERP",
"q": 100,
"p": "50000.00",
"d": "B",
"agg": true
}
}token
type:http
Bearer token authentication using user/session tokens from /api/get_user_token.
To connect to the WebSocket, include the Authorization header:
Authorization: Bearer <token>Place Order Request
type:object
Request to place a new order (t="p")
Cancel Order Request
type:object
Request to cancel an existing order (t="x")
Get Open Orders Request
type:object
Request to retrieve all open orders (t="o")
Login Response
type:object
Initial response upon WebSocket connection (rid=0)
Place Order Response
type:object
Response to place order request
Cancel Order Response
type:object
Response to cancel order request
Get Open Orders Response
type:object
Response to get open orders request
Heartbeat Event
type:object
Heartbeat/timestamp event (t="h")
Cancel Rejected Event
type:object
Order cancel request was rejected (t="e")
Order Acknowledged Event
type:object
Order has been acknowledged by the exchange (t="n")
Order Canceled Event
type:object
Order has been canceled (t="c")
Order Replaced/Amended Event
type:object
Order has been replaced or amended (t="r")
Order Rejected Event
type:object
Order has been rejected (t="j")
Order Expired Event
type:object
Order has expired (t="x")
Order Done For Day Event
type:object
Order is done for the day (t="d")
Order Partially Filled Event
type:object
Order has been partially filled (t="p")
Order Filled Event
type:object
Order has been completely filled (t="f")
⌘I