api.md

Core

Types:

from neptune_api_v2.types import (
    ErrorData,
    ErrorDataVariants,
    ErrorKind,
    ErrorResponse,
    ErrorScope,
    FieldValidationError,
    Interval,
    IntervalUnit,
    ValidationErrorData,
    ValidationFieldSource,
)

Status

Types:

from neptune_api_v2.types import StatusCheckHealthResponse

Methods:

• client.status.check_health() -> StatusCheckHealthResponse

Assets

Types:

from neptune_api_v2.types import (
    AssetClassification,
    AssetInfo,
    AssetMetadata,
    AssetPrice,
    AssetPriceHistory,
    AssetRateHistory,
    AssetSpec,
    AssetListResponse,
    AssetGetPriceHistoryResponse,
    AssetListPricesResponse,
)

Methods:

• client.assets.list() -> AssetListResponse
• client.assets.get_price_history(**params) -> AssetGetPriceHistoryResponse
• client.assets.list_prices(**params) -> AssetListPricesResponse

Markets

Types:

from neptune_api_v2.types import (
    GlobalMarketConfig,
    MarketRate,
    MergedMarket,
    Tvl,
    MarketGetMergedResponse,
    MarketGetMergedByAssetResponse,
    MarketGetOverviewResponse,
    MarketGetParamsResponse,
)

Methods:

• client.markets.get_merged(**params) -> MarketGetMergedResponse
• client.markets.get_merged_by_asset(**params) -> MarketGetMergedByAssetResponse
• client.markets.get_overview(**params) -> MarketGetOverviewResponse
• client.markets.get_params(**params) -> MarketGetParamsResponse

Lend

Types:

from neptune_api_v2.types.markets import (
    LendMarket,
    LendMarketData,
    LendMarketState,
    LendListResponse,
    LendGetByAssetResponse,
    LendGetRateHistoryResponse,
)

Methods:

• client.markets.lend.list(**params) -> LendListResponse
• client.markets.lend.get_by_asset(**params) -> LendGetByAssetResponse
• client.markets.lend.get_rate_history(**params) -> LendGetRateHistoryResponse

Borrow

Types:

from neptune_api_v2.types.markets import (
    BorrowMarketOverview,
    BorrowGetOverviewResponse,
    BorrowGetRateHistoryResponse,
)

Methods:

• client.markets.borrow.get_overview(**params) -> BorrowGetOverviewResponse
• client.markets.borrow.get_rate_history(**params) -> BorrowGetRateHistoryResponse

Collaterals

Types:

from neptune_api_v2.types.markets.borrow import (
    BorrowCollateralConfig,
    BorrowCollateralMarket,
    BorrowCollateralMarketData,
    BorrowCollateralState,
    CollateralListResponse,
    CollateralGetByAssetResponse,
)

Methods:

• client.markets.borrow.collaterals.list(**params) -> CollateralListResponse
• client.markets.borrow.collaterals.get_by_asset(**params) -> CollateralGetByAssetResponse

Debts

Types:

from neptune_api_v2.types.markets.borrow import (
    BorrowDebtConfig,
    BorrowDebtMarket,
    BorrowDebtMarketData,
    BorrowDebtState,
    DebtListResponse,
    DebtGetByAssetResponse,
)

Methods:

• client.markets.borrow.debts.list(**params) -> DebtListResponse
• client.markets.borrow.debts.get_by_asset(**params) -> DebtGetByAssetResponse

Nept

Types:

from neptune_api_v2.types import (
    NeptParams,
    NeptState,
    NeptUnlockDistributionGroup,
    StakingPoolFull,
    StakingPoolParams,
    StakingPoolState,
    NeptGetParamsResponse,
    NeptGetStakingOverviewResponse,
    NeptGetStateResponse,
)

Methods:

• client.nept.get_params(**params) -> NeptGetParamsResponse
• client.nept.get_staking_overview(**params) -> NeptGetStakingOverviewResponse
• client.nept.get_state(**params) -> NeptGetStateResponse

User

Types:

from neptune_api_v2.types import EventAction, User, UserTx, UserGetUserResponse

Methods:

• client.user.get_tx_history(address, **params) -> SyncTxHistoryPage[UserTx]
• client.user.get_user(address, **params) -> UserGetUserResponse

Market

Types:

from neptune_api_v2.types.user import (
    UserMarket,
    UserMergedMarket,
    MarketGetMergedResponse,
    MarketGetMergedByAssetResponse,
    MarketGetPortfolioResponse,
)

Methods:

• client.user.market.get_merged(address, **params) -> MarketGetMergedResponse
• client.user.market.get_merged_by_asset(address, **params) -> MarketGetMergedByAssetResponse
• client.user.market.get_portfolio(address, **params) -> MarketGetPortfolioResponse

Lend

Types:

from neptune_api_v2.types.user.market import (
    UserLendAssetPool,
    UserLendMarket,
    UserLendOriginAmounts,
    UserLendReceiptAmounts,
    LendListResponse,
    LendGetByAssetResponse,
)

Methods:

