Get a market

Get a single market by ID

curl --request GET \
  --url https://borrow.yield.xyz/v1/markets/{marketId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://borrow.yield.xyz/v1/markets/{marketId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://borrow.yield.xyz/v1/markets/{marketId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://borrow.yield.xyz/v1/markets/{marketId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://borrow.yield.xyz/v1/markets/{marketId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "aave-v3-ethereum-usdc",
  "integrationId": "aave-borrow",
  "network": "ethereum",
  "type": "pool",
  "poolAddress": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
  "loanToken": {
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "logoURI": "<string>"
  },
  "collateralTokens": [
    {
      "token": {
        "symbol": "USDC",
        "name": "USD Coin",
        "decimals": 6,
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "logoURI": "<string>"
      },
      "priceUsd": "2800.00",
      "maxLtv": "0.80",
      "liquidationThreshold": "0.825",
      "liquidationPenalty": "0.05",
      "supplyRate": "0.02"
    }
  ],
  "borrowRate": "0.0567",
  "totalSupply": "1234567.89",
  "totalSupplyRaw": "1234567890000000",
  "totalBorrow": "987654.321",
  "totalBorrowRaw": "987654321000000",
  "availableLiquidity": "246913.569",
  "availableLiquidityRaw": "246913569000000",
  "utilizationRate": "0.80",
  "loanTokenPriceUsd": "1.00",
  "isBorrowEnabled": true,
  "supplyCollateralFeeBps": "50",
  "feeWrapperAddress": "0x29ac0c53Eb4b19295875D3895Fb1514ffC8e1616",
  "originationFeeBps": "100",
  "originationFeeWrapperAddress": "0x3C778911B9e36eA8CE53dBF211a203e3300939b6",
  "blueBundleOriginationFeeBps": "50",
  "minLoan": "0.01"
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

GET

markets

{marketId}

Get a single market by ID

curl --request GET \
  --url https://borrow.yield.xyz/v1/markets/{marketId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://borrow.yield.xyz/v1/markets/{marketId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://borrow.yield.xyz/v1/markets/{marketId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://borrow.yield.xyz/v1/markets/{marketId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://borrow.yield.xyz/v1/markets/{marketId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "aave-v3-ethereum-usdc",
  "integrationId": "aave-borrow",
  "network": "ethereum",
  "type": "pool",
  "poolAddress": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
  "loanToken": {
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "logoURI": "<string>"
  },
  "collateralTokens": [
    {
      "token": {
        "symbol": "USDC",
        "name": "USD Coin",
        "decimals": 6,
        "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "logoURI": "<string>"
      },
      "priceUsd": "2800.00",
      "maxLtv": "0.80",
      "liquidationThreshold": "0.825",
      "liquidationPenalty": "0.05",
      "supplyRate": "0.02"
    }
  ],
  "borrowRate": "0.0567",
  "totalSupply": "1234567.89",
  "totalSupplyRaw": "1234567890000000",
  "totalBorrow": "987654.321",
  "totalBorrowRaw": "987654321000000",
  "availableLiquidity": "246913.569",
  "availableLiquidityRaw": "246913569000000",
  "utilizationRate": "0.80",
  "loanTokenPriceUsd": "1.00",
  "isBorrowEnabled": true,
  "supplyCollateralFeeBps": "50",
  "feeWrapperAddress": "0x29ac0c53Eb4b19295875D3895Fb1514ffC8e1616",
  "originationFeeBps": "100",
  "originationFeeWrapperAddress": "0x3C778911B9e36eA8CE53dBF211a203e3300939b6",
  "blueBundleOriginationFeeBps": "50",
  "minLoan": "0.01"
}

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Rate limit exceeded",
  "error": "Too Many Requests",
  "statusCode": 429,
  "retryAfter": 30
}

Looks the market up by id without applying scope, so it also returns markets that are not enabled for your project. Fee fields in the response are resolved for your project. An unknown id returns 404. Fields are described on Objects and enums.

Authorizations

x-api-key

string

header

required

Path Parameters

marketId

string

required

Market identifier (e.g., aave-v3-ethereum-usdc or Morpho Blue bytes32 key)

Example:

"aave-v3-ethereum-usdc"

Response

Market details

string

required

Market ID

Example:

"aave-v3-ethereum-usdc"

integrationId

string

required

Integration ID

Example:

"aave-borrow"

network

enum<string>

required

Network

Available options:

ethereum,

ethereum-goerli,

