Get an action

Get action by ID

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

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

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

	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/{id}")

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

{id}

Get action by ID

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

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

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

	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/{id}")

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": "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
}

Poll this after submitting a transaction until status is SUCCESS or FAILED; see Action statuses. transactions[] holds the current step only, each with its own status. Only actions created by your project are returned; anything else is 404.

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

The unique identifier of the action (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Action details retrieved successfully

string

required

Unique action identifier (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

integrationId

string

required

Integration identifier

Example:

"aave-borrow"

action

enum<string>

required

Action type executed

Available options:

supply,

borrow,

repay,

withdraw,

enableCollateral,

disableCollateral,

supplyAndBorrow

Example:

"supply"

address

string

required

User wallet address

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f8fB28"

status

enum<string>

required

Current action status

Available options:

CANCELED,

CREATED,

WAITING_FOR_NEXT,

PROCESSING,

FAILED,

SUCCESS,

STALE

Example:

"CREATED"

transactions

object[]

required

Transactions to sign (current step only)

Show child attributes

hasNextStep

boolean

required

Whether there are more transactions to sign after the current step completes. When true, call POST /actions/:id/step after confirming to get the next transaction(s). Used for async multi-step flows such as cross-chain bridges or delayed withdrawals.

Example:

false

currentStep

number

required

Current step number (1-indexed)

Example:

1

totalSteps

number

required

Total number of steps in this action. Most actions are single-step. Multi-step actions occur when an async operation (e.g., bridge confirmation) must complete before the next transaction can be constructed.

Example:

1

createdAt

string<date-time>

required

When the action was created

rawArguments

object

Raw arguments as submitted

Show child attributes

metadata

object

Action metadata with predicted position impact (health factor, LTV, USD totals)

Show child attributes

Getting started

Earn

Trade

Borrow

Authorizations

Path Parameters

Response