POST Request settlement

Creates a settlement request and starts the time delay. Note that Market Maker will be paused from other activities at this point.

POSThttps://newapi.native.org/lend/v1/lend/request-settlement

Header parameters

Body

application/json

chain*enum

Native blockchain name, eg: ethereum, bsc, etc

Example: "ethereum"

ethereumbscbsc_testnetsepoliapolygonmumbaiarbitrumavalanchemantlezetachain_athens3basemantascrollzetachainlineazklinkmorph_testnetmorph_holesky_testnetmantle_sepolia_testnetpolygon_amoy_testnetavalanche_fuji_testnetberachain_bartio_testnet

recipient*string

The address of the market maker or the settler

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

positionUpdates*array of TokenAmount (object)

The position updates for the settlement

trader*string

The address of the trader

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

Response

201500

Success

Body

application/json

chain*enum

Native blockchain name, eg: ethereum, bsc, etc

Example: "ethereum"

ethereumbscbsc_testnetsepoliapolygonmumbaiarbitrumavalanchemantlezetachain_athens3basemantascrollzetachainlineazklinkmorph_testnetmorph_holesky_testnetmantle_sepolia_testnetpolygon_amoy_testnetavalanche_fuji_testnetberachain_bartio_testnet

recipient*string

The address of the market maker or the settler

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

positionUpdates*array of TokenAmount (object)

The position updates for the settlement

trader*string

The address of the trader

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

Request

JavaScriptCurlPython

const response = await fetch('https://newapi.native.org/lend/v1/lend/request-settlement', {
    method: 'POST',
    headers: {
      "apiKey": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chain": "ethereum",
      "recipient": "text",
      "positionUpdates": [
        {
          "tokenAddress": "text",
          "amount": "text"
        }
      ],
      "trader": "text"
    }),
});
const data = await response.json();

Response

201

{
  "chain": "ethereum",
  "recipient": "text",
  "positionUpdates": [
    {
      "tokenAddress": "text",
      "amount": "text"
    }
  ],
  "trader": "text"
}

Example response

{
    "id": "d49c39ed-ff63-41c0-bf3a-75f6d56f7346",
    "nonce": "6168514449590345",
    "recipient": "0x9B85B4A413Efe69684290816a3E814B4aA1EFf63",
    "chain": "base",
    "positionUpdates": [
        {
            "tokenAddress": "0x4200000000000000000000000000000000000006",
            "amount": "-5000000000"
        }
    ],
    "creditChangeUsd": -0.00001168615,
    "trader": "0x9B85B4A413Efe69684290816a3E814B4aA1EFf63",
    "requestAt": "2024-01-31T08:09:22.645Z",
    "enableAt": "2024-01-31T08:14:22.645Z",
    "expiresAt": "2024-01-31T08:15:22.645Z",
    "type": "settlement"
}

Error responses

// Try to withdraw more than long position amount
{
    "statusCode": 400,
    "message": "Cannot make long position to become short position",
    "error": "Bad Request"
}

// Try to deposit into long position
{
    "statusCode": 400,
    "message": "Cannot increasing existing long position",
    "error": "Bad Request"
}

// Try to deposit more than short position amount
{
    "statusCode": 400,
    "message": "Cannot make short position to become long position",
    "error": "Bad Request"
}

// Try to withdraw from short position
{
    "statusCode": 400,
    "message": "Cannot decreasing existing short position",
    "error": "Bad Request"
}

// Invalid token address
{
    "statusCode": 400,
    "message": "Cannot settle unexist position",
    "error": "Bad Request"
}

// Invalid mm
{
    "statusCode": 404,
    "message": "MM Settings not found",
    "error": "Not Found"
}