Native Documentation
  • introduction
    • What is Native
    • About Native V2
    • Benefits for Key Players
  • SOLUTION
    • Native Credit Pool
    • Native Swap Engine
  • CONCEPTS
    • Orderbook
    • Firm Quote Orders
    • Auto Sign Orders
    • Swap Fees
    • Slippage
    • Base and Listed Assets
    • Single-Sided Liquidity Pools
    • Total Available Liquidity
    • Liquidity Pairing
    • Liquidity Bootstrapping
    • Health Ratio
    • Earning Fees and Incentives
    • Credit-Based Swap
      • Collateral Factor
      • PMM Credit
      • Settlement and Liquidation
    • Market-Responsive Pricing
    • Risks
  • USER GUIDE
    • Add Liquidity
    • Pair Liquidity
    • Claim Rewards
    • Swap with Native
  • Build with Native
    • Swap Aggregators
      • Guide
      • FirmQuote Swap APIs
        • GET Orderbook
        • GET Indicative quote
        • GET Firm quote
    • Asset Issuers
      • For Pegged Assets
      • For General Assets
  • Resources
    • Addresses
    • Audits
    • Github
    • System Status
    • Business Source License
    • Media Kit
Powered by GitBook
On this page
  1. Build with Native
  2. Private Market Makers[june]
  3. PMM API

POST Liquidation

Last updated 10 months ago

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

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
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: ethereumPossible values:
Responses
201
Success
application/json
Responseobject
500
There was an exception with the server
post
POST /lend/v1/lend/liquidation HTTP/1.1
Host: newapi.native.org
apiKey: text
Content-Type: application/json
Accept: */*
Content-Length: 176

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