API Reference

User

Market

Borrow

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get user combined collaterals for all subaccounts

GET/api/v1/users/{address}/markets/borrow/sum/collaterals

Get user combined collaterals for all subaccounts

Path ParametersExpand Collapse

address: string

The user account address

Query ParametersExpand Collapse

with_text: optional boolean

Include text variation fields

with_value: optional boolean

Calculate and include USD values for amounts, where applicable

ReturnsExpand Collapse

count: number

Total number of objects irrespective of any pagination parameters.

formatuint16

minimum0

maximum65535

data: array of UserCollateralAssetPool { asset_info, extra, principal, shares }

asset_info: AssetInfo { asset, classification, metadata }

Asset identifiers with associated metadata

asset: AssetSpec { id, group, group_key }

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: string

group: "native" or "token"

One of the following:

"native"

"token"

group_key: string

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:

Regular = object { kind, neptune_receipt_asset }

kind: "regular"

neptune_receipt_asset: AssetSpec { id, group, group_key }

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: string

group: "native" or "token"

One of the following:

"native"

"token"

group_key: string

NeptuneReceiptToken = object { kind, origin_asset }

kind: "neptune_receipt_token"

origin_asset: AssetSpec { id, group, group_key }

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: string

group: "native" or "token"

One of the following:

"native"

"token"

group_key: string

LiquidStakingToken = object { kind, origin_asset }

kind: "liquid_staking_token"

origin_asset: AssetSpec { id, group, group_key }

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: string

group: "native" or "token"

One of the following:

"native"

"token"

group_key: string

metadata: AssetMetadata { decimals_denom, decimals_display, name, 2 more }

Additional metadata for assets

decimals_denom: number

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

formatuint32

minimum0

decimals_display: number

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

formatuint32

minimum0

name: string

Full name of the asset

symbol: string

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

symbol_denom: string

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

extra: object { text, value }

text: object { principal, shares }

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

principal: string

shares: string

value: object { extra, price, principal, shares }

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: object { text }

text: object { price, principal, shares }

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

price: string

Text representation of price

principal: string

shares: string

price: string

Price used in value calculations

principal: string

shares: string

principal: string

Amount of this asset which is actively collateralized

shares: string

error: unknown

Error data. Guaranteed null for successful response.

status: number

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

formatuint16

minimum0

maximum65535

status_text: string

HTTP status text

Get user combined collaterals for all subaccounts

HTTP

HTTP

TypeScript

Python

curl https://api-v2.nept.finance/api/v1/users/$ADDRESS/markets/borrow/sum/collaterals

200 example

500 example

{
  "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"
          }
        }
      },
      "principal": "5587801444696141894",
      "shares": "972904128223326775173",
      "extra": {
        "text": {
          "principal": "5.5878 INJ",
          "shares": "972.9041 INJ"
        },
        "value": {
          "shares": "2917.107092858411836339",
          "price": "2.99835",
          "principal": "16.754184461704677047",
          "extra": {
            "text": {
              "price": "$2.99",
              "shares": "$2,917.10",
              "principal": "$16.75"
            }
          }
        }
      }
    }
  ],
  "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

200 example

500 example

{
  "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"
          }
        }
      },
      "principal": "5587801444696141894",
      "shares": "972904128223326775173",
      "extra": {
        "text": {
          "principal": "5.5878 INJ",
          "shares": "972.9041 INJ"
        },
        "value": {
          "shares": "2917.107092858411836339",
          "price": "2.99835",
          "principal": "16.754184461704677047",
          "extra": {
            "text": {
              "price": "$2.99",
              "shares": "$2,917.10",
              "principal": "$16.75"
            }
          }
        }
      }
    }
  ],
  "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"
}