Simulate a borrow action
curl --request POST \
--url https://borrow.yield.xyz/v1/actions/simulate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"integrationId": "aave-borrow",
"action": "supply",
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
"args": {
"marketId": "morpho-blue-borrow-base-cbbtc-usdc-86",
"amount": "1.5",
"amountRaw": "1500000",
"repayAll": true,
"tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"collateralTokenAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"collateralAmount": "0.5",
"collateralAmountRaw": "50000000",
"borrowAmount": "100",
"targetLtv": "0.1"
}
}
'import requests
url = "https://borrow.yield.xyz/v1/actions/simulate"
payload = {
"integrationId": "aave-borrow",
"action": "supply",
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
"args": {
"marketId": "morpho-blue-borrow-base-cbbtc-usdc-86",
"amount": "1.5",
"amountRaw": "1500000",
"repayAll": True,
"tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"collateralTokenAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"collateralAmount": "0.5",
"collateralAmountRaw": "50000000",
"borrowAmount": "100",
"targetLtv": "0.1"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integrationId: 'aave-borrow',
action: 'supply',
address: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28',
args: {
marketId: 'morpho-blue-borrow-base-cbbtc-usdc-86',
amount: '1.5',
amountRaw: '1500000',
repayAll: true,
tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
collateralTokenAddress: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
collateralAmount: '0.5',
collateralAmountRaw: '50000000',
borrowAmount: '100',
targetLtv: '0.1'
}
})
};
fetch('https://borrow.yield.xyz/v1/actions/simulate', 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/actions/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integrationId' => 'aave-borrow',
'action' => 'supply',
'address' => '0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28',
'args' => [
'marketId' => 'morpho-blue-borrow-base-cbbtc-usdc-86',
'amount' => '1.5',
'amountRaw' => '1500000',
'repayAll' => true,
'tokenAddress' => '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
'collateralTokenAddress' => '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
'collateralAmount' => '0.5',
'collateralAmountRaw' => '50000000',
'borrowAmount' => '100',
'targetLtv' => '0.1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://borrow.yield.xyz/v1/actions/simulate"
payload := strings.NewReader("{\n \"integrationId\": \"aave-borrow\",\n \"action\": \"supply\",\n \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28\",\n \"args\": {\n \"marketId\": \"morpho-blue-borrow-base-cbbtc-usdc-86\",\n \"amount\": \"1.5\",\n \"amountRaw\": \"1500000\",\n \"repayAll\": true,\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"collateralTokenAddress\": \"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2\",\n \"collateralAmount\": \"0.5\",\n \"collateralAmountRaw\": \"50000000\",\n \"borrowAmount\": \"100\",\n \"targetLtv\": \"0.1\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://borrow.yield.xyz/v1/actions/simulate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integrationId\": \"aave-borrow\",\n \"action\": \"supply\",\n \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28\",\n \"args\": {\n \"marketId\": \"morpho-blue-borrow-base-cbbtc-usdc-86\",\n \"amount\": \"1.5\",\n \"amountRaw\": \"1500000\",\n \"repayAll\": true,\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"collateralTokenAddress\": \"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2\",\n \"collateralAmount\": \"0.5\",\n \"collateralAmountRaw\": \"50000000\",\n \"borrowAmount\": \"100\",\n \"targetLtv\": \"0.1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://borrow.yield.xyz/v1/actions/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationId\": \"aave-borrow\",\n \"action\": \"supply\",\n \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28\",\n \"args\": {\n \"marketId\": \"morpho-blue-borrow-base-cbbtc-usdc-86\",\n \"amount\": \"1.5\",\n \"amountRaw\": \"1500000\",\n \"repayAll\": true,\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"collateralTokenAddress\": \"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2\",\n \"collateralAmount\": \"0.5\",\n \"collateralAmountRaw\": \"50000000\",\n \"borrowAmount\": \"100\",\n \"targetLtv\": \"0.1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"gas": {
"amount": "<string>",
"token": {
"symbol": "USDC",
"name": "USD Coin",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"logoURI": "<string>"
},
"transactions": [
{
"amount": "0.0012",
"token": {
"symbol": "USDC",
"name": "USD Coin",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"logoURI": "<string>"
},
"type": "APPROVAL",
"gasLimit": "21000"
}
]
},
"outcome": {
"currentHealthFactor": "1.85",
"predictedHealthFactor": "1.42",
"currentLtv": "0.55",
"predictedLtv": "0.72",
"liquidationThreshold": "0.85",
"predictedTotalSupplyUsd": "10000.00",
"predictedTotalDebtUsd": "7200.00",
"originationFeeBps": 100,
"originationFeeAmount": "1.00",
"effectivePrincipalAmount": "101.00",
"feeAmount": "0.0005",
"feeBps": 50,
"effectiveCollateralAmount": "0.0125"
}
}{
"message": "Invalid API key",
"error": "Unauthorized",
"statusCode": 401
}{
"message": "Rate limit exceeded",
"error": "Too Many Requests",
"statusCode": 429,
"retryAfter": 30
}Actions
Simulate an action
Preview a Borrow action’s gas cost and its effect on the position without creating the action.
POST
/
v1
/
actions
/
simulate
Simulate a borrow action
curl --request POST \
--url https://borrow.yield.xyz/v1/actions/simulate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"integrationId": "aave-borrow",
"action": "supply",
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
"args": {
"marketId": "morpho-blue-borrow-base-cbbtc-usdc-86",
"amount": "1.5",
"amountRaw": "1500000",
"repayAll": true,
"tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"collateralTokenAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"collateralAmount": "0.5",
"collateralAmountRaw": "50000000",
"borrowAmount": "100",
"targetLtv": "0.1"
}
}
'import requests
url = "https://borrow.yield.xyz/v1/actions/simulate"
payload = {
"integrationId": "aave-borrow",
"action": "supply",
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
"args": {
"marketId": "morpho-blue-borrow-base-cbbtc-usdc-86",
"amount": "1.5",
"amountRaw": "1500000",
"repayAll": True,
"tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"collateralTokenAddress": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"collateralAmount": "0.5",
"collateralAmountRaw": "50000000",
"borrowAmount": "100",
"targetLtv": "0.1"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integrationId: 'aave-borrow',
action: 'supply',
address: '0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28',
args: {
marketId: 'morpho-blue-borrow-base-cbbtc-usdc-86',
amount: '1.5',
amountRaw: '1500000',
repayAll: true,
tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
collateralTokenAddress: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
collateralAmount: '0.5',
collateralAmountRaw: '50000000',
borrowAmount: '100',
targetLtv: '0.1'
}
})
};
fetch('https://borrow.yield.xyz/v1/actions/simulate', 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/actions/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integrationId' => 'aave-borrow',
'action' => 'supply',
'address' => '0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28',
'args' => [
'marketId' => 'morpho-blue-borrow-base-cbbtc-usdc-86',
'amount' => '1.5',
'amountRaw' => '1500000',
'repayAll' => true,
'tokenAddress' => '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
'collateralTokenAddress' => '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
'collateralAmount' => '0.5',
'collateralAmountRaw' => '50000000',
'borrowAmount' => '100',
'targetLtv' => '0.1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://borrow.yield.xyz/v1/actions/simulate"
payload := strings.NewReader("{\n \"integrationId\": \"aave-borrow\",\n \"action\": \"supply\",\n \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28\",\n \"args\": {\n \"marketId\": \"morpho-blue-borrow-base-cbbtc-usdc-86\",\n \"amount\": \"1.5\",\n \"amountRaw\": \"1500000\",\n \"repayAll\": true,\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"collateralTokenAddress\": \"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2\",\n \"collateralAmount\": \"0.5\",\n \"collateralAmountRaw\": \"50000000\",\n \"borrowAmount\": \"100\",\n \"targetLtv\": \"0.1\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://borrow.yield.xyz/v1/actions/simulate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integrationId\": \"aave-borrow\",\n \"action\": \"supply\",\n \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28\",\n \"args\": {\n \"marketId\": \"morpho-blue-borrow-base-cbbtc-usdc-86\",\n \"amount\": \"1.5\",\n \"amountRaw\": \"1500000\",\n \"repayAll\": true,\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"collateralTokenAddress\": \"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2\",\n \"collateralAmount\": \"0.5\",\n \"collateralAmountRaw\": \"50000000\",\n \"borrowAmount\": \"100\",\n \"targetLtv\": \"0.1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://borrow.yield.xyz/v1/actions/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationId\": \"aave-borrow\",\n \"action\": \"supply\",\n \"address\": \"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28\",\n \"args\": {\n \"marketId\": \"morpho-blue-borrow-base-cbbtc-usdc-86\",\n \"amount\": \"1.5\",\n \"amountRaw\": \"1500000\",\n \"repayAll\": true,\n \"tokenAddress\": \"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48\",\n \"collateralTokenAddress\": \"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2\",\n \"collateralAmount\": \"0.5\",\n \"collateralAmountRaw\": \"50000000\",\n \"borrowAmount\": \"100\",\n \"targetLtv\": \"0.1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"gas": {
"amount": "<string>",
"token": {
"symbol": "USDC",
"name": "USD Coin",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"logoURI": "<string>"
},
"transactions": [
{
"amount": "0.0012",
"token": {
"symbol": "USDC",
"name": "USD Coin",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"logoURI": "<string>"
},
"type": "APPROVAL",
"gasLimit": "21000"
}
]
},
"outcome": {
"currentHealthFactor": "1.85",
"predictedHealthFactor": "1.42",
"currentLtv": "0.55",
"predictedLtv": "0.72",
"liquidationThreshold": "0.85",
"predictedTotalSupplyUsd": "10000.00",
"predictedTotalDebtUsd": "7200.00",
"originationFeeBps": 100,
"originationFeeAmount": "1.00",
"effectivePrincipalAmount": "101.00",
"feeAmount": "0.0005",
"feeBps": 50,
"effectiveCollateralAmount": "0.0125"
}
}{
"message": "Invalid API key",
"error": "Unauthorized",
"statusCode": 401
}{
"message": "Rate limit exceeded",
"error": "Too Many Requests",
"statusCode": 429,
"retryAfter": 30
}The body is the same as for Execute an action, but nothing is created or stored, so you can show the user the cost and the resulting position before they commit.
outcome previews the position after the action, with the current and predicted health factor and LTV, and any fees, in the same shape as an action’s metadata. gas.amount is the native-token cost of the whole action. It is null unless every transaction has a gas estimate, and transactions without one are left out of gas.transactions. The response is split into sections so new fields can be added without breaking existing clients.Authorizations
Body
application/json
Integration identifier
Example:
"aave-borrow"
Action to execute
Available options:
supply, borrow, repay, withdraw, enableCollateral, disableCollateral, supplyAndBorrow Example:
"supply"
User wallet address
Example:
"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28"
Action arguments
Show child attributes
Show child attributes
⌘I