{
"type": "<string>",
"params": {
"api_key": "<string>"
}
}No examples foundNo examples foundNo examples found{
"type": "<string>",
"params": {
"limit": 123,
"offset": 123
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"leverage": 123
}
}{
"type": "<string>",
"params": {
"limit": 123,
"offset": 123
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"side": "<string>",
"order_type": "<string>",
"order_time_in_force": "<string>",
"quantity": 123,
"price": 123,
"take_profit": 123,
"stop_loss": 123,
"client_order_id": "<string>"
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"order_id": "<string>",
"cancel_order_id_type": "<string>"
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"order_id": "<string>",
"price": 123,
"quantity": 123,
"take_profit": 123,
"stop_loss": 123,
"side": "<string>",
"order_type": "<string>"
}
}{
"type": "subscribed",
"connection_id": "ee987ddf-822c-4356-b0d1-012314859b00",
"message_id": 1,
"id": "3ab267fd-7c83-49c6-b42e-65bb94682b41",
"channel": "v4_balances",
"contents": [
{
"id": "2cb208e3-6e54-48c4-82e9-641e64bf185d",
"user_id": "0f5208e3-6e54-48c4-82e9-641e64bf185d",
"deposit": 1000,
"realised_pnl": -898.65735,
"unrealised_pnl": 0,
"order_margin": 0,
"position_margin": 0,
"net_funding": -1.5354636,
"available_balance": 99.80721
}
]
}{
"type": "subscribed",
"connection_id": "ee987ddf-822c-4356-b0d1-012314859b00",
"message_id": 1,
"id": "3ab267fd-7c83-49c6-b42e-65bb94682b41",
"channel": "v4_positions",
"contents": [
{
"id": "PLTR-USD",
"symbol": "PLTR-USD",
"user_id": "0f5208e3-6e54-48c4-82e9-641e64bf185d",
"position": 0,
"margin_alloc": 0,
"realised_pnl": 1.327875,
"unrealised_pnl": 0,
"net_funding": 0.00000482,
"open_orders": 1,
"open_quantity": 10,
"leverage": 20,
"initial_margin": 0,
"maintenance_margin": 0,
"average_price": 0,
"timestamp": "2025-05-09T03:47:20.505934+00:00"
}
]
}{
"type": "<string>",
"params": {
"api_key": "<string>"
}
}No examples foundNo examples foundNo examples found{
"type": "<string>",
"params": {
"limit": 123,
"offset": 123
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"leverage": 123
}
}{
"type": "<string>",
"params": {
"limit": 123,
"offset": 123
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"side": "<string>",
"order_type": "<string>",
"order_time_in_force": "<string>",
"quantity": 123,
"price": 123,
"take_profit": 123,
"stop_loss": 123,
"client_order_id": "<string>"
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"order_id": "<string>",
"cancel_order_id_type": "<string>"
}
}{
"type": "<string>",
"params": {
"symbol": "<string>",
"order_id": "<string>",
"price": 123,
"quantity": 123,
"take_profit": 123,
"stop_loss": 123,
"side": "<string>",
"order_type": "<string>"
}
}{
"type": "subscribed",
"connection_id": "ee987ddf-822c-4356-b0d1-012314859b00",
"message_id": 1,
"id": "3ab267fd-7c83-49c6-b42e-65bb94682b41",
"channel": "v4_balances",
"contents": [
{
"id": "2cb208e3-6e54-48c4-82e9-641e64bf185d",
"user_id": "0f5208e3-6e54-48c4-82e9-641e64bf185d",
"deposit": 1000,
"realised_pnl": -898.65735,
"unrealised_pnl": 0,
"order_margin": 0,
"position_margin": 0,
"net_funding": -1.5354636,
"available_balance": 99.80721
}
]
}{
"type": "subscribed",
"connection_id": "ee987ddf-822c-4356-b0d1-012314859b00",
"message_id": 1,
"id": "3ab267fd-7c83-49c6-b42e-65bb94682b41",
"channel": "v4_positions",
"contents": [
{
"id": "PLTR-USD",
"symbol": "PLTR-USD",
"user_id": "0f5208e3-6e54-48c4-82e9-641e64bf185d",
"position": 0,
"margin_alloc": 0,
"realised_pnl": 1.327875,
"unrealised_pnl": 0,
"net_funding": 0.00000482,
"open_orders": 1,
"open_quantity": 10,
"leverage": 20,
"initial_margin": 0,
"maintenance_margin": 0,
"average_price": 0,
"timestamp": "2025-05-09T03:47:20.505934+00:00"
}
]
}Provide your API key as a query parameter (?api_key=...).
Authenticate to the WebSocket gateway. Required before any other commands.
Subscribe to user orders. Receive live updates on current orders.
Subscribe to user positions. Receive 1s pulsed updates on current positions.
Subscribe to user balance. Receive 1s pulsed updates on current balance.
Get current leverage levels per symbol
Set leverage level for a symbol
Get available leverage levels per symbol
Add order.
Cancel order.
Modify order.
User balance updates
User position updates