• client.user.market.lend.list(address, **params) -> LendListResponse
• client.user.market.lend.get_by_asset(address, **params) -> LendGetByAssetResponse

Borrow

Types:

from neptune_api_v2.types.user.market import (
    UserBorrowMarket,
    UserBorrowMarketPools,
    BorrowGetCollateralAccountsByAssetResponse,
    BorrowGetCollateralTotalsResponse,
    BorrowGetDebtAccountsByAssetResponse,
    BorrowGetDebtsTotalsResponse,
    BorrowGetPortfolioResponse,
)

Methods:

• client.user.market.borrow.get_collateral_accounts_by_asset(address, **params) -> BorrowGetCollateralAccountsByAssetResponse
• client.user.market.borrow.get_collateral_totals(address, **params) -> BorrowGetCollateralTotalsResponse
• client.user.market.borrow.get_debt_accounts_by_asset(address, **params) -> BorrowGetDebtAccountsByAssetResponse
• client.user.market.borrow.get_debts_totals(address, **params) -> BorrowGetDebtsTotalsResponse
• client.user.market.borrow.get_portfolio(address, **params) -> BorrowGetPortfolioResponse

Subaccount

Types:

from neptune_api_v2.types.user.market.borrow import (
    UserAccountHealth,
    UserBorrowMarketAccount,
    UserCollateralAccountPool,
    UserCollateralAssetPool,
    UserDebtAccountPool,
    UserDebtAssetPool,
    SubaccountGetSubaccountResponse,
    SubaccountGetSubaccountCollateralsResponse,
    SubaccountGetSubaccountDebtsResponse,
    SubaccountGetSubaccountHealthResponse,
)

Methods:

• client.user.market.borrow.subaccount.get_subaccount(index, *, address, **params) -> SubaccountGetSubaccountResponse
• client.user.market.borrow.subaccount.get_subaccount_collaterals(index, *, address, **params) -> SubaccountGetSubaccountCollateralsResponse
• client.user.market.borrow.subaccount.get_subaccount_debts(index, *, address, **params) -> SubaccountGetSubaccountDebtsResponse
• client.user.market.borrow.subaccount.get_subaccount_health(index, *, address, **params) -> SubaccountGetSubaccountHealthResponse

Nept

Types:

from neptune_api_v2.types.user import (
    UserUnlockAmounts,
    UserUnlockOverview,
    UserUnlockSchedule,
    UserUnlockScheduleLinear,
    UserUnlockScheduleLumpSum,
    NeptGetUnlocksResponse,
)

Methods:

• client.user.nept.get_unlocks(address, **params) -> NeptGetUnlocksResponse

Staking

Types:

from neptune_api_v2.types.user.nept import (
    UserStake,
    UserStakeBondingEntry,
    UserStakePool,
    UserStakeUnbonding,
    UserStakeUnbondingEntry,
    StakingGetOverviewResponse,
    StakingGetStakingPoolResponse,
    StakingGetStakingPoolsResponse,
    StakingGetUnstakingResponse,
)

Methods:

• client.user.nept.staking.get_overview(address, **params) -> StakingGetOverviewResponse
• client.user.nept.staking.get_staking_pool(address, **params) -> StakingGetStakingPoolResponse
• client.user.nept.staking.get_staking_pools(address, **params) -> StakingGetStakingPoolsResponse
• client.user.nept.staking.get_unstaking(address, **params) -> StakingGetUnstakingResponse

Wallet

Types:

from neptune_api_v2.types.user import (
    UserWalletPortfolio,
    WalletAsset,
    WalletAssetKnown,
    WalletAssetUnknown,
    WalletBalance,
    WalletGetBalanceByAssetResponse,
    WalletGetBalancesResponse,
)

Methods:

• client.user.wallet.get_balance_by_asset(address, **params) -> WalletGetBalanceByAssetResponse
• client.user.wallet.get_balances(address, **params) -> WalletGetBalancesResponse

Analytics

Market

Types:

from neptune_api_v2.types.analytics import MarketGetCurrentStateResponse

Methods:

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

History

Types:

from neptune_api_v2.types.analytics.market import (
    HistoryGetLoansOriginatedResponse,
    HistoryGetLoansOriginatedByAssetResponse,
)

Methods:

• client.analytics.market.history.get_loans_originated(**params) -> SyncIntervalSinglePage[HistoryGetLoansOriginatedResponse]
• client.analytics.market.history.get_loans_originated_by_asset(**params) -> HistoryGetLoansOriginatedByAssetResponse

Nept

Types:

from neptune_api_v2.types.analytics import NeptUnlocksDistributionResponse

Methods:

• client.analytics.nept.unlocks_distribution(**params) -> NeptUnlocksDistributionResponse

Swap

Routes

Types:

from neptune_api_v2.types.swap import (
    SwapRouteTargetSet,
    RouteListAllResponse,
    RouteListByDenomResponse,
)

Methods:

• client.swap.routes.list_all(**params) -> RouteListAllResponse
• client.swap.routes.list_by_denom(**params) -> RouteListByDenomResponse