ethereum-holesky,

ethereum-sepolia,

ethereum-hoodi,

arbitrum,

base,

base-sepolia,

gnosis,

optimism,

polygon,

polygon-amoy,

starknet,

zksync,

linea,

unichain,

plume,

monad-testnet,

monad,

robinhood,

robinhood-testnet,

arc-testnet,

arc,

avalanche-c,

avalanche-c-atomic,

avalanche-p,

binance,

celo,

fantom,

harmony,

moonriver,

okc,

viction,

core,

sonic,

plasma,

katana,

hyperevm,

tempo,

pharos,

agoric,

akash,

axelar,

band-protocol,

bitsong,

canto,

chihuahua,

comdex,

coreum,

cosmos,

crescent,

cronos,

cudos,

desmos,

dydx,

evmos,

fetch-ai,

gravity-bridge,

injective,

irisnet,

juno,

kava,

ki-network,

mars-protocol,

nym,

okex-chain,

onomy,

osmosis,

persistence,

quicksilver,

regen,

secret,

sentinel,

sommelier,

stafi,

stargaze,

stride,

teritori,

tgrade,

umee,

sei,

mantra,

celestia,

saga,

zetachain,

dymension,

humansai,

neutron,

polkadot,

kusama,

westend,

bittensor,

aptos,

binancebeacon,

cardano,

near,

solana,

solana-devnet,

stellar,

stellar-testnet,

sui,

tezos,

tron,

ton,

ton-testnet,

hyperliquid

Example:

"ethereum"

type

enum<string>

required

Market type. "pool" for shared-pool protocols (Aave), "isolated" for pair-based protocols (Morpho Blue).

Available options:

pool,

isolated

Example:

"pool"

poolAddress

string

required

Pool/protocol contract address

Example:

"0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2"

loanToken

object

required

The borrowable token

Show child attributes

collateralTokens

object[]

required

Accepted collateral tokens with per-collateral risk parameters. For isolated markets: single entry. For pool markets: all eligible collateral assets.

Show child attributes

borrowRate

string

required

Current variable borrow rate as decimal

Example:

"0.0567"

totalSupply

string

required

Total supplied amount in human-readable token units

Example:

"1234567.89"

totalSupplyRaw

string

required

Total supplied amount in raw token units

Example:

"1234567890000000"

totalBorrow

string

required

Total borrowed amount in human-readable token units

Example:

"987654.321"

totalBorrowRaw

string

required

Total borrowed amount in raw token units

Example:

"987654321000000"

availableLiquidity

string

required

Available liquidity in human-readable token units

Example:

"246913.569"

availableLiquidityRaw

string

required

Available liquidity in raw token units

Example:

"246913569000000"

utilizationRate

string

required

Utilization rate as decimal

Example:

"0.80"

loanTokenPriceUsd

string

required

Loan token price in USD

Example:

"1.00"

isBorrowEnabled

boolean

required

Whether borrowing is enabled for this asset

Example:

true

supplyCollateralFeeBps

string

required

Deposit fee charged on supplyCollateral, in basis points (1 bp = 0.01%; 50 = 0.5%). Ranges from 0 to 500 (0% to 5%).

Example:

"50"

feeWrapperAddress

string | null

required

Address of the fee wrapper contract charging the deposit fee for the requesting project. null when no wrapper is configured for the (project, integration) pair.

Example:

"0x29ac0c53Eb4b19295875D3895Fb1514ffC8e1616"

originationFeeBps

string

required

Origination fee for plain borrow (allocator wrapper default), in basis points (1 bp = 0.01%). When no wrapper is set, mirrors blueBundleOriginationFeeBps if BlueBundle is configured, else "0".

Example:

"100"

originationFeeWrapperAddress

string | null

required

Address of the wrapper contract charging the origination fee for the requesting project. null when no origination wrapper is configured.

Example:

"0x3C778911B9e36eA8CE53dBF211a203e3300939b6"

blueBundleOriginationFeeBps

string | null

required

BlueBundle origination fee for supplyAndBorrow, in basis points. null when not configured.

Example:

"50"

minLoan

string | null

required

Minimum borrowable amount in human-readable loan-token units. Borrows that would leave debt below this floor, and partial repays that leave remaining debt below it, revert on-chain. null when the market enforces no minimum (e.g. non-Lista integrations).

Example:

"0.01"

⌘I

Getting started

Earn

Trade

Borrow

Authorizations

Path Parameters

Response