NAVI API

1. NAVI Pools API

Base URL: https://open-api.naviprotocol.io/api/navi/pools

Method: GET

Description: Fetches detailed information about the NAVI Protocol Pools, including:

  1. Supply and Borrow Details:

    • Current supply and borrow indexes: currentSupplyIndex, currentBorrowIndex

    • Total supply and borrowed amounts: totalSupplyAmount, borrowedAmount

    • Treasury details: treasuryBalance and more.

  2. Pool Parameters:

    • Loan-to-Value (LTV): ltv

    • Supply and borrow caps: supplyCapCeiling, borrowCapCeiling

  3. Incentive Data:

    • Supply and borrow incentives with APY details: supplyIncentiveApyInfo, borrowIncentiveApyInfo

Sample Response:

{
      "borrowCapCeiling": "900000000000000000000000000",
      "coinType": "0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
      "currentBorrowIndex": "1116524042153776588547130964",
      "currentBorrowRate": "68416358820350495021185607",
      "currentSupplyIndex": "1039665797279616681092618808",
      "currentSupplyRate": "35127941119962108657922993",
      "id": 0,
      "isIsolated": false,
      "lastUpdateTimestamp": "1733450139160",
      "ltv": "750000000000000000000000000",
      "oracleId": 0,
      "reserveFieldA": "0",
      "reserveFieldB": "0",
      "reserveFieldC": "0",
      "supplyCapCeiling": "7.5e+34",
      "treasuryBalance": "2313971512229",
      "treasuryFactor": "100000000000000000000000000",
      "totalSupplyAmount": "52969686454591258",
      "minimumAmount": "7500000",
      "leftSupply": "22030313.54540874",
      "validBorrowAmount": "47672717809132132.2",
      "borrowedAmount": "33996182745883118",
      "leftBorrowAmount": "47672717775135949.2",
      "availableBorrow": "13676535063249014.2",
      "oracle": {
        "decimal": 9,
        "value": "4348335140",
        "price": "4.34833514",
        "oracleId": 0,
        "valid": true
      },
      "supplyIncentiveApyInfo": {
        "vaultApr": "3.512",
        "boostedApr": "1.396",
        "stakingYieldApy": "0",
        "rewardCoin": [
          "549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT",
          "a99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX"
        ],
        "apy": "4.908"
      },
      "borrowIncentiveApyInfo": {
        "vaultApr": "6.841",
        "boostedApr": "6.353",
        "stakingYieldApy": "0",
        "rewardCoin": [
          "549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT",
          "a99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX"
        ],
        "apy": "0.488"
      }
  }

2. NAVI Package API

Base URL: https://open-api.naviprotocol.io/api/package Method: GET

Description: Returns the current NAVI package ID and details of outdated package versions for backward compatibility.

Sample Response:

3. NAVI Config API

Base URL: https://open-api.naviprotocol.io/api/navi/contract/configs Method: GET

Description: Provides detailed configuration data for NAVI Protocol, including reserve data, price feeds, and flash loan configurations:

  • Reserve Data: Supply and borrow caps, rates, LTV, treasury balance, and liquidation factors.

  • Price Feed: Oracle details, pricing thresholds, and historical price settings.

  • Flash Loan Configurations: Max/min amounts, supplier rates, and treasury rates.

Sample Response:

4. NAVI Fee and Revenue API

Base URL: https://open-api.naviprotocol.io/api/navi/fee?fromTimestamp={fromTimeStamp}

Method: GET

Description: Fetches NAVI's fee and revenue data starting from a specified timestamp. The data is calculated for each 24-hour period.

Parameters:

  • fromTimestamp (integer): The starting time in Unix timestamp format.

Sample Response:

5. NAVI Flashloan Config API

Base URL: https://open-api.naviprotocol.io/api/navi/flashloan

Method: GET

Description: Fetches the configuration details for NAVI's flashloan settings, including limits, fees, and pool information.

Explanation of Response Parameters:

  1. 0x2::sui::SUI:

    • Represents the asset pool for which the flashloan configuration is provided. In this case, it is the SUI token.

  2. max:

    • The maximum amount with token decimal of this asset available for a single flashloan transaction.

    • Value in the example: "200000000000000" (denoted in the smallest unit of the asset).

  3. min:

    • The minimum amount with token decimal of this asset required to initiate a flashloan.

    • Value in the example: "0" (indicating no minimum amount is required).

  4. assetId:

    • A unique asset id for the asset within the NAVI Protocol.

    • Value in the example: 0.

  5. poolId:

    • The unique id of the pool from which the flashloan will be provided.

    • Value in the example: "0x96df0fce3c471489f4debaaa762cf960b3d97820bd1f3f025ff8190730e958c5".

  6. supplierFee:

    • The fee charged to suppliers of the asset for participating in the flashloan mechanism.

    • Value in the example: 0 (indicating no supplier fee is charged).

  7. flashloanFee:

    • The fee rate (percentage) charged for executing the flashloan.

    • Value in the example: 0.0006 (indicating a 0.06% fee for the loan amount).

Sample Response:

6. NAVI Oracle API

Base URL: https://open-api.naviprotocol.io/api/navi/oracle

Method: GET

Description: Fetches oracle-related configuration and data for NAVI, including price feed settings, thresholds, and parameters for calculating effective prices.

Sample Response:

7. NAVI Claimed Rewards History

Base URL: https://open-api.naviprotocol.io/api/navi/user/rewards?userAddress={userAddress}

Method: GET

Description: Retrieves the transaction IDs of rewards claimed by a specific user, identified by their wallet address.

Parameters:

  • userAddress (string): The user address string

Sample Response:

PreviousNAVI API CollectionNextafSui, haSui, vSui API

Last updated