Skip to main content

Modify Position

info

API key needs "Earn" permission

note

Only positions with duration = Fixed support setting auto-reinvestment. You can get the duration value from the response of GET /v5/earn/product?category=OnChain.

HTTP Request

POST/v5/earn/position/modify

Request Parameters

ParameterRequiredTypeComments
categorytruestringProduct category. Fixed value: OnChain
productIdtrueintegerProduct ID. Obtained from GET /v5/earn/product
positionIdtrueintegerPosition ID. Obtained from GET /v5/earn/position
autoReinvesttrueintegerAuto-reinvestment switch. 0: Off, 1: On

Response Parameters

ParameterTypeComments
retCodeintegerReturn code. 0 means success
retMsgstringReturn message. Empty string "" on success

Request Example

POST /v5/earn/position/modify HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1773732693000
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
"category": "OnChain",
"productId": 8,
"positionId": 326,
"autoReinvest": 1
}

Response Example

{
"retCode": 0,
"retMsg": "",
"result": {},
"retExtInfo": {},
"time": 1773732693032
}