API Reference

User

Market

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get user market portfolio

user.market.get_portfolio(straddress, MarketGetPortfolioParams**kwargs) -> MarketGetPortfolioResponse

GET/api/v1/users/{address}/markets

Get user market portfolio

ParametersExpand Collapse

address: str

The user account address

with_text: Optional[bool]

Include text variation fields

with_value: Optional[bool]

Calculate and include USD values for amounts, where applicable

ReturnsExpand Collapse

class MarketGetPortfolioResponse: …

data: UserMarket

borrow: UserBorrowMarket

Overview of user borrowing portfolio

accounts: List[UserBorrowMarketAccount]

Market sub-accounts for the user

collaterals: List[UserCollateralAssetPool]

Account collateral allocations

asset_info: AssetInfo

Asset identifiers with associated metadata

asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

class Regular: …

kind: Literal["regular"]

neptune_receipt_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class NeptuneReceiptToken: …

kind: Literal["neptune_receipt_token"]

origin_asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class LiquidStakingToken: …

kind: Literal["liquid_staking_token"]

origin_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

metadata: AssetMetadata

Additional metadata for assets

decimals_denom: int

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: int

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

name: str

Full name of the asset

symbol: str

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: str

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

principal: str

shares: str

value: Optional[ExtraValue]

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

extra: ExtraValueExtra

text: Optional[ExtraValueExtraText]

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: str

Text representation of price

principal: str

shares: str

price: str

Price used in value calculations

principal: str

shares: str

principal: str

Amount of this asset which is actively collateralized

shares: str

debts: List[UserDebtAssetPool]

Account debt allocations

asset_info: AssetInfo

Asset identifiers with associated metadata

asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

class Regular: …

kind: Literal["regular"]

neptune_receipt_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class NeptuneReceiptToken: …

kind: Literal["neptune_receipt_token"]

origin_asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class LiquidStakingToken: …

kind: Literal["liquid_staking_token"]

origin_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

metadata: AssetMetadata

Additional metadata for assets

decimals_denom: int

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: int

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

name: str

Full name of the asset

symbol: str

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: str

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

principal: str

shares: str

value: Optional[ExtraValue]

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

extra: ExtraValueExtra

text: Optional[ExtraValueExtraText]

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: str

Text representation of price

principal: str

shares: str

price: str

Price used in value calculations

principal: str

shares: str

market_rate: MarketRate

Current market borrowing rate

apr: str

Market rate in APR standard as a decimal percentage

apy: str

Market rate in APY standard as a decimal percentage

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

apr: str

apy: str

principal: str

Initial amount borrowed (of debts which have not yet been repaid)

shares: str

debts_net_rate: MarketRate

Account debt net rate

apr: str

Market rate in APR standard as a decimal percentage

apy: str

Market rate in APY standard as a decimal percentage

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

apr: str

apy: str

health: Optional[UserAccountHealth]

Health data for this account

base: str

Account health value, before any added health boosts

boost: str

Account health boost to be applied

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

base: str

boost: str

result: str

result: str

Account health, with boost

index: int

Account index

formatuint8

minimum0

maximum255

totals: UserBorrowMarketPools

Collateral/debt totals of all sub-accounts by asset

collaterals: List[UserCollateralAssetPool]

Account collateral allocations

asset_info: AssetInfo

Asset identifiers with associated metadata

asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

class Regular: …

kind: Literal["regular"]

neptune_receipt_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class NeptuneReceiptToken: …

kind: Literal["neptune_receipt_token"]

origin_asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class LiquidStakingToken: …

kind: Literal["liquid_staking_token"]

origin_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

metadata: AssetMetadata

Additional metadata for assets

decimals_denom: int

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: int

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

name: str

Full name of the asset

symbol: str

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: str

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

principal: str

shares: str

value: Optional[ExtraValue]

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

extra: ExtraValueExtra

text: Optional[ExtraValueExtraText]

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: str

Text representation of price

principal: str

shares: str

price: str

Price used in value calculations

principal: str

shares: str

principal: str

Amount of this asset which is actively collateralized

shares: str

debts: List[UserDebtAssetPool]

Account debt allocations

asset_info: AssetInfo

