Partner Support
User Flows
General API
- Builder Info
- System Info
- USDC Faucet
User API
- Registration
- Key Management
- Account/User Info
- Account Notifications
- Account Config
- Delegate Signer
- Sub-account
Trading API
- Order Management
- Liquidations
- Assets/Withdraw/Settle PnL
- Positions
- Funding
Rewards API
- Trading Rewards
- Market Making Rewards
Staking & Valor API
- Staking
- Valor
Builder API
- User Data
- Trading Campaigns
- Fee Setting
- Referral Program
Market Data API
- TradingView
- Funding Rates
- Market Info
Websocket API
- Introduction
- PING/PONG
- Authentication
- Error Response
- Public Market Data
- Private User Data
Assets/Withdraw/Settle PnL
Request PnL Settlement
Limit: 1 requests per 1 second
POST /v1/settle_pnl
verifyingContract
should use: 0x6F7a338F2aA472838dEFD3283eB360d4Dff5D203
.
POST
/
v1
/
settle_pnl
Copy
curl --request POST \
--url https://api.orderly.org/v1/settle_pnl \
--header 'Content-Type: application/json' \
--header 'orderly-account-id: <orderly-account-id>' \
--header 'orderly-key: <orderly-key>' \
--header 'orderly-signature: <orderly-signature>' \
--header 'orderly-timestamp: <orderly-timestamp>' \
--data '{
"signature": "<string>",
"userAddress": "<string>",
"verifyingContract": "<string>",
"message": {
"brokerId": "<string>",
"chainId": 123,
"chainType": "<string>",
"settleNonce": 123,
"timestamp": 123
}
}'
Copy
{
"success": true,
"data": {
"settle_pnl_id": 889
},
"timestamp": 1692246987774
}
Headers
Body
application/json
Response
200 - application/json
OK
The response is of type object
.
Copy
curl --request POST \
--url https://api.orderly.org/v1/settle_pnl \
--header 'Content-Type: application/json' \
--header 'orderly-account-id: <orderly-account-id>' \
--header 'orderly-key: <orderly-key>' \
--header 'orderly-signature: <orderly-signature>' \
--header 'orderly-timestamp: <orderly-timestamp>' \
--data '{
"signature": "<string>",
"userAddress": "<string>",
"verifyingContract": "<string>",
"message": {
"brokerId": "<string>",
"chainId": 123,
"chainType": "<string>",
"settleNonce": 123,
"timestamp": 123
}
}'
Copy
{
"success": true,
"data": {
"settle_pnl_id": 889
},
"timestamp": 1692246987774
}
Assistant
Responses are generated using AI and may contain mistakes.