Skip to content
Neptune API v2
Get started
API Reference
User
Market

Get user markets for all kinds (lend + borrow debt/collateral), grouped together by asset

user.market.get_merged(straddress, MarketGetMergedParams**kwargs) -> MarketGetMergedResponse
GET/api/v1/users/{address}/markets/merged

Get user markets for all kinds (lend + borrow debt/collateral), grouped together by asset

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 MarketGetMergedResponse: …
count: int

Total number of objects irrespective of any pagination parameters.

formatuint16
minimum0
maximum65535
data: List[UserMergedMarket]
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)

borrow_collateral: List[UserCollateralAccountPool]

User collateral contribution for asset in borrow market, listed by subaccount

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
index: int

Account index

formatuint8
minimum0
maximum255
principal: str

Amount of this asset which is actively collateralized

shares: str
borrow_debt: List[UserDebtAccountPool]

User debt contribution for asset in borrow market, listed by subaccount

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
index: int

Account index

formatuint8
minimum0
maximum255
principal: str

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

shares: str
lend: Optional[Lend]

User contribution for asset's lending market, if one exists

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

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 markets for all kinds (lend + borrow debt/collateral), grouped together by asset

from neptune_api_v2 import NeptuneAPIV2

client = NeptuneAPIV2()
response = client.user.market.get_merged(
    address="injvalcons1a03k0ztfyjnd70apawva003pkh0adqmau0a9q0",
)
print(response.count)
{
  "data": [
    {
      "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"
          }
        }
      },
      "lend": {
        "receipt_amounts": {
          "held": "83554004830102299663",
          "collateralized": "752960360256328550651",
          "total": "836514365086430850314",
          "extra": {
            "text": {
              "total": "836.5143 nINJ",
              "collateralized": "752.9603 nINJ",
              "held": "83.5540 nINJ"
            },
            "value": {
              "total": "2697.285693377552815399",
              "held": "269.414407281993492198",
              "collateralized": "2427.8712860955593232",
              "price": "3.224434398205298254",
              "extra": {
                "text": {
                  "held": "$269.41",
                  "collateralized": "$2,427.87",
                  "price": "$3.22",
                  "total": "$2,697.28"
                }
              }
            }
          }
        },
        "origin_equivalent": {
          "held": "89613505715548101937",
          "collateralized": "807566527596317523958",
          "total": "897180033311865625895",
          "extra": {
            "text": {
              "collateralized": "807.5665 INJ",
              "total": "897.1800 INJ",
              "held": "89.6135 INJ"
            }
          }
        }
      },
      "borrow_collateral": [
        {
          "index": 0,
          "principal": "782952579489904269695",
          "shares": "563190221360717641092",
          "extra": {
            "text": {
              "principal": "782.9525 INJ",
              "shares": "563.1902 INJ"
            },
            "value": {
              "shares": "1688.641400216907739168",
              "price": "2.99835",
              "principal": "2347.56586671355446704",
              "extra": {
                "text": {
                  "price": "$2.99",
                  "shares": "$1,688.64",
                  "principal": "$2,347.56"
                }
              }
            }
          }
        }
      ],
      "borrow_debt": [
        {
          "index": 0,
          "principal": "363137513144439643883",
          "shares": "363137513144439643883",
          "extra": {
            "text": {
              "principal": "363.1375 INJ",
              "shares": "363.1375 INJ"
            },
            "value": {
              "shares": "1088.813362536630606236",
              "price": "2.99835",
              "principal": "1088.813362536630606236",
              "extra": {
                "text": {
                  "shares": "$1,088.81",
                  "price": "$2.99",
                  "principal": "$1,088.81"
                }
              }
            }
          }
        }
      ]
    }
  ],
  "count": 1,
  "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
{
  "data": [
    {
      "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"
          }
        }
      },
      "lend": {
        "receipt_amounts": {
          "held": "83554004830102299663",
          "collateralized": "752960360256328550651",
          "total": "836514365086430850314",
          "extra": {
            "text": {
              "total": "836.5143 nINJ",
              "collateralized": "752.9603 nINJ",
              "held": "83.5540 nINJ"
            },
            "value": {
              "total": "2697.285693377552815399",
              "held": "269.414407281993492198",
              "collateralized": "2427.8712860955593232",
              "price": "3.224434398205298254",
              "extra": {
                "text": {
                  "held": "$269.41",
                  "collateralized": "$2,427.87",
                  "price": "$3.22",
                  "total": "$2,697.28"
                }
              }
            }
          }
        },
        "origin_equivalent": {
          "held": "89613505715548101937",
          "collateralized": "807566527596317523958",
          "total": "897180033311865625895",
          "extra": {
            "text": {
              "collateralized": "807.5665 INJ",
              "total": "897.1800 INJ",
              "held": "89.6135 INJ"
            }
          }
        }
      },
      "borrow_collateral": [
        {
          "index": 0,
          "principal": "782952579489904269695",
          "shares": "563190221360717641092",
          "extra": {
            "text": {
              "principal": "782.9525 INJ",
              "shares": "563.1902 INJ"
            },
            "value": {
              "shares": "1688.641400216907739168",
              "price": "2.99835",
              "principal": "2347.56586671355446704",
              "extra": {
                "text": {
                  "price": "$2.99",
                  "shares": "$1,688.64",
                  "principal": "$2,347.56"
                }
              }
            }
          }
        }
      ],
      "borrow_debt": [
        {
          "index": 0,
          "principal": "363137513144439643883",
          "shares": "363137513144439643883",
          "extra": {
            "text": {
              "principal": "363.1375 INJ",
              "shares": "363.1375 INJ"
            },
            "value": {
              "shares": "1088.813362536630606236",
              "price": "2.99835",
              "principal": "1088.813362536630606236",
              "extra": {
                "text": {
                  "shares": "$1,088.81",
                  "price": "$2.99",
                  "principal": "$1,088.81"
                }
              }
            }
          }
        }
      ]
    }
  ],
  "count": 1,
  "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"
}