Asset identifiers with associated metadata

asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

class Regular: …

kind: Literal["regular"]

neptune_receipt_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class NeptuneReceiptToken: …

kind: Literal["neptune_receipt_token"]

origin_asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class LiquidStakingToken: …

kind: Literal["liquid_staking_token"]

origin_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

metadata: AssetMetadata

Additional metadata for assets

decimals_denom: int

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: int

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

name: str

Full name of the asset

symbol: str

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: str

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

principal: str

shares: str

value: Optional[ExtraValue]

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

extra: ExtraValueExtra

text: Optional[ExtraValueExtraText]

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

price: str

Text representation of price

principal: str

shares: str

price: str

Price used in value calculations

principal: str

shares: str

market_rate: MarketRate

Current market borrowing rate

apr: str

Market rate in APR standard as a decimal percentage

apy: str

Market rate in APY standard as a decimal percentage

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

apr: str

apy: str

principal: str

Initial amount borrowed (of debts which have not yet been repaid)

shares: str

debts_net_rate: MarketRate

Account debt net rate

apr: str

Market rate in APR standard as a decimal percentage

apy: str

Market rate in APY standard as a decimal percentage

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

apr: str

apy: str

lend: UserLendMarket

Overview of user lending portfolio

asset_pools: List[UserLendAssetPool]

User lending allocations

asset_info: AssetInfo

Asset identifiers with associated metadata

asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

classification: AssetClassification

The asset's classification metadata. Assets are classfied to provide context on their usage throughout the Neptune API (e.g. regular assets, neptune receipt tokens, LSTs, etc.)

Each asset belongs to only a single classification type. This object contains metadata pertaining to the given classification.

While some fields may be common among the distinct classifcations, each classification is distinct and subject to independent change.

One of the following:

class Regular: …

kind: Literal["regular"]

neptune_receipt_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class NeptuneReceiptToken: …

kind: Literal["neptune_receipt_token"]

origin_asset: AssetSpec

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

class LiquidStakingToken: …

kind: Literal["liquid_staking_token"]

origin_asset: Optional[AssetSpec]

Provides a unique identifier for an asset for use throughout the Neptune API. IDs are unique across asset domains (contract tokens, native denoms, etc)

id: str

group: Literal["native", "token"]

One of the following:

"native"

"token"

group_key: str

metadata: AssetMetadata

Additional metadata for assets

decimals_denom: int

Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. 18 for INJ)

formatuint32

minimum0

decimals_display: int

Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations)

formatuint32

minimum0

name: str

Full name of the asset

symbol: str

Symbol of the asset, e.g.: NEPT INJ

symbol_denom: str

Denom symbol for the asset (e.g. inj for INJ, sat for BTC)

market_rate: MarketRate

Current market lending rate

apr: str

Market rate in APR standard as a decimal percentage

apy: str

Market rate in APY standard as a decimal percentage

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

apr: str

apy: str

origin_equivalent: UserLendOriginAmounts

The lending amounts converted into the equivalent for the receipt token's origin/source asset

collateralized: str

Total equivalent amount of origin token collateralized across this user's borrowing portfolio

NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.

Or, more formally: origin_equivalent_collateralized = receipt_collateralized / receipt_redemption_ratio

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: str

held: str

total: str

held: str

Total equivalent amount of origin token held in address balance

NOTE: This is not the amount of the origin asset that the user holds, but the amount held in the receipt token rendered as the equivalent amount in the origin asset.

Or, more formally: origin_equivalent_held = receipt_held / receipt_redemption_ratio

total: str

Total of held and collateralized equivalent for origin asset

Or, more formally: origin_equivalent_total = receipt_lent_total / receipt_redemption_ratio

receipt_amounts: UserLendReceiptAmounts

The lending amounts in the original receipt token amounts

collateralized: str

Total amount of receipt token collateralized across this user's borrowing portfolio

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

collateralized: str

held: str

total: str

value: Optional[ExtraValue]

USD values for the corresponding amounts above. Will not be null when query param with_value is true.

Note

This variant group contains an additional price field (set to the number used in value calculation).

The embedded text group will contain the text variant if with_text was specified as well.

