Docs

Build Morpho Blue collateral-withdrawal calls

Builds and simulates wallet calls for withdrawing an exact collateral-asset amount from a Morpho Blue market.


POST
/v0/actions/blue/markets/{market-selector}/withdraw-collateral

The account's accrued position is used, and the withdrawal keeps a safety margin under the market's liquidation loan-to-value. Any signature_mode other than none requests Morpho authorization typed data instead of an authorization call when available.

Authorization

ApiKeyAuth
x-api-key<token>

Send your Morpho-issued key on every action request. JWKS needs no key on every host; public documentation needs no key.

In: header

Path Parameters

market-selector*string

Morpho Blue market selector formatted as <chain_id>:<market_id>. The chain ID is at most 9007199254740991.

Match^(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]{1}|9007199254740990|9007199254740991):0x[0-9a-fA-F]{64}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v0/actions/blue/markets/{market-selector}/withdraw-collateral" \  -H "Content-Type: application/json" \  -d '{    "account": "0x6aBB9Aeb93e9aF04c8D9FD2b84BF6ca8EDC3eAf2",    "amount": {      "unit": "assets",      "value": "1000000"    }  }'

{  "data": {    "action_id": "act_0123456789abcdef0123456789abcdef",    "status": "prepared",    "chain_id": 8453,    "account": "0x545b6Cc751F0C47C202694cf835db2E3C071400A",    "expires_at": 4000000000,    "market": {      "id": "0x9103c3b4e834476c9a62ea009ba2c884ee42e94e6e314a26f04d312434191836",      "collateral_asset": {        "address": "0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf"      }    },    "amount": {      "unit": "assets",      "value": "1000000"    },    "action": "blue.withdraw_collateral",    "calls": [      {        "id": "call_0",        "kind": "blue_withdraw_collateral",        "to": "0x4D28D900e381eCE4B351302f1Abe588496793A2b",        "data": "0x827d6bd8000000000000000000000000833589fcd6edb6e08f4c7c32d4f71b54bda02913000000000000000000000000cbb7c0000ab88b473b1f5afd9ef808440eed33bf000000000000000000000000663becd10dae6c4a3dcd89f1d76c1174199639b900000000000000000000000046415998764c29ab2a25cbea6254146d50d226870000000000000000000000000000000000000000000000000bef55718ad6000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f4240ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0000000000000000000000000000000000000000000000000000000000000260000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000ee6b2800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000000",        "value": "0"      }    ],    "simulation": {      "status": "success",      "block": {        "number": "21000000",        "timestamp": 1760000000      },      "wallet_changes": [        {          "asset": {            "type": "erc20",            "address": "0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf"          },          "difference": "1000000"        }      ],      "position_changes": {        "supply_shares": "0",        "borrow_shares": "0",        "collateral_assets": "-1000000"      },      "effects": {        "withdrawn_collateral_assets": "1000000",        "ltv_bps": 2501,        "max_ltv_bps": 8550      }    }  }}

The amount must be a positive decimal string that fits uint256.

{  "error": {    "code": "VALIDATION_FAILED",    "message": "Validation failed",    "details": [      {        "code": "invalid_format",        "message": "Expected a positive decimal string",        "path": [          "amount",          "value"        ]      },      {        "code": "custom",        "message": "Expected an amount that fits in uint256",        "path": [          "amount",          "value"        ]      }    ],    "request_id": "req_0123456789abcdef"  }}

The selected Morpho Blue market was not found on this chain.

{  "error": {    "code": "MARKET_NOT_FOUND",    "message": "The Morpho Blue market does not exist on this chain.",    "details": null,    "request_id": "req_0123456789abcdef"  }}

Request bodies must not exceed 16384 bytes.

{  "error": {    "code": "PAYLOAD_TOO_LARGE",    "message": "Request body too large.",    "details": [      {        "code": "too_big",        "message": "Request body exceeds the 16384-byte limit",        "path": [          "body"        ]      }    ],    "request_id": "req_0123456789abcdef"  }}

Restart the same action without the continuation, sign the newly returned typed data, then finalize with the new continuation.

{  "error": {    "code": "SIGNATURE_REFRESH_REQUIRED",    "message": "The prepared signature nonce or deadline is no longer usable.",    "details": null,    "request_id": "req_0123456789abcdef"  }}

Empty
{  "error": {    "code": "INTERNAL_ERROR",    "message": "string",    "details": [      {        "code": "string",        "message": "string",        "path": [          "string"        ],        "rule": "string",        "details": {          "min_assets": "string",          "loan_token": "string"        }      }    ],    "request_id": "string"  }}

Chain state is temporarily unavailable; retry.

{  "error": {    "code": "STATE_UNAVAILABLE",    "message": "Chain state is temporarily unavailable.",    "details": null,    "request_id": "req_0123456789abcdef"  }}