List markets

List all lending markets

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

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

fetch('https://borrow.yield.xyz/v1/markets', 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",
  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"

	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")

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

{
  "total": 150,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "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

List all lending markets

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

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

fetch('https://borrow.yield.xyz/v1/markets', 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",
  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"

	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")

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

{
  "total": 150,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "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
}

scope selects which markets are returned.

`scope`	Returns
`enabled` (default)	Only markets enabled for your project. Empty when none are enabled.
`all`	Every market the Borrow API knows, regardless of project.

integrationId must be a known integration or the call returns 400. offset defaults to 0; limit defaults to 25 and is at most 100. total is the count after filtering. Use an item’s id as marketId in Execute an action. Market fields and the pool versus isolated models are on Objects and enums.

Authorizations

x-api-key

string

header

required

Query Parameters

offset

number

default:0

Offset for pagination

Required range: x >= 0

Example:

0

limit

number

default:25

Maximum number of items to return

Required range: 1 <= x <= 100

Example:

25

integrationId

string

Filter by integration

Example:

"aave-borrow"

network

enum<string>

Filter by 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"

scope

enum<string>

default:enabled

Whether to return only enabled markets for the project or all markets

Available options:

enabled,

all

Example:

"enabled"

Response

Paginated list of lending markets

total

number

required

Total number of items available

Example:

150

offset

number

required

Offset of the current page

Example:

0

limit

number

required

Limit of the current page

Example:

100

items

object[]

Show child attributes

⌘I

Getting started

Earn

Trade

Borrow

Authorizations

Query Parameters

Response