List actions

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

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

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

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

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": "550e8400-e29b-41d4-a716-446655440000",
      "integrationId": "aave-borrow",
      "action": "supply",
      "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
      "status": "CREATED",
      "transactions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "network": "ethereum",
          "chainId": "1",
          "type": "SUPPLY",
          "status": "CREATED",
          "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
          "signingFormat": "EVM_TRANSACTION",
          "signablePayload": "{\"from\":\"0x6877BB79...\",\"gasLimit\":\"350000\",\"to\":\"0xA238Dd80...\",\"data\":\"0x617ba037...\"}"
        }
      ],
      "hasNextStep": false,
      "currentStep": 1,
      "totalSteps": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "rawArguments": {
        "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"
      },
      "metadata": {
        "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
}

GET

actions

List actions

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

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

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

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

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": "550e8400-e29b-41d4-a716-446655440000",
      "integrationId": "aave-borrow",
      "action": "supply",
      "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
      "status": "CREATED",
      "transactions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "network": "ethereum",
          "chainId": "1",
          "type": "SUPPLY",
          "status": "CREATED",
          "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28",
          "signingFormat": "EVM_TRANSACTION",
          "signablePayload": "{\"from\":\"0x6877BB79...\",\"gasLimit\":\"350000\",\"to\":\"0xA238Dd80...\",\"data\":\"0x617ba037...\"}"
        }
      ],
      "hasNextStep": false,
      "currentStep": 1,
      "totalSteps": 1,
      "createdAt": "2023-11-07T05:31:56Z",
      "rawArguments": {
        "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"
      },
      "metadata": {
        "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
}

address is required. Results are limited to actions created by your project. action filters by action type. status filters by one action status; statuses takes up to 7 values as a CSV or repeated parameter and, when present, overrides status. offset defaults to 0; limit defaults to 25 and is at most 100.

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

address

string

required

User wallet address to filter actions for

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28"

integrationId

string

Filter by integration

Example:

"aave-borrow"

action

enum<string>

Filter by action type

Available options:

supply,

borrow,

repay,

withdraw,

enableCollateral,

disableCollateral,

supplyAndBorrow

Example:

"supply"

status

enum<string>

Filter by status

Available options:

CANCELED,

CREATED,

WAITING_FOR_NEXT,

PROCESSING,

FAILED,

SUCCESS,

STALE

statuses

enum<string>[]

Filter by multiple statuses (supports CSV or repeated query params)

Available options:

CANCELED,

CREATED,

WAITING_FOR_NEXT,

PROCESSING,

FAILED,

SUCCESS,

STALE

Response

Paginated list of actions

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

Getting started

Earn

Trade

Borrow

List actions

Authorizations

Query Parameters

Response