Skip to main content

Get Event Contract Position Info

Query real-time Event Contract position data. Covers UpDown, Target, and Range contract types.

info
  • Only Event Contract maker accounts are allowed to access this endpoint.

HTTP Request

GET/v5/event/positions

Request Parameters

ParameterRequiredTypeComments
symbolfalsestringSymbol name, e.g. ETHUSDT-28AUG26-2450-2570-OUT. If not passed, returns all Event Contract positions
baseCoinfalsestringBase coin filter, e.g. BTC
settleCoinfalsestringSettle coin filter, e.g. USDT
limitfalseintegerNumber of items per page. Default: 20, Range: [1, 50]
cursorfalsestringPagination cursor. Use nextPageCursor from the response to retrieve the next page

Response Parameters

ParameterTypeComments
listarrayEvent Contract position list
> symbolstringSymbol name
> baseCoinstringBase coin
> settleCoinstringSettle coin
> sidestringPosition side: Buy (long), Sell (short)
> ecContractTypestringEvent contract type: UpDown, Target, Range
> ecDirectionstringDirection: UP/DOWN (UpDown type), ABOVE/BELOW (Target type), RANGE_IN/RANGE_OUT (Range type)
> avgPayoutRatiostringAverage payout ratio
> positionValuestringPosition value (cumulative executed value)
> ecSettleTimestringExpected settlement time in milliseconds
> cumClosedPnlstringCumulative settled profit and loss
> createdTimestringPosition creation timestamp in milliseconds
> updatedTimestringPosition update timestamp in milliseconds
> seqlongCross sequence number for ordering
nextPageCursorstringCursor for next page pagination

Request Example

GET /v5/event/positions?symbol=ETHUSDT-28AUG26-2450-2570-OUT&limit=20 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": [
{
"symbol": "ETHUSDT-28AUG26-2450-2570-OUT",
"baseCoin": "BTC",
"settleCoin": "USDT",
"side": "Buy",
"ecContractType": "UpDown",
"ecDirection": "UP",
"avgPayoutRatio": "1.85",
"positionValue": "100",
"ecSettleTime": "1694515498753",
"cumClosedPnl": "50.5",
"createdTime": "1694402559843",
"updatedTime": "1694515498753",
"seq": 31413030
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1694402560000
}