Skip to main content

​
Request

{
    "message": "updateMargin",
    "content": {
        "clientRequestId": "79b89ec3-b89b-4e9e-aff3-9a6ff0184009",
        "margin": "201"
    }
}
FieldTypeRequiredDescription
messagestringYesupdateMargin
content.clientRequestIdstringNoClient-generated UUID for correlation
content.marketstringNoMarket name, only required when connecting with market=ALL
content.marginstringYesAbsolute target value for isolatedPositionMargin after the update

​
Response — Acknowledgment

{
    "resultType": "updateMargin",
    "market": "BTC-USD",
    "data": {
        "statusCode": 202,
        "body": "margin update in progress, pending approval",
        "clientRequestId": "79b89ec3-b89b-4e9e-aff3-9a6ff0184009",
        "apiQuotaUsed": 1
    }
}
FieldTypeRequiredDescription
resultTypestringYesupdateMargin
marketstringYesMarket name
data.statusCodenumberYes202
data.bodystringYesStatus message
data.clientRequestIdstringNoClient-generated UUID for correlation
data.apiQuotaUsednumberYesAPI quota consumed

​
Response — Confirmation

{
    "resultType": "updateMargin",
    "market": "BTC-USD",
    "data": {
        "statusCode": 200,
        "body": "margin updated successfully",
        "clientRequestId": "79b89ec3-b89b-4e9e-aff3-9a6ff0184009"
    }
}
If the requested margin value matches the current isolatedPositionMargin, the operation is a successful no-op. In this case, no 202 acknowledgment is sent first — the 200 is returned directly: 
{
    "resultType": "updateMargin",
    "market": "BTC-USD",
    "data": {
        "statusCode": 200,
        "body": "margin is the same as the current margin, no update needed",
        "clientRequestId": "79b89ec3-b89b-4e9e-aff3-9a6ff0184009"
    }
}
FieldTypeRequiredDescription
resultTypestringYesupdateMargin
marketstringYesMarket name
data.statusCodenumberYes200
data.bodystringYesStatus message
data.clientRequestIdstringNoClient-generated UUID for correlation

​
Response — Error

{
    "resultType": "updateMargin",
    "market": "BTC-USD",
    "data": {
        "statusCode": 400,
        "body": "margin decrease below minimum required margin",
        "clientRequestId": "acd02c47-3e8a-41af-aecb-9b60177554fd",
        "error": {
            "code": "0006",
            "slug": "BAD_REQUEST"
        }
    }
}

{
    "resultType": "updateMargin",
    "market": "BTC-USD",
    "data": {
        "statusCode": 429,
        "body": "api call rate limit exceeded",
        "error": {
            "slug": "TOO_MANY_REQUESTS",
            "code": "0003"
        },
        "apiQuotaUsed": 10001,
        "retryAfterSec": 300,
        "clientRequestId": "79b89ec3-b89b-4e9e-aff3-9a6ff0184009"
    }
}

{
    "resultType": "updateMargin",
    "market": "BTC-USD",
    "data": {
        "statusCode": 500,
        "body": "Internal Server Error",
        "error": {
            "slug": "UPDATE_MARGIN_ERROR",
            "code": "8000"
        },
        "apiQuotaUsed": 1,
        "clientRequestId": "79b89ec3-b89b-4e9e-aff3-9a6ff0184009"
    }
}
FieldTypeRequiredDescription
resultTypestringYesupdateMargin
marketstringYesMarket name
data.statusCodenumberYesError status (400, 429, 500)
data.bodystringYesError description
data.error.slugstringYesError slug
data.error.codestringYesError code
data.apiQuotaUsednumberYesAPI quota consumed
data.retryAfterSecnumberNoPresent when throttled
data.clientRequestIdstringNoClient-generated UUID for correlation