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.

post

/v1/lend/request-settlement

Header parameters

apiKeystringrequired

The API key that was assigned to you by Native

Body

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

recipientstringrequired

The address of the market maker or the settler

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

positionUpdatesobject[]required

The position updates for the settlement

traderstringrequired

The address of the trader

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

201

500

201

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

Success

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"
}