Skip to content
Get started

API Reference

Libraries

npm install @neptunefinance/api-v2
pip install neptune_api_v2

API Overview

Core

Status

Get API health status
GET/api/v1/status/health

Assets

Get info for all assets
GET/api/v1/assets
Get all asset prices
GET/api/v1/assets/prices
Get historical prices for assets
GET/api/v1/assets/price-history

Markets

Get market overview
GET/api/v1/markets
Get market params
GET/api/v1/markets/config
Lookup merged market data by asset
GET/api/v1/markets/merged/lookup

MarketsLend

Get lending markets
GET/api/v1/markets/lend
Lookup lending market by asset
GET/api/v1/markets/lend/lookup
Get historical lending rates for assets
GET/api/v1/markets/lend/rate-history

MarketsBorrow

Get borrowing market overview
GET/api/v1/markets/borrow
Get historical borrowing rates for assets
GET/api/v1/markets/borrow/rate-history

MarketsBorrowCollaterals

Get borrowing collateral markets
GET/api/v1/markets/borrow/collaterals
Lookup borrowing market collateral by asset
GET/api/v1/markets/borrow/collaterals/lookup

MarketsBorrowDebts

Get borrowing debt markets
GET/api/v1/markets/borrow/debts
Lookup borrowing debt market by asset
GET/api/v1/markets/borrow/debts/lookup

Nept

Get NEPT token params
GET/api/v1/nept/params
Get NEPT token state
GET/api/v1/nept/state

User

Get user
GET/api/v1/users/{address}/user
Get user tx history
GET/api/v1/users/{address}/tx-history

UserMarket

UserMarketLend

Get user lending portfolio
GET/api/v1/users/{address}/markets/lend
Lookup user lending distribution by asset
GET/api/v1/users/{address}/markets/lend/lookup

UserMarketBorrow

Get user borrow portfolio
GET/api/v1/users/{address}/markets/borrow
Lookup user borrow market collateral accounts by asset
GET/api/v1/users/{address}/markets/borrow/lookup/collateral
Lookup user borrow market debt accounts by asset
GET/api/v1/users/{address}/markets/borrow/lookup/debt
Get user combined collaterals for all subaccounts
GET/api/v1/users/{address}/markets/borrow/sum/collaterals
Get user combined debts for all subaccounts
GET/api/v1/users/{address}/markets/borrow/sum/debts

UserMarketBorrowSubaccount

Get user borrow subaccount
GET/api/v1/users/{address}/markets/borrow/accounts/{index}
Get user borrow subaccount health
GET/api/v1/users/{address}/markets/borrow/accounts/{index}/health
Get user borrow subaccount collaterals
GET/api/v1/users/{address}/markets/borrow/accounts/{index}/collaterals
Get user borrow subaccount debts
GET/api/v1/users/{address}/markets/borrow/accounts/{index}/debts

UserNept

Get user NEPT unlocks
GET/api/v1/users/{address}/nept/unlocks

UserNeptStaking

Get user staking overview
GET/api/v1/users/{address}/nept/staking
Get user staking pools
GET/api/v1/users/{address}/nept/staking/pools
Get user staking pool by duration/index
GET/api/v1/users/{address}/nept/staking/pools/lookup
Get user unstaking pool
GET/api/v1/users/{address}/nept/staking/unstaking

UserWallet

Get user portfolio
GET/api/v1/users/{address}/wallet/balances
Get user balance by asset
GET/api/v1/users/{address}/wallet/balance

Analytics

AnalyticsMarket

Get analytics for current market state
GET/api/v1/analytics/market/state

AnalyticsMarketHistory

Get cumulative lending value history independent of assets
GET/api/v1/analytics/market/history/loans-originated
Get loans originated history
GET/api/v1/analytics/market/history/loans-originated/by-asset

AnalyticsNept

Get distribution analytics for NEPT unlocks
GET/api/v1/analytics/nept/unlocks-distribution

Swap

SwapRoutes

Get swap routes for all denoms
GET/api/v1/swap/routes/all
Get swap routes for a denom
GET/api/v1/swap/routes