POST Liquidation

Whitelisted liquidator can request for Marker Maker liquidation by specifying what position they want to close and how much collateral they want to claim. Liquidator can do partial liquidation as long as the Market Maker credit health is increasing.

post

/v1/lend/liquidation

Header parameters

apiKeystringrequired

The API key that was assigned to you by Native

Body

traderstringrequired

The address of the trader

Pattern: ^0x[a-fA-F0-9]{40}$

recipientstringrequired

The address of the market maker or the settler

Pattern: ^0x[a-fA-F0-9]{40}$

chainstring · enumrequired

Native blockchain name, eg: ethereum, bsc, etc

Example: ethereum

Options: ethereum, bsc, bsc_testnet, sepolia, polygon, mumbai, arbitrum, avalanche, mantle, zetachain_athens3, base, manta, scroll, zetachain, linea, zklink, morph_testnet, morph_holesky_testnet, mantle_sepolia_testnet, polygon_amoy_testnet, avalanche_fuji_testnet, berachain_bartio_testnet

positionUpdatesobject[]required

The market maker position(s) that you want to close

claimCollateralsobject[]required

How much collateral you want to claim from the market maker

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://newapi.native.org/lend/v1/lend/liquidation' \
  --header 'apiKey: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "trader": "text",
    "recipient": "text",
    "chain": "ethereum",
    "positionUpdates": [
      {
        "tokenAddress": "text",
        "amount": "text"
      }
    ],
    "claimCollaterals": [
      {
        "tokenAddress": "text",
        "amount": "text"
      }
    ]
  }'

201

500

201

{}

Success

During time delay

{
    "status": "pending",
    "readyAt": "2024-01-31T09:39:15.776Z",
    "expiresAt": "2024-01-31T09:40:15.776Z"
}

• Note that for position updates: A positive amount means you want to close short position by depositing money in, negative amount means you want to close long position by withdraw the money out.

• Claim collateral amount is always positive meaning how much collateral amount you want to claim