Skip to content
Neptune API v2
Get started
API Reference
Markets
Borrow

Get borrowing market overview

markets.borrow.get_overview(BorrowGetOverviewParams**kwargs) -> BorrowGetOverviewResponse
GET/api/v1/markets/borrow

Get borrowing market overview

ParametersExpand Collapse
with_text: Optional[bool]

Include text variation fields

with_value: Optional[bool]

Calculate and include USD values for amounts, where applicable

ReturnsExpand Collapse
class BorrowGetOverviewResponse: …
collaterals: List[BorrowCollateralMarket]

Borrowing collateral markets

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)

config: BorrowCollateralConfig

Collateral configuration parameters

allowable_ltv: str

The loan to value ratio at which we allow collateral withdrawals or borrows.

collateral_cap: Optional[str]

The optional, global/shared maximum deposit limit for this collateral.

enabled: bool

Collateral enabled state

extra: Extra
text: Optional[ExtraText]

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

allowable_ltv: str
collateral_cap: str
liquidation_ltv: str
max_discount: str
min_discount: 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.

collateral_cap: Optional[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.

collateral_cap: Optional[str]
price: Optional[str]

Text representation of price

price: str

Price used in value calculations

liquidation_ltv: str

The loan to value ratio at which the collateral can be liquidated.

max_discount: str

The maximum dynamic discount

min_discount: str

The minimum dynamic discount.

state: BorrowCollateralState

Current collateral state

balance: str
collateral_sum: str

Total amount of this asset which is actively collateralized

extra: Extra
text: Optional[ExtraText]

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

collateral_sum: 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.

collateral_sum: 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.

collateral_sum: str
price: str

Text representation of price

price: str

Price used in value calculations

debts: List[BorrowDebtMarket]

Borrowing debt markets

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)

config: BorrowDebtConfig

Debt market configuration parameters

borrow_cap: Optional[str]

The global max amount which can be borrowed

borrow_halt_utilization: str

The maximum utilization ratio at which new borrow positions can be opened.

enabled: bool

Market enabled state

extra: Extra
text: Optional[ExtraText]

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

borrow_cap: str
borrow_halt_utilization: str
interest_fee: 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.