collateralized: str

extra: ExtraValueExtra

text: Optional[ExtraValueExtraText]

Human-readable variants of USD values. Will not be null when query params with_text and with_value are true.

collateralized: str

held: str

price: str

Text representation of price

total: str

held: str

price: str

Price used in value calculations

total: str

held: str

Total amount of receipt token held in address balance

total: str

Sum of receipt amount held and receipt amount collateralized

net_rate: MarketRate

Account debt net rate

apr: str

Market rate in APR standard as a decimal percentage

apy: str

Market rate in APY standard as a decimal percentage

extra: Extra

text: Optional[ExtraText]

Human-readable field variants. Will not be null when query param with_text is true.

apr: str

apy: str

error: None

Error data. Guaranteed null for successful response.

status: int

HTTP status. Successful responses are guaranteed to be < 400. Conversely, error responses are guaranteed to be >= 400.

formatuint16

minimum0

maximum65535

status_text: str

HTTP status text

Get user market portfolio

Python

HTTP

TypeScript

Python

from neptune_api_v2 import NeptuneAPIV2

client = NeptuneAPIV2()
response = client.user.market.get_portfolio(
    address="injvalcons1a03k0ztfyjnd70apawva003pkh0adqmau0a9q0",
)
print(response.data)

200 example

500 example

