--- title: "Get borrowing market overview" method: GET path: "/api/v1/markets/borrow" tags: ["Market"] --- # Get borrowing market overview `GET /api/v1/markets/borrow` ## Query parameters - `with_text` boolean — Include text variation fields - `with_value` boolean — Calculate and include USD values for amounts, where applicable ## Response `200` - object - `data` BorrowMarketOverview — `BorrowMarketOverview` - `collaterals` BorrowCollateralMarket[], required — Borrowing collateral markets - `asset_info` AssetInfo, required — `AssetInfo` - `asset` AssetSpec, required — `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` string, required - `group` 'native' | 'token', required - `group_key` string, required - `metadata` AssetMetadata, required — `AssetMetadata` - `name` string, required — Full name of the asset - `symbol` string, required — Symbol of the asset, e.g.: `NEPT` `INJ` - `symbol_denom` string, required — Denom symbol for the asset (e.g. `inj` for `INJ`, `sat` for `BTC`) - `decimals_denom` integer, required — Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. `18` for `INJ`) - `decimals_display` integer, required — Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations) - `classification` union, required — `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. - object - `neptune_receipt_asset` AssetSpec — `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) - … - `kind` 'regular', required - object - `origin_asset` AssetSpec, required — `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) - … - `kind` 'neptune_receipt_token', required - object - `origin_asset` AssetSpec — `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) - … - `kind` 'liquid_staking_token', required - `config` BorrowCollateralConfig, required — `BorrowCollateralConfig` - `enabled` boolean, required — Collateral enabled state - `collateral_cap` string, nullable — The optional, global/shared maximum deposit limit for this collateral. - `allowable_ltv` string, required — The loan to value ratio at which we allow collateral withdrawals or borrows. - `liquidation_ltv` string, required — The loan to value ratio at which the collateral can be liquidated. - `min_discount` string, required — The minimum dynamic discount. - `max_discount` string, required — The maximum dynamic discount - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `min_discount` string, required - `collateral_cap` string, required - `max_discount` string, required - `liquidation_ltv` string, required - `allowable_ltv` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `collateral_cap` string, required - `extra` object, required - … - `state` BorrowCollateralState, required — `BorrowCollateralState` - `collateral_sum` string, required — Total amount of this asset which is actively collateralized - `balance` string, required - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `collateral_sum` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `collateral_sum` string, required - `extra` object, required - … - `debts` BorrowDebtMarket[], required — Borrowing debt markets - `asset_info` AssetInfo, required — `AssetInfo` - `asset` AssetSpec, required — `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` string, required - `group` 'native' | 'token', required - `group_key` string, required - `metadata` AssetMetadata, required — `AssetMetadata` - `name` string, required — Full name of the asset - `symbol` string, required — Symbol of the asset, e.g.: `NEPT` `INJ` - `symbol_denom` string, required — Denom symbol for the asset (e.g. `inj` for `INJ`, `sat` for `BTC`) - `decimals_denom` integer, required — Denom exponent, or num. of decimal places that shift between denom/standard amounts (e.g. `18` for `INJ`) - `decimals_display` integer, required — Number of decimals used when displaying amounts of this asset (this is subjective and used for generating text representations) - `classification` union, required — `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. - object - `neptune_receipt_asset` AssetSpec — `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) - … - `kind` 'regular', required - object - `origin_asset` AssetSpec, required — `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) - … - `kind` 'neptune_receipt_token', required - object - `origin_asset` AssetSpec — `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) - … - `kind` 'liquid_staking_token', required - `rate` MarketRate — `MarketRate` - `apr` string, required — Market rate in APR standard as a decimal percentage - `apy` string, required — Market rate in APY standard as a decimal percentage - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `apr` string, required - `apy` string, required - `config` BorrowDebtConfig, required — `BorrowDebtConfig` - `enabled` boolean, required — Market enabled state - `borrow_cap` string, nullable — The global max amount which can be borrowed - `interest_fee` string, required — The protocol (base) interest rate that is charged to borrowers. - `borrow_halt_utilization` string, required — The maximum utilization ratio at which new borrow positions can be opened. - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `borrow_cap` string, required - `borrow_halt_utilization` string, required - `interest_fee` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `borrow_cap` string, required - `extra` object, required - … - `state` BorrowDebtState, required — `BorrowDebtState` - `principal_sum` string, required — Sum of initial amount borrowed for all open debts (those which have not yet been repaid) - `interest_sum` string, required — Sum of accrued interest for all open debts (those which have not yet been repaid) - `debt_sum` string, required — Sum open debt amount (this is simply the principal sum + interest sum) - `utilization_accumulator` string, required — Asset utilization tracker. - `time_last_distributed_interest` string, date-time, required — Timestamp used to keep track of the last time interest was distributed. - `extra` object, required - `text` object, nullable — Human-readable field variants. Must provide `?with-text=true` - `principal_sum` string, required - `interest_sum` string, required - `debt_sum` string, required - `time_last_distributed_interest` string, required - `value` object, nullable — USD values for the corresponding amounts above. Must provide `?with-value=true` - `principal_sum` string, required - `interest_sum` string, required - `debt_sum` string, required - `extra` object, required - … - `error` ErrorData - `scope` 'user' | 'client' | 'server', required - `kind` 'invalid_request' | 'validation' | 'entity_not_found' | 'contract' | 'internal', required - `message` string, required — Error message - `fields` FieldValidationError[], nullable — List of names and error messages for invalid fields. Always set when `error.kind == 'validation'`. Always NULL/unset for all other cases. - `field` string, required - `message` string, required - `status` integer, required — Request status - `status_text` string, required — Request status text --- [API](https://skmtc.dev/cryptechdev/apis/neptune-api-v2.md) · [All operations](https://skmtc.dev/cryptechdev/apis/neptune-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cryptechdev/neptune-api-v2/revisions/4b5b35e288d8/schema)