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:

{
  "packageId": "0x834a86970ae93a73faf4fff16ae40bdb72b91c47be585fff19a2af60a19ddca3",
  "outdated": [
    {
      "packageId": "0x66aa3335901ce7e04b85ed6597ee42d4b479f7110bf98e8ebd474fa32a0027e1",
      "version": 19
    },
    ...
  ]
}

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:

{
      "coin_type": "0x5f496ed5d9d045c5b788dc1bb85f54100f2ede11e46f6a232c29daada4c5bdb6::coin::COIN",
      "symbal": "stBTC",
      "reserve_data": {
        "id": 14,
        "oracle_id": 14,
        "is_solated": false,
        "coin_type": "5f496ed5d9d045c5b788dc1bb85f54100f2ede11e46f6a232c29daada4c5bdb6::coin::COIN",
        "supply_cap_ceiling": "580",
        "borrow_cap_ceiling": "0%",
        "current_supply_rate": "0",
        "current_borrow_rate": "0",
        "current_supply_index": "1",
        "current_borrow_index": "1",
        "borrow_balance": {
          "total_supply": "0"
        },
        "supply_balance": {
          "total_supply": "5,501.08"
        },
        "ltv": "35%",
        "treasury_factor": "10%",
        "treasury_balance": "0",
        "borrow_rate_factors": {
          "base_rate": "0%",
          "optimal_utilization": "50%",
          "multiplier": "8%",
          "jump_rate_multiplier": "600%",
          "reserve_factor": "20%"
        },
        "liquidation_factors": {
          "bonus": "5%",
          "threshold": "45%",
          "ratio": "35%"
        },
        "last_update_timestamp": "2024-12-06T00:10:18.832Z"
      },
      "price_feed": {
        "id": "0xdf9b254a7a64742e1edf8c48bd2a1f182b52f020de2ab070ae0e3f9228d05280",
        "coin_type": "0x5f496ed5d9d045c5b788dc1bb85f54100f2ede11e46f6a232c29daada4c5bdb6::coin::COIN",
        "oracle_id": 14,
        "enable": true,
        "max_timestamp_diff": "30000",
        "price_diff_threshold1": "100",
        "price_diff_threshold2": "300",
        "max_duration_within_thresholds": "30000",
        "diff_threshold2_timer": "0",
        "historical_price_ttl": "300000",
        "primary": "PythOracleProvider",
        "secondary": "SupraOracleProvider",
        "maximum_allowed_span_percentage": "700",
        "maximum_effective_price": "200,000",
        "minimum_effective_price": "1"
      },
      "flash_loan_config": {
        "id": "",
        "asset_id": 0,
        "pool_id": "",
        "coin_type": "0x5f496ed5d9d045c5b788dc1bb85f54100f2ede11e46f6a232c29daada4c5bdb6::coin::COIN",
        "max": 0,
        "min": 0,
        "rate_to_supplier": 0,
        "rate_to_treasury": 0
      }
    },

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:

{
  "data": {
    "from": 1732587539,
    "to": 1732673939,
    "flashLoanRevenue": 47.8772023048398,
    "borrowInterestRevenue": 8856.9845984033,
    "borrowInterestFee": 35427.9383936132,
    "borrowRevenue": 8244.74392228731,
    "naviDailyRevenue": 17149.6057229954
  },
  "code": 0
}

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:

{
  "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI": {
    "max": "200000000000000",
    "min": "0",
    "assetId": 0,
    "poolId": "0x96df0fce3c471489f4debaaa762cf960b3d97820bd1f3f025ff8190730e958c5",
    "supplierFee": 0,
    "flashloanFee": 0.0006
  }
}

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:

{
  "SUI": {
    "oracleId": 0,
    "maxTimestampDiff": 30000,
    "priceDiffThreshold1": 100,
    "priceDiffThreshold2": 300,
    "maxDurationWithinThresholds": 30000,
    "maximumAllowedSpanPercentage": 700,
    "maximumEffectivePrice": 10000000000,
    "minimumEffectivePrice": 100000000,
    "historicalPriceTTL": 300000,
    "coinType": "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
    "feedId": "0x2cab9b151ca1721624b09b421cc57d0bb26a1feb5da1f821492204b098ec35c9",
    "supraPairId": 90,
    "pythPriceFeedId": "0x23d7315113f5b1d3ba7a83604c44b94d79f4fd69af77f804fc7f920a6dc65744",
    "pythPriceInfoObject": "0x801dbc2f0053d34734814b2d6df491ce7807a725fe9a01ad74a07e9c51396c37",
    "priceDecimal": 9,
    "expiration": 30
  }
}

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:

{
  "amount": "1752445",
  "pool": "0x9b646906608b791a2fc65ec246d2a18e0d49e5fd0aae29dbfbaf0112885d93c9",
  "sender": "0x9f4c3feee7b70d6cf2d0c25296c4581bd4c281b11f45910c94bb8a962db0349d",
  "timestamp": "2024-12-06T01:02:59.512Z",
  "coin_type": "a99b8952d4f7d947ea77fe0ecdcc9e5fc0bcab2841d6e2a5aa00c3044e5544b5::navx::NAVX",
  "token_price": 0.144426003098488
}
PreviousNAVI API CollectionNextafSui, haSui, vSui API

Last updated