Get Event Contract Settlement Records

Query Event Contract settlement records. Returns records in the past 2 years.

info

• Only Event Contract maker accounts are allowed to access this endpoint.
• Default query window: 7 days if startTime/endTime are not specified.

HTTP Request

GET/v5/event/settlements

Request Parameters

Parameter	Required	Type	Comments
symbol	true	string	Symbol name, e.g. ETHUSDT-28AUG26-2450-2570-OUT
orderId	false	string	Order ID filter
startTime	false	integer	Start time in milliseconds. Default: 7 days ago
endTime	false	integer	End time in milliseconds. Default: now
limit	false	integer	Number of items per page. Default: 50, Range: [1, 100]
cursor	false	string	Pagination cursor

Response Parameters

Parameter	Type	Comments
list	array	Event Contract settlement record list
> transId	string	Transaction ID
> symbol	string	Symbol name
> symbolId	string	Symbol ID
> baseCoin	string	Base coin
> settleCoin	string	Settle coin
> side	string	Side: Buy or Sell
> ecContractType	string	Event contract type: UpDown, Target, Range
> ecDirection	string	Direction: UP/DOWN (UpDown type), ABOVE/BELOW (Target type), RANGE_IN/RANGE_OUT (Range type)
> settlePrice	string	Settlement price
> entryPrice	string	Entry price
> grossPayoutRatio	string	Gross payout ratio
> ecDurationWindow	string	Duration window in seconds
> ecTargetPrice	string	Target price. Target type only.
> ecLowerBound	string	Lower bound. Range type only.
> ecUpperBound	string	Upper bound. Range type only.
> transTime	string	Transaction time in milliseconds
> crossSeq	string	Cross sequence number
> execFee	string	Execution fee
> execFeeRate	string	Execution fee rate
> payout	string	Settlement payout amount
> sessionRpl	string	Session realised PnL
> orderId	string	Related order ID
cursor	string	Cursor for next page pagination

---

Request Example

GET /v5/event/settlements?symbol=ETHUSDT-28AUG26-2450-2570-OUT&limit=50 HTTP/1.1
Host: api.bybit.com
X-BAPI-SIGN: XXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1694402559000
X-BAPI-RECV-WINDOW: 5000

Response Example

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "list": [
            {
                "transId": "tx-001",
                "symbol": "ETHUSDT-28AUG26-2450-2570-OUT",
                "symbolId": "100001",
                "baseCoin": "BTC",
                "settleCoin": "USDT",
                "side": "Buy",
                "ecContractType": "UpDown",
                "ecDirection": "UP",
                "settlePrice": "26500",
                "entryPrice": "26000.5",
                "grossPayoutRatio": "1.85",
                "ecDurationWindow": "300",
                "ecTargetPrice": "",
                "ecLowerBound": "",
                "ecUpperBound": "",
                "transTime": "1694515498753",
                "crossSeq": "31413030",
                "execFee": "0.5",
                "execFeeRate": "0.01",
                "payout": "92.5",
                "sessionRpl": "42.5",
                "orderId": "1234567890"
            }
        ],
        "cursor": ""
    },
    "retExtInfo": {},
    "time": 1694402560000
}