api.md

Core

Types:

• ErrorData
• ErrorDataVariants
• ErrorKind
• ErrorResponse
• ErrorScope
• FieldValidationError
• Interval
• IntervalUnit
• ValidationErrorData
• ValidationFieldSource

Status

Types:

• StatusCheckHealthResponse

Methods:

• client.status.checkHealth() -> StatusCheckHealthResponse

Assets

Types:

• AssetClassification
• AssetInfo
• AssetMetadata
• AssetPrice
• AssetPriceHistory
• AssetRateHistory
• AssetSpec
• AssetListResponse
• AssetGetPriceHistoryResponse
• AssetListPricesResponse

Methods:

• client.assets.list() -> AssetListResponse
• client.assets.getPriceHistory({ ...params }) -> AssetGetPriceHistoryResponse
• client.assets.listPrices({ ...params }) -> AssetListPricesResponse

Markets

Types:

• GlobalMarketConfig
• MarketRate
• MarketSupplyPool
• MergedMarket
• Tvl
• MarketGetMergedResponse
• MarketGetMergedByAssetResponse
• MarketGetOverviewResponse
• MarketGetParamsResponse
• MarketGetSupplyResponse

Methods:

• client.markets.getMerged({ ...params }) -> MarketGetMergedResponse
• client.markets.getMergedByAsset({ ...params }) -> MarketGetMergedByAssetResponse
• client.markets.getOverview({ ...params }) -> MarketGetOverviewResponse
• client.markets.getParams({ ...params }) -> MarketGetParamsResponse
• client.markets.getSupply({ ...params }) -> MarketGetSupplyResponse

Lend

Types:

• LendMarket
• LendMarketData
• LendMarketState
• LendMarketSupply
• LendOverview
• LendListResponse
• LendGetByAssetResponse
• LendGetRateHistoryResponse

Methods:

• client.markets.lend.list({ ...params }) -> LendListResponse
• client.markets.lend.getByAsset({ ...params }) -> LendGetByAssetResponse
• client.markets.lend.getRateHistory({ ...params }) -> LendGetRateHistoryResponse

Borrow

Types:

• BorrowMarketOverview
• BorrowGetOverviewResponse
• BorrowGetRateHistoryResponse

Methods:

• client.markets.borrow.getOverview({ ...params }) -> BorrowGetOverviewResponse
• client.markets.borrow.getRateHistory({ ...params }) -> BorrowGetRateHistoryResponse

Collaterals

Types:

• BorrowCollateralConfig
• BorrowCollateralMarket
• BorrowCollateralMarketData
• BorrowCollateralMarketSupply
• BorrowCollateralOverview
• BorrowCollateralState
• CollateralListResponse
• CollateralGetByAssetResponse

Methods:

• client.markets.borrow.collaterals.list({ ...params }) -> CollateralListResponse
• client.markets.borrow.collaterals.getByAsset({ ...params }) -> CollateralGetByAssetResponse

Debts

Types:

• BorrowDebtConfig
• BorrowDebtMarket
• BorrowDebtMarketData
• BorrowDebtOverview
• BorrowDebtState
• DebtListResponse
• DebtGetByAssetResponse

Methods:

• client.markets.borrow.debts.list({ ...params }) -> DebtListResponse
• client.markets.borrow.debts.getByAsset({ ...params }) -> DebtGetByAssetResponse

Nept

Types:

• NeptParams
• NeptState
• NeptUnlockDistributionGroup
• StakingPoolFull
• StakingPoolParams
• StakingPoolState
• NeptGetParamsResponse
• NeptGetStakingOverviewResponse
• NeptGetStateResponse

Methods:

• client.nept.getParams({ ...params }) -> NeptGetParamsResponse
• client.nept.getStakingOverview({ ...params }) -> NeptGetStakingOverviewResponse
• client.nept.getState({ ...params }) -> NeptGetStateResponse

User

Types:

• EventAction
• User
• UserTx
• UserGetUserResponse

Methods:

• client.user.getTxHistory(address, { ...params }) -> UserTxesTxHistoryPage
• client.user.getUser(address, { ...params }) -> UserGetUserResponse

Market

Types:

• UserMarket
• UserMergedMarket
• MarketGetMergedResponse
• MarketGetMergedByAssetResponse
• MarketGetPortfolioResponse

Methods:

• client.user.market.getMerged(address, { ...params }) -> MarketGetMergedResponse
• client.user.market.getMergedByAsset(address, { ...params }) -> MarketGetMergedByAssetResponse
• client.user.market.getPortfolio(address, { ...params }) -> MarketGetPortfolioResponse

Lend

Types:

• UserLendAssetPool
• UserLendMarket
• UserLendOriginAmounts
• UserLendReceiptAmounts
• LendListResponse
• LendGetByAssetResponse