borrow_cap: Optional[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.

borrow_cap: Optional[str]
price: Optional[str]

Text representation of price

price: str

Price used in value calculations

interest_fee: str

The protocol (base) interest rate that is charged to borrowers.

rate: MarketRate

Market rates

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
state: BorrowDebtState

Current debt market state

balance_sum: str
extra: Extra
text: Optional[ExtraText]

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

balance_sum: str
principal_sum: str
time_last_distributed_interest: 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.

balance_sum: 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.

balance_sum: str
price: str

Text representation of price

principal_sum: str
price: str

Price used in value calculations

principal_sum: str
principal_sum: str
time_last_distributed_interest: datetime

Timestamp used to keep track of the last time interest was distributed.

formatdate-time
utilization_accumulator: str

Asset utilization tracker.

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 borrowing market overview

from neptune_api_v2 import NeptuneAPIV2

client = NeptuneAPIV2()
response = client.markets.borrow.get_overview()
print(response.data)
{
  "data": {
    "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"
            }
          }
        },
        "config": {
          "enabled": true,
          "collateral_cap": null,
          "allowable_ltv": "0.1",
          "liquidation_ltv": "0.7",
          "min_discount": "0.14",
          "max_discount": "0.16",
          "extra": {
            "text": {
              "min_discount": "14.00%",
              "allowable_ltv": "10.00%",
              "collateral_cap": "",
              "liquidation_ltv": "70.00%",
              "max_discount": "16.00%"
            },
            "value": {
              "collateral_cap": null,
              "price": "2.99835",
              "extra": {
                "text": {
                  "collateral_cap": null,
                  "price": "$2.99"
                }
              }
            }
          }
        },
        "state": {
          "collateral_sum": "1434197454977",
          "balance": "992132705578",
          "extra": {
            "text": {
              "collateral_sum": "0.0000 INJ"
            },
            "value": {
              "collateral_sum": "0.00000430022593913",
              "price": "2.99835",
              "extra": {
                "text": {
                  "collateral_sum": "$0.00",
                  "price": "$2.99"
                }
              }
            }
          }
        }
      }
    ],
    "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"
            }
          }
        },
        "rate": {
          "apr": "0.28494725",
          "apy": "0.32969189",
          "extra": {
            "text": {
              "apy": "32.96%",
              "apr": "28.49%"
            }
          }
        },
        "config": {
          "enabled": true,
          "borrow_cap": null,
          "interest_fee": "0.01",
          "borrow_halt_utilization": "0.9",
          "extra": {
            "text": {
              "borrow_halt_utilization": "90.00%",
              "borrow_cap": "",
              "interest_fee": "1.00%"
            },
            "value": {
              "price": "2.99835",
              "borrow_cap": null,
              "extra": {
                "text": {
                  "price": "$2.99",
                  "borrow_cap": null
                }
              }
            }
          }
        },
        "state": {
          "principal_sum": "1667143666263",
          "balance_sum": "11659168021630",
          "utilization_accumulator": "76241.882286236684092386",
          "time_last_distributed_interest": "2026-04-09T22:40:09.138417816Z",
          "extra": {
            "text": {
              "time_last_distributed_interest": "2026-04-09 10:40:09 PM +00:00",
              "principal_sum": "0.0000 INJ",
              "balance_sum": "0.0000 INJ"
            },
            "value": {
              "principal_sum": "0.000004998680211739",
              "balance_sum": "0.000034958266437654",
              "price": "2.99835",
              "extra": {
                "text": {
                  "price": "$2.99",
                  "principal_sum": "$0.00",
                  "balance_sum": "$0.00"
                }
              }
            }
          }
        }
      }
    ]
  },
  "error": null,
  "status": 200,
  "status_text": "200 OK"
}
{
  "data": null,
  "error": {
    "kind": "internal",
    "scope": "server",
    "message": "An unexpected error occurred"
  },
  "status": 500,
  "status_text": "500 Internal Server Error"
}
Returns Examples
{
  "data": {
    "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"
            }
          }
        },
        "config": {
          "enabled": true,
          "collateral_cap": null,
          "allowable_ltv": "0.1",
          "liquidation_ltv": "0.7",
          "min_discount": "0.14",
          "max_discount": "0.16",
          "extra": {
            "text": {
              "min_discount": "14.00%",
              "allowable_ltv": "10.00%",
              "collateral_cap": "",
              "liquidation_ltv": "70.00%",
              "max_discount": "16.00%"
            },
            "value": {
              "collateral_cap": null,
              "price": "2.99835",
              "extra": {
                "text": {
                  "collateral_cap": null,
                  "price": "$2.99"
                }
              }
            }
          }
        },
        "state": {
          "collateral_sum": "1434197454977",
          "balance": "992132705578",
          "extra": {
            "text": {
              "collateral_sum": "0.0000 INJ"
            },
            "value": {
              "collateral_sum": "0.00000430022593913",
              "price": "2.99835",
              "extra": {
                "text": {
                  "collateral_sum": "$0.00",
                  "price": "$2.99"
                }
              }
            }
          }
        }
      }
    ],
    "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"
            }
          }
        },
        "rate": {
          "apr": "0.28494725",
          "apy": "0.32969189",
          "extra": {
            "text": {
              "apy": "32.96%",
              "apr": "28.49%"
            }
          }
        },
        "config": {
          "enabled": true,
          "borrow_cap": null,
          "interest_fee": "0.01",
          "borrow_halt_utilization": "0.9",
          "extra": {
            "text": {
              "borrow_halt_utilization": "90.00%",
              "borrow_cap": "",
              "interest_fee": "1.00%"
            },
            "value": {
              "price": "2.99835",
              "borrow_cap": null,
              "extra": {
                "text": {
                  "price": "$2.99",
                  "borrow_cap": null
                }
              }
            }
          }
        },
        "state": {
          "principal_sum": "1667143666263",
          "balance_sum": "11659168021630",
          "utilization_accumulator": "76241.882286236684092386",
          "time_last_distributed_interest": "2026-04-09T22:40:09.138417816Z",
          "extra": {
            "text": {
              "time_last_distributed_interest": "2026-04-09 10:40:09 PM +00:00",
              "principal_sum": "0.0000 INJ",
              "balance_sum": "0.0000 INJ"
            },
            "value": {
              "principal_sum": "0.000004998680211739",
              "balance_sum": "0.000034958266437654",
              "price": "2.99835",
              "extra": {
                "text": {
                  "price": "$2.99",
                  "principal_sum": "$0.00",
                  "balance_sum": "$0.00"
                }
              }
            }
          }
        }
      }
    ]
  },
  "error": null,
  "status": 200,
  "status_text": "200 OK"
}
{
  "data": null,
  "error": {
    "kind": "internal",
    "scope": "server",
    "message": "An unexpected error occurred"
  },
  "status": 500,
  "status_text": "500 Internal Server Error"
}