{
  "data": {
    "borrow": {
      "accounts": [
        {
          "index": 0,
          "collaterals": [
            {
              "asset_info": {
                "asset": {
                  "id": "native;inj",
                  "group": "native",
                  "group_key": "inj"
                },
                "metadata": {
                  "name": "Injective",
                  "symbol": "INJ",
                  "symbol_denom": "inj",
                  "decimals_denom": 18,
                  "decimals_display": 4
                },
                "classification": {
                  "kind": "regular",
                  "neptune_receipt_asset": {
                    "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                    "group": "token",
                    "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                  }
                }
              },
              "principal": "955094137983627705654",
              "shares": "611291918790647923636",
              "extra": {
                "text": {
                  "principal": "955.0941 INJ",
                  "shares": "611.2919 INJ"
                },
                "value": {
                  "shares": "1832.867124705939201834",
                  "price": "2.99835",
                  "principal": "2863.706508623210131247",
                  "extra": {
                    "text": {
                      "price": "$2.99",
                      "shares": "$1,832.86",
                      "principal": "$2,863.70"
                    }
                  }
                }
              }
            }
          ],
          "debts": [
            {
              "asset_info": {
                "asset": {
                  "id": "native;inj",
                  "group": "native",
                  "group_key": "inj"
                },
                "metadata": {
                  "name": "Injective",
                  "symbol": "INJ",
                  "symbol_denom": "inj",
                  "decimals_denom": 18,
                  "decimals_display": 4
                },
                "classification": {
                  "kind": "regular",
                  "neptune_receipt_asset": {
                    "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                    "group": "token",
                    "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                  }
                }
              },
              "market_rate": {
                "apr": "0.24689622",
                "apy": "0.28004626",
                "extra": {
                  "text": {
                    "apy": "28.00%",
                    "apr": "24.68%"
                  }
                }
              },
              "principal": "972918889269350848394",
              "shares": "972918889269350848394",
              "extra": {
                "text": {
                  "principal": "972.9188 INJ",
                  "shares": "972.9188 INJ"
                },
                "value": {
                  "shares": "2917.151351640758116282",
                  "price": "2.99835",
                  "principal": "2917.151351640758116282",
                  "extra": {
                    "text": {
                      "shares": "$2,917.15",
                      "price": "$2.99",
                      "principal": "$2,917.15"
                    }
                  }
                }
              }
            }
          ],
          "debts_net_rate": {
            "apr": "0.246896219999999999",
            "apy": "0.280046259999999999",
            "extra": {
              "text": {
                "apy": "28.00%",
                "apr": "24.68%"
              }
            }
          },
          "health": {
            "base": "0.07",
            "boost": "1",
            "result": "0.07",
            "extra": {
              "text": {
                "boost": "0.00%",
                "result": "0.07",
                "base": "0.07"
              }
            }
          }
        }
      ],
      "totals": {
        "collaterals": [
          {
            "asset_info": {
              "asset": {
                "id": "native;inj",
                "group": "native",
                "group_key": "inj"
              },
              "metadata": {
                "name": "Injective",
                "symbol": "INJ",
                "symbol_denom": "inj",
                "decimals_denom": 18,
                "decimals_display": 4
              },
              "classification": {
                "kind": "regular",
                "neptune_receipt_asset": {
                  "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                  "group": "token",
                  "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                }
              }
            },
            "principal": "955094137983627705654",
            "shares": "611291918790647923636",
            "extra": {
              "text": {
                "principal": "955.0941 INJ",
                "shares": "611.2919 INJ"
              },
              "value": {
                "shares": "1832.867124705939201834",
                "price": "2.99835",
                "principal": "2863.706508623210131247",
                "extra": {
                  "text": {
                    "price": "$2.99",
                    "shares": "$1,832.86",
                    "principal": "$2,863.70"
                  }
                }
              }
            }
          }
        ],
        "debts": [
          {
            "asset_info": {
              "asset": {
                "id": "native;inj",
                "group": "native",
                "group_key": "inj"
              },
              "metadata": {
                "name": "Injective",
                "symbol": "INJ",
                "symbol_denom": "inj",
                "decimals_denom": 18,
                "decimals_display": 4
              },
              "classification": {
                "kind": "regular",
                "neptune_receipt_asset": {
                  "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                  "group": "token",
                  "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                }
              }
            },
            "market_rate": {
              "apr": "0.24689622",
              "apy": "0.28004626",
              "extra": {
                "text": {
                  "apy": "28.00%",
                  "apr": "24.68%"
                }
              }
            },
            "principal": "972918889269350848394",
            "shares": "972918889269350848394",
            "extra": {
              "text": {
                "principal": "972.9188 INJ",
                "shares": "972.9188 INJ"
              },
              "value": {
                "shares": "2917.151351640758116282",
                "price": "2.99835",
                "principal": "2917.151351640758116282",
                "extra": {
                  "text": {
                    "shares": "$2,917.15",
                    "price": "$2.99",
                    "principal": "$2,917.15"
                  }
                }
              }
            }
          }
        ],
        "debts_net_rate": {
          "apr": "0.246896219999999999",
          "apy": "0.280046259999999999",
          "extra": {
            "text": {
              "apy": "28.00%",
              "apr": "24.68%"
            }
          }
        }
      }
    },
    "lend": {
      "asset_pools": [
        {
          "asset_info": {
            "asset": {
              "id": "native;inj",
              "group": "native",
              "group_key": "inj"
            },
            "metadata": {
              "name": "Injective",
              "symbol": "INJ",
              "symbol_denom": "inj",
              "decimals_denom": 18,
              "decimals_display": 4
            },
            "classification": {
              "kind": "regular",
              "neptune_receipt_asset": {
                "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                "group": "token",
                "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
              }
            }
          },
          "market_rate": {
            "apr": "0.29565415",
            "apy": "0.34400525",
            "extra": {
              "text": {
                "apy": "34.40%",
                "apr": "29.56%"
              }
            }
          },
          "receipt_amounts": {
            "held": "604029084855724050535",
            "collateralized": "457499954503410229167",
            "total": "1061529039359134279702",
            "extra": {
              "text": {
                "total": "1,061.5290 nINJ",
                "collateralized": "457.4999 nINJ",
                "held": "604.0290 nINJ"
              },
              "value": {
                "total": "3422.830749203418505322",
                "held": "1947.652158725263612227",
                "collateralized": "1475.178590478154893095",
                "price": "3.224434398205298254",
                "extra": {
                  "text": {
                    "held": "$1,947.65",
                    "collateralized": "$1,475.17",
                    "price": "$3.22",
                    "total": "$3,422.83"
                  }
                }
              }
            }
          },
          "origin_equivalent": {
            "held": "647834462969684123724",
            "collateralized": "490678751678265340890",
            "total": "1138513214647949464614",
            "extra": {
              "text": {
                "collateralized": "490.6787 INJ",
                "total": "1,138.5132 INJ",
                "held": "647.8344 INJ"
              }
            }
          }
        }
      ],
      "net_rate": {
        "apr": "0.295654149999999999",
        "apy": "0.344005249999999999",
        "extra": {
          "text": {
            "apy": "34.40%",
            "apr": "29.56%"
          }
        }
      }
    }
  },
  "error": null,
  "status": 200,
  "status_text": "OK"
}

{
  "data": null,
  "error": {
    "kind": "internal",
    "scope": "server",
    "message": "An unexpected error occurred"
  },
  "status": 500,
  "status_text": "Internal Server Error"
}

Returns Examples

200 example

500 example

{
  "data": {
    "borrow": {
      "accounts": [
        {
          "index": 0,
          "collaterals": [
            {
              "asset_info": {
                "asset": {
                  "id": "native;inj",
                  "group": "native",
                  "group_key": "inj"
                },
                "metadata": {
                  "name": "Injective",
                  "symbol": "INJ",
                  "symbol_denom": "inj",
                  "decimals_denom": 18,
                  "decimals_display": 4
                },
                "classification": {
                  "kind": "regular",
                  "neptune_receipt_asset": {
                    "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                    "group": "token",
                    "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                  }
                }
              },
              "principal": "955094137983627705654",
              "shares": "611291918790647923636",
              "extra": {
                "text": {
                  "principal": "955.0941 INJ",
                  "shares": "611.2919 INJ"
                },
                "value": {
                  "shares": "1832.867124705939201834",
                  "price": "2.99835",
                  "principal": "2863.706508623210131247",
                  "extra": {
                    "text": {
                      "price": "$2.99",
                      "shares": "$1,832.86",
                      "principal": "$2,863.70"
                    }
                  }
                }
              }
            }
          ],
          "debts": [
            {
              "asset_info": {
                "asset": {
                  "id": "native;inj",
                  "group": "native",
                  "group_key": "inj"
                },
                "metadata": {
                  "name": "Injective",
                  "symbol": "INJ",
                  "symbol_denom": "inj",
                  "decimals_denom": 18,
                  "decimals_display": 4
                },
                "classification": {
                  "kind": "regular",
                  "neptune_receipt_asset": {
                    "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                    "group": "token",
                    "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                  }
                }
              },
              "market_rate": {
                "apr": "0.24689622",
                "apy": "0.28004626",
                "extra": {
                  "text": {
                    "apy": "28.00%",
                    "apr": "24.68%"
                  }
                }
              },
              "principal": "972918889269350848394",
              "shares": "972918889269350848394",
              "extra": {
                "text": {
                  "principal": "972.9188 INJ",
                  "shares": "972.9188 INJ"
                },
                "value": {
                  "shares": "2917.151351640758116282",
                  "price": "2.99835",
                  "principal": "2917.151351640758116282",
                  "extra": {
                    "text": {
                      "shares": "$2,917.15",
                      "price": "$2.99",
                      "principal": "$2,917.15"
                    }
                  }
                }
              }
            }
          ],
          "debts_net_rate": {
            "apr": "0.246896219999999999",
            "apy": "0.280046259999999999",
            "extra": {
              "text": {
                "apy": "28.00%",
                "apr": "24.68%"
              }
            }
          },
          "health": {
            "base": "0.07",
            "boost": "1",
            "result": "0.07",
            "extra": {
              "text": {
                "boost": "0.00%",
                "result": "0.07",
                "base": "0.07"
              }
            }
          }
        }
      ],
      "totals": {
        "collaterals": [
          {
            "asset_info": {
              "asset": {
                "id": "native;inj",
                "group": "native",
                "group_key": "inj"
              },
              "metadata": {
                "name": "Injective",
                "symbol": "INJ",
                "symbol_denom": "inj",
                "decimals_denom": 18,
                "decimals_display": 4
              },
              "classification": {
                "kind": "regular",
                "neptune_receipt_asset": {
                  "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                  "group": "token",
                  "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                }
              }
            },
            "principal": "955094137983627705654",
            "shares": "611291918790647923636",
            "extra": {
              "text": {
                "principal": "955.0941 INJ",
                "shares": "611.2919 INJ"
              },
              "value": {
                "shares": "1832.867124705939201834",
                "price": "2.99835",
                "principal": "2863.706508623210131247",
                "extra": {
                  "text": {
                    "price": "$2.99",
                    "shares": "$1,832.86",
                    "principal": "$2,863.70"
                  }
                }
              }
            }
          }
        ],
        "debts": [
          {
            "asset_info": {
              "asset": {
                "id": "native;inj",
                "group": "native",
                "group_key": "inj"
              },
              "metadata": {
                "name": "Injective",
                "symbol": "INJ",
                "symbol_denom": "inj",
                "decimals_denom": 18,
                "decimals_display": 4
              },
              "classification": {
                "kind": "regular",
                "neptune_receipt_asset": {
                  "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                  "group": "token",
                  "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
                }
              }
            },
            "market_rate": {
              "apr": "0.24689622",
              "apy": "0.28004626",
              "extra": {
                "text": {
                  "apy": "28.00%",
                  "apr": "24.68%"
                }
              }
            },
            "principal": "972918889269350848394",
            "shares": "972918889269350848394",
            "extra": {
              "text": {
                "principal": "972.9188 INJ",
                "shares": "972.9188 INJ"
              },
              "value": {
                "shares": "2917.151351640758116282",
                "price": "2.99835",
                "principal": "2917.151351640758116282",
                "extra": {
                  "text": {
                    "shares": "$2,917.15",
                    "price": "$2.99",
                    "principal": "$2,917.15"
                  }
                }
              }
            }
          }
        ],
        "debts_net_rate": {
          "apr": "0.246896219999999999",
          "apy": "0.280046259999999999",
          "extra": {
            "text": {
              "apy": "28.00%",
              "apr": "24.68%"
            }
          }
        }
      }
    },
    "lend": {
      "asset_pools": [
        {
          "asset_info": {
            "asset": {
              "id": "native;inj",
              "group": "native",
              "group_key": "inj"
            },
            "metadata": {
              "name": "Injective",
              "symbol": "INJ",
              "symbol_denom": "inj",
              "decimals_denom": 18,
              "decimals_display": 4
            },
            "classification": {
              "kind": "regular",
              "neptune_receipt_asset": {
                "id": "token;inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f",
                "group": "token",
                "group_key": "inj1rmzufd7h09sqfrre5dtvu5d09ta7c0t4jzkr2f"
              }
            }
          },
          "market_rate": {
            "apr": "0.29565415",
            "apy": "0.34400525",
            "extra": {
              "text": {
                "apy": "34.40%",
                "apr": "29.56%"
              }
            }
          },
          "receipt_amounts": {
            "held": "604029084855724050535",
            "collateralized": "457499954503410229167",
            "total": "1061529039359134279702",
            "extra": {
              "text": {
                "total": "1,061.5290 nINJ",
                "collateralized": "457.4999 nINJ",
                "held": "604.0290 nINJ"
              },
              "value": {
                "total": "3422.830749203418505322",
                "held": "1947.652158725263612227",
                "collateralized": "1475.178590478154893095",
                "price": "3.224434398205298254",
                "extra": {
                  "text": {
                    "held": "$1,947.65",
                    "collateralized": "$1,475.17",
                    "price": "$3.22",
                    "total": "$3,422.83"
                  }
                }
              }
            }
          },
          "origin_equivalent": {
            "held": "647834462969684123724",
            "collateralized": "490678751678265340890",
            "total": "1138513214647949464614",
            "extra": {
              "text": {
                "collateralized": "490.6787 INJ",
                "total": "1,138.5132 INJ",
                "held": "647.8344 INJ"
              }
            }
          }
        }
      ],
      "net_rate": {
        "apr": "0.295654149999999999",
        "apy": "0.344005249999999999",
        "extra": {
          "text": {
            "apy": "34.40%",
            "apr": "29.56%"
          }
        }
      }
    }
  },
  "error": null,
  "status": 200,
  "status_text": "OK"
}

{
  "data": null,
  "error": {
    "kind": "internal",
    "scope": "server",
    "message": "An unexpected error occurred"
  },
  "status": 500,
  "status_text": "Internal Server Error"
}