Methods:

• client.user.market.lend.list(address, { ...params }) -> LendListResponse
• client.user.market.lend.getByAsset(address, { ...params }) -> LendGetByAssetResponse

Borrow

Types:

• UserBorrowMarket
• UserBorrowMarketPools
• BorrowGetCollateralAccountsByAssetResponse
• BorrowGetCollateralTotalsResponse
• BorrowGetDebtAccountsByAssetResponse
• BorrowGetDebtsTotalsResponse
• BorrowGetPortfolioResponse

Methods:

• client.user.market.borrow.getCollateralAccountsByAsset(address, { ...params }) -> BorrowGetCollateralAccountsByAssetResponse
• client.user.market.borrow.getCollateralTotals(address, { ...params }) -> BorrowGetCollateralTotalsResponse
• client.user.market.borrow.getDebtAccountsByAsset(address, { ...params }) -> BorrowGetDebtAccountsByAssetResponse
• client.user.market.borrow.getDebtsTotals(address, { ...params }) -> BorrowGetDebtsTotalsResponse
• client.user.market.borrow.getPortfolio(address, { ...params }) -> BorrowGetPortfolioResponse

Subaccount

Types:

• UserAccountHealth
• UserBorrowMarketAccount
• UserCollateralAccountPool
• UserCollateralAssetPool
• UserDebtAccountPool
• UserDebtAssetPool
• SubaccountGetSubaccountResponse
• SubaccountGetSubaccountCollateralsResponse
• SubaccountGetSubaccountDebtsResponse
• SubaccountGetSubaccountHealthResponse

Methods:

• client.user.market.borrow.subaccount.getSubaccount(index, { ...params }) -> SubaccountGetSubaccountResponse
• client.user.market.borrow.subaccount.getSubaccountCollaterals(index, { ...params }) -> SubaccountGetSubaccountCollateralsResponse
• client.user.market.borrow.subaccount.getSubaccountDebts(index, { ...params }) -> SubaccountGetSubaccountDebtsResponse
• client.user.market.borrow.subaccount.getSubaccountHealth(index, { ...params }) -> SubaccountGetSubaccountHealthResponse

Nept

Types:

• UserUnlockAmounts
• UserUnlockOverview
• UserUnlockSchedule
• UserUnlockScheduleLinear
• UserUnlockScheduleLumpSum
• NeptGetUnlocksResponse

Methods:

• client.user.nept.getUnlocks(address, { ...params }) -> NeptGetUnlocksResponse

Staking

Types:

• UserStake
• UserStakeBondingEntry
• UserStakePool
• UserStakeUnbonding
• UserStakeUnbondingEntry
• StakingGetOverviewResponse
• StakingGetStakingPoolResponse
• StakingGetStakingPoolsResponse
• StakingGetUnstakingResponse

Methods:

• client.user.nept.staking.getOverview(address, { ...params }) -> StakingGetOverviewResponse
• client.user.nept.staking.getStakingPool(address, { ...params }) -> StakingGetStakingPoolResponse
• client.user.nept.staking.getStakingPools(address, { ...params }) -> StakingGetStakingPoolsResponse
• client.user.nept.staking.getUnstaking(address, { ...params }) -> StakingGetUnstakingResponse

Wallet

Types:

• UserWalletPortfolio
• WalletAsset
• WalletAssetKnown
• WalletAssetUnknown
• WalletBalance
• WalletGetBalanceByAssetResponse
• WalletGetBalancesResponse

Methods:

• client.user.wallet.getBalanceByAsset(address, { ...params }) -> WalletGetBalanceByAssetResponse
• client.user.wallet.getBalances(address, { ...params }) -> WalletGetBalancesResponse

Analytics

Market

Types:

• MarketGetCurrentStateResponse

Methods:

• client.analytics.market.getCurrentState() -> MarketGetCurrentStateResponse

History

Types:

• HistoryGetLoansOriginatedResponse
• HistoryGetLoansOriginatedByAssetResponse

Methods:

• client.analytics.market.history.getLoansOriginated({ ...params }) -> HistoryGetLoansOriginatedResponsesIntervalSinglePage
• client.analytics.market.history.getLoansOriginatedByAsset({ ...params }) -> HistoryGetLoansOriginatedByAssetResponse

Nept

Types:

• NeptUnlocksDistributionResponse

Methods:

• client.analytics.nept.unlocksDistribution({ ...params }) -> NeptUnlocksDistributionResponse

Swap

Routes

Types:

• SwapRouteTargetSet
• RouteListAllResponse
• RouteListByDenomResponse

Methods:

• client.swap.routes.listAll({ ...params }) -> RouteListAllResponse
• client.swap.routes.listByDenom({ ...params }) -> RouteListByDenomResponse