Handle Onboarding request for both clients and market makers
{
"error": "<string>",
"pagination": {
"limit": 123,
"order": "<string>",
"page": 123,
"total": 123
},
"result": [
{
"jwt": "<string>",
"profile": {
"account_equity": 123,
"account_leverage": 123,
"account_margin": 123,
"balance": 123,
"cum_trading_volume": 123,
"cum_unrealized_pnl": 123,
"health": 123,
"id": 123,
"last_liq_check": 123,
"last_update": 123,
"leverage": {},
"orders": [
{
"client_order_id": "<string>",
"created_at": 123,
"id": "<string>",
"initial_size": 123,
"market_id": "<string>",
"order_type": "<string>",
"price": 123,
"profile_id": 123,
"reason": "<string>",
"side": "<string>",
"size": 123,
"size_percent": 123,
"status": "<string>",
"time_in_force": "<string>",
"timestamp": 123,
"total_filled_size": 123,
"trigger_price": 123,
"updated_at": 123
}
],
"positions": [
{
"entry_price": 123,
"fair_price": 123,
"id": "<string>",
"liquidation_price": 123,
"margin": 123,
"market_id": "<string>",
"notional": 123,
"profile_id": 123,
"side": "<string>",
"size": 123,
"unrealized_pnl": 123
}
],
"profile_notifications": [
{
"description": "<string>",
"title": "<string>",
"type": "<string>"
}
],
"profile_type": "<string>",
"status": "<string>",
"total_notional": 123,
"total_order_margin": 123,
"total_position_margin": 123,
"wallet": "<string>",
"withdrawable_balance": 123
},
"randomSecret": "<string>",
"refreshToken": "<string>"
}
],
"success": true
}
Onboarding request payload
The body is of type object
.
OK
The response is of type object
.
{
"error": "<string>",
"pagination": {
"limit": 123,
"order": "<string>",
"page": 123,
"total": 123
},
"result": [
{
"jwt": "<string>",
"profile": {
"account_equity": 123,
"account_leverage": 123,
"account_margin": 123,
"balance": 123,
"cum_trading_volume": 123,
"cum_unrealized_pnl": 123,
"health": 123,
"id": 123,
"last_liq_check": 123,
"last_update": 123,
"leverage": {},
"orders": [
{
"client_order_id": "<string>",
"created_at": 123,
"id": "<string>",
"initial_size": 123,
"market_id": "<string>",
"order_type": "<string>",
"price": 123,
"profile_id": 123,
"reason": "<string>",
"side": "<string>",
"size": 123,
"size_percent": 123,
"status": "<string>",
"time_in_force": "<string>",
"timestamp": 123,
"total_filled_size": 123,
"trigger_price": 123,
"updated_at": 123
}
],
"positions": [
{
"entry_price": 123,
"fair_price": 123,
"id": "<string>",
"liquidation_price": 123,
"margin": 123,
"market_id": "<string>",
"notional": 123,
"profile_id": 123,
"side": "<string>",
"size": 123,
"unrealized_pnl": 123
}
],
"profile_notifications": [
{
"description": "<string>",
"title": "<string>",
"type": "<string>"
}
],
"profile_type": "<string>",
"status": "<string>",
"total_notional": 123,
"total_order_margin": 123,
"total_position_margin": 123,
"wallet": "<string>",
"withdrawable_balance": 123
},
"randomSecret": "<string>",
"refreshToken": "<string>"
}
],
"success": true
}
Handle Onboarding request for both clients and market makers
{
"error": "<string>",
"pagination": {
"limit": 123,
"order": "<string>",
"page": 123,
"total": 123
},
"result": [
{
"jwt": "<string>",
"profile": {
"account_equity": 123,
"account_leverage": 123,
"account_margin": 123,
"balance": 123,
"cum_trading_volume": 123,
"cum_unrealized_pnl": 123,
"health": 123,
"id": 123,
"last_liq_check": 123,
"last_update": 123,
"leverage": {},
"orders": [
{
"client_order_id": "<string>",
"created_at": 123,
"id": "<string>",
"initial_size": 123,
"market_id": "<string>",
"order_type": "<string>",
"price": 123,
"profile_id": 123,
"reason": "<string>",
"side": "<string>",
"size": 123,
"size_percent": 123,
"status": "<string>",
"time_in_force": "<string>",
"timestamp": 123,
"total_filled_size": 123,
"trigger_price": 123,
"updated_at": 123
}
],
"positions": [
{
"entry_price": 123,
"fair_price": 123,
"id": "<string>",
"liquidation_price": 123,
"margin": 123,
"market_id": "<string>",
"notional": 123,
"profile_id": 123,
"side": "<string>",
"size": 123,
"unrealized_pnl": 123
}
],
"profile_notifications": [
{
"description": "<string>",
"title": "<string>",
"type": "<string>"
}
],
"profile_type": "<string>",
"status": "<string>",
"total_notional": 123,
"total_order_margin": 123,
"total_position_margin": 123,
"wallet": "<string>",
"withdrawable_balance": 123
},
"randomSecret": "<string>",
"refreshToken": "<string>"
}
],
"success": true
}
Onboarding request payload
The body is of type object
.
OK
The response is of type object
.
{
"error": "<string>",
"pagination": {
"limit": 123,
"order": "<string>",
"page": 123,
"total": 123
},
"result": [
{
"jwt": "<string>",
"profile": {
"account_equity": 123,
"account_leverage": 123,
"account_margin": 123,
"balance": 123,
"cum_trading_volume": 123,
"cum_unrealized_pnl": 123,
"health": 123,
"id": 123,
"last_liq_check": 123,
"last_update": 123,
"leverage": {},
"orders": [
{
"client_order_id": "<string>",
"created_at": 123,
"id": "<string>",
"initial_size": 123,
"market_id": "<string>",
"order_type": "<string>",
"price": 123,
"profile_id": 123,
"reason": "<string>",
"side": "<string>",
"size": 123,
"size_percent": 123,
"status": "<string>",
"time_in_force": "<string>",
"timestamp": 123,
"total_filled_size": 123,
"trigger_price": 123,
"updated_at": 123
}
],
"positions": [
{
"entry_price": 123,
"fair_price": 123,
"id": "<string>",
"liquidation_price": 123,
"margin": 123,
"market_id": "<string>",
"notional": 123,
"profile_id": 123,
"side": "<string>",
"size": 123,
"unrealized_pnl": 123
}
],
"profile_notifications": [
{
"description": "<string>",
"title": "<string>",
"type": "<string>"
}
],
"profile_type": "<string>",
"status": "<string>",
"total_notional": 123,
"total_order_margin": 123,
"total_position_margin": 123,
"wallet": "<string>",
"withdrawable_balance": 123
},
"randomSecret": "<string>",
"refreshToken": "<string>"
}
],
"success": true
}