Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.credit.credit_rebalance(owner="0x4D3c07d1db7E4A9E44285fae9810d6549655bc74", chain=models.CreditRebalanceRequestChain.ETHEREUM, targets=[
        {
            "protocol": models.CreditProtocol.AAVE,
            "collateral_token": "WETH",
            "borrow_token": "USDC",
            "target_multiplier": 2,
        },
    ], max_slippage_percent=0.5, gas_sponsorship=False)

    # Handle response
    print(res)

import { CompassApiSDK } from "@compass-labs/api-sdk";

const compassApiSDK = new CompassApiSDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await compassApiSDK.credit.creditRebalance({
    owner: "0x4D3c07d1db7E4A9E44285fae9810d6549655bc74",
    chain: "ethereum",
    targets: [
      {
        protocol: "AAVE",
        collateralToken: "WETH",
        borrowToken: "USDC",
        targetMultiplier: 2,
      },
    ],
    maxSlippagePercent: 0.5,
    gasSponsorship: false,
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.compasslabs.ai/v2/credit/rebalance \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "owner": "0x4D3c07d1db7E4A9E44285fae9810d6549655bc74",
  "chain": "ethereum",
  "max_slippage_percent": 0.5,
  "gas_sponsorship": false,
  "targets": [
    {
      "borrow_token": "USDC",
      "collateral_token": "WETH",
      "protocol": "AAVE",
      "target_multiplier": 2
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    owner: '0x4D3c07d1db7E4A9E44285fae9810d6549655bc74',
    chain: 'ethereum',
    max_slippage_percent: 0.5,
    gas_sponsorship: false,
    targets: [
      {
        borrow_token: 'USDC',
        collateral_token: 'WETH',
        protocol: 'AAVE',
        target_multiplier: 2
      }
    ]
  })
};

fetch('https://api.compasslabs.ai/v2/credit/rebalance', 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://api.compasslabs.ai/v2/credit/rebalance",
  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([
    'owner' => '0x4D3c07d1db7E4A9E44285fae9810d6549655bc74',
    'chain' => 'ethereum',
    'max_slippage_percent' => 0.5,
    'gas_sponsorship' => false,
    'targets' => [
        [
                'borrow_token' => 'USDC',
                'collateral_token' => 'WETH',
                'protocol' => 'AAVE',
                'target_multiplier' => 2
        ]
    ]
  ]),
  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://api.compasslabs.ai/v2/credit/rebalance"

	payload := strings.NewReader("{\n  \"owner\": \"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74\",\n  \"chain\": \"ethereum\",\n  \"max_slippage_percent\": 0.5,\n  \"gas_sponsorship\": false,\n  \"targets\": [\n    {\n      \"borrow_token\": \"USDC\",\n      \"collateral_token\": \"WETH\",\n      \"protocol\": \"AAVE\",\n      \"target_multiplier\": 2\n    }\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://api.compasslabs.ai/v2/credit/rebalance")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner\": \"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74\",\n  \"chain\": \"ethereum\",\n  \"max_slippage_percent\": 0.5,\n  \"gas_sponsorship\": false,\n  \"targets\": [\n    {\n      \"borrow_token\": \"USDC\",\n      \"collateral_token\": \"WETH\",\n      \"protocol\": \"AAVE\",\n      \"target_multiplier\": 2\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v2/credit/rebalance")

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  \"owner\": \"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74\",\n  \"chain\": \"ethereum\",\n  \"max_slippage_percent\": 0.5,\n  \"gas_sponsorship\": false,\n  \"targets\": [\n    {\n      \"borrow_token\": \"USDC\",\n      \"collateral_token\": \"WETH\",\n      \"protocol\": \"AAVE\",\n      \"target_multiplier\": 2\n    }\n  ]\n}"

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

{
  "preview": {
    "net_equity_moved_usd": "<string>",
    "total_legs": 123,
    "estimated_max_dust": "<string>",
    "per_target": [
      {
        "protocol": "AAVE",
        "collateral_token": "<string>",
        "borrow_token": "<string>",
        "direction": "open",
        "legs": 123,
        "resulting_collateral": "<string>",
        "resulting_debt": "<string>",
        "resulting_multiplier": "<string>",
        "resulting_health_factor": "<string>",
        "health_factor_scope": "market",
        "estimated_max_dust": "<string>",
        "market_id": "<string>",
        "unloop_legs": [],
        "loop_legs": []
      }
    ],
    "routing_swaps": [],
    "aave_account_health_factor": "<string>"
  },
  "transaction": {
    "chainId": "0x2105",
    "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
    "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
    "gas": "0x7a120",
    "maxFeePerGas": "0x59682f00",
    "maxPriorityFeePerGas": "0x3b9aca00",
    "nonce": "0x5",
    "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
    "value": "0x0"
  },
  "eip_712": {
    "domain": {
      "chainId": 8453,
      "verifyingContract": "0x6B90E8B4E3E971E74C1A47a3a20976377E2dB4b1"
    },
    "message": {
      "baseGas": "0",
      "data": "0x8d80ff0a0000000000000000000000000000000000000000000000000000000000000020",
      "gasPrice": "0",
      "gasToken": "0x0000000000000000000000000000000000000000",
      "nonce": "7",
      "operation": 1,
      "refundReceiver": "0x0000000000000000000000000000000000000000",
      "safeTxGas": "0",
      "to": "0x93C23AAE4793C14D6DF35D2A2A2234204e1559dA",
      "value": "0"
    },
    "primaryType": "SafeTx",
    "types": {
      "EIP712Domain": [
        {
          "name": "chainId",
          "type": "uint256"
        },
        {
          "name": "verifyingContract",
          "type": "address"
        }
      ],
      "SafeTx": [
        {
          "name": "to",
          "type": "address"
        },
        {
          "name": "value",
          "type": "uint256"
        },
        {
          "name": "data",
          "type": "bytes"
        },
        {
          "name": "operation",
          "type": "uint8"
        },
        {
          "name": "safeTxGas",
          "type": "uint256"
        },
        {
          "name": "baseGas",
          "type": "uint256"
        },
        {
          "name": "gasPrice",
          "type": "uint256"
        },
        {
          "name": "gasToken",
          "type": "address"
        },
        {
          "name": "refundReceiver",
          "type": "address"
        },
        {
          "name": "nonce",
          "type": "uint256"
        }
      ]
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Credit

Rebalance the leveraged credit book

Rebalance the leveraged credit book in ONE atomic transaction.

List only the positions to change — anything not named is left untouched; remove a position with close=true. Each target states an end state: target_equity_usd (net USD committed) × target_multiplier.

Releasing targets run first (each unwind/delever frees tokens into the Credit Account), the freed tokens are then routed by swaps at a GUARANTEED minimum output (enforced on-chain), and consuming targets run last — so moving a levered position between markets, token pairs, or protocols (Aave ↔ Morpho) is simply a close plus an open in the same transaction. Conversions involving an ERC-4626 vault-share token (e.g. a Morpho vault token like steakUSDC) go through the vault’s own deposit/redeem at net asset value rather than a DEX swap of the share token.

Net book growth is funded from the Credit Account’s existing idle balance — fund it first via /v2/credit/transfer; a net release stays in the Credit Account as idle balance. Any swap surplus above the guaranteed floors also stays in the Credit Account (preview.estimated_max_dust) — recoverable, never lost.

A book already at its target returns transaction: null with the preview — the call is idempotent and safe to drive from a converge-to-target loop.

A rebalance too large for one transaction is rejected with a 422 — split it into two calls. Every deleveraging step keeps the health factor ≥ 1.02 and every leveraging step respects the protocol’s borrow limits; Aave targets share one account-level health factor, which the preview reports.

Dust tails and routing swaps below the swap router’s minimum routable size do not fail the call: a releasing target that cannot fully unwind returns its honest residual in the preview, and an unroutable routing swap is skipped (its uncovered amount only 422s the rebalance if it breaches the funding tolerance).

For protocol=MORPHO pass a market_id from /v2/credit/morpho_markets; inspect the current book via /v2/credit/looped_positions.

POST

credit

rebalance

Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.credit.credit_rebalance(owner="0x4D3c07d1db7E4A9E44285fae9810d6549655bc74", chain=models.CreditRebalanceRequestChain.ETHEREUM, targets=[
        {
            "protocol": models.CreditProtocol.AAVE,
            "collateral_token": "WETH",
            "borrow_token": "USDC",
            "target_multiplier": 2,
        },
    ], max_slippage_percent=0.5, gas_sponsorship=False)

    # Handle response
    print(res)

import { CompassApiSDK } from "@compass-labs/api-sdk";

const compassApiSDK = new CompassApiSDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await compassApiSDK.credit.creditRebalance({
    owner: "0x4D3c07d1db7E4A9E44285fae9810d6549655bc74",
    chain: "ethereum",
    targets: [
      {
        protocol: "AAVE",
        collateralToken: "WETH",
        borrowToken: "USDC",
        targetMultiplier: 2,
      },
    ],
    maxSlippagePercent: 0.5,
    gasSponsorship: false,
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.compasslabs.ai/v2/credit/rebalance \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "owner": "0x4D3c07d1db7E4A9E44285fae9810d6549655bc74",
  "chain": "ethereum",
  "max_slippage_percent": 0.5,
  "gas_sponsorship": false,
  "targets": [
    {
      "borrow_token": "USDC",
      "collateral_token": "WETH",
      "protocol": "AAVE",
      "target_multiplier": 2
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    owner: '0x4D3c07d1db7E4A9E44285fae9810d6549655bc74',
    chain: 'ethereum',
    max_slippage_percent: 0.5,
    gas_sponsorship: false,
    targets: [
      {
        borrow_token: 'USDC',
        collateral_token: 'WETH',
        protocol: 'AAVE',
        target_multiplier: 2
      }
    ]
  })
};

fetch('https://api.compasslabs.ai/v2/credit/rebalance', 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://api.compasslabs.ai/v2/credit/rebalance",
  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([
    'owner' => '0x4D3c07d1db7E4A9E44285fae9810d6549655bc74',
    'chain' => 'ethereum',
    'max_slippage_percent' => 0.5,
    'gas_sponsorship' => false,
    'targets' => [
        [
                'borrow_token' => 'USDC',
                'collateral_token' => 'WETH',
                'protocol' => 'AAVE',
                'target_multiplier' => 2
        ]
    ]
  ]),
  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://api.compasslabs.ai/v2/credit/rebalance"

	payload := strings.NewReader("{\n  \"owner\": \"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74\",\n  \"chain\": \"ethereum\",\n  \"max_slippage_percent\": 0.5,\n  \"gas_sponsorship\": false,\n  \"targets\": [\n    {\n      \"borrow_token\": \"USDC\",\n      \"collateral_token\": \"WETH\",\n      \"protocol\": \"AAVE\",\n      \"target_multiplier\": 2\n    }\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://api.compasslabs.ai/v2/credit/rebalance")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner\": \"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74\",\n  \"chain\": \"ethereum\",\n  \"max_slippage_percent\": 0.5,\n  \"gas_sponsorship\": false,\n  \"targets\": [\n    {\n      \"borrow_token\": \"USDC\",\n      \"collateral_token\": \"WETH\",\n      \"protocol\": \"AAVE\",\n      \"target_multiplier\": 2\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v2/credit/rebalance")

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  \"owner\": \"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74\",\n  \"chain\": \"ethereum\",\n  \"max_slippage_percent\": 0.5,\n  \"gas_sponsorship\": false,\n  \"targets\": [\n    {\n      \"borrow_token\": \"USDC\",\n      \"collateral_token\": \"WETH\",\n      \"protocol\": \"AAVE\",\n      \"target_multiplier\": 2\n    }\n  ]\n}"

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

{
  "preview": {
    "net_equity_moved_usd": "<string>",
    "total_legs": 123,
    "estimated_max_dust": "<string>",
    "per_target": [
      {
        "protocol": "AAVE",
        "collateral_token": "<string>",
        "borrow_token": "<string>",
        "direction": "open",
        "legs": 123,
        "resulting_collateral": "<string>",
        "resulting_debt": "<string>",
        "resulting_multiplier": "<string>",
        "resulting_health_factor": "<string>",
        "health_factor_scope": "market",
        "estimated_max_dust": "<string>",
        "market_id": "<string>",
        "unloop_legs": [],
        "loop_legs": []
      }
    ],
    "routing_swaps": [],
    "aave_account_health_factor": "<string>"
  },
  "transaction": {
    "chainId": "0x2105",
    "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
    "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
    "gas": "0x7a120",
    "maxFeePerGas": "0x59682f00",
    "maxPriorityFeePerGas": "0x3b9aca00",
    "nonce": "0x5",
    "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
    "value": "0x0"
  },
  "eip_712": {
    "domain": {
      "chainId": 8453,
      "verifyingContract": "0x6B90E8B4E3E971E74C1A47a3a20976377E2dB4b1"
    },
    "message": {
      "baseGas": "0",
      "data": "0x8d80ff0a0000000000000000000000000000000000000000000000000000000000000020",
      "gasPrice": "0",
      "gasToken": "0x0000000000000000000000000000000000000000",
      "nonce": "7",
      "operation": 1,
      "refundReceiver": "0x0000000000000000000000000000000000000000",
      "safeTxGas": "0",
      "to": "0x93C23AAE4793C14D6DF35D2A2A2234204e1559dA",
      "value": "0"
    },
    "primaryType": "SafeTx",
    "types": {
      "EIP712Domain": [
        {
          "name": "chainId",
          "type": "uint256"
        },
        {
          "name": "verifyingContract",
          "type": "address"
        }
      ],
      "SafeTx": [
        {
          "name": "to",
          "type": "address"
        },
        {
          "name": "value",
          "type": "uint256"
        },
        {
          "name": "data",
          "type": "bytes"
        },
        {
          "name": "operation",
          "type": "uint8"
        },
        {
          "name": "safeTxGas",
          "type": "uint256"
        },
        {
          "name": "baseGas",
          "type": "uint256"
        },
        {
          "name": "gasPrice",
          "type": "uint256"
        },
        {
          "name": "gasToken",
          "type": "address"
        },
        {
          "name": "refundReceiver",
          "type": "address"
        },
        {
          "name": "nonce",
          "type": "uint256"
        }
      ]
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Your Compass API Key. Get your key here.

Body

application/json

Rebalance one or more Credit Account positions to their named end-states — lever up or down, grow or shrink equity, open a new position, close an existing one, or migrate (close one and open another) — all in ONE atomic transaction from the Credit Account.

owner

string

default:0x4D3c07d1db7E4A9E44285fae9810d6549655bc74

required

The address that owns the Credit Account.

Example:

"0x4D3c07d1db7E4A9E44285fae9810d6549655bc74"

chain

enum<string>

default:ethereum

required

Blockchain network. Rebalance is not available on HyperEVM yet; use loop/unloop there.

Available options:

arbitrum,

base,

bsc,

ethereum,

tempo

Example:

"ethereum"

targets

RebalanceTarget · object[]

required

The positions to change. Scoped: only positions named here are touched; any position not listed is left untouched.

Minimum array length: 1

Show child attributes

Example:

[
  {
    "borrow_token": "USDC",
    "collateral_token": "WETH",
    "protocol": "AAVE",
    "target_multiplier": 2
  }
]

max_slippage_percent

default:0.5

Request-level per-swap slippage tolerance in percent (including routing swaps). A per-target max_slippage_percent overrides it where set.

Required range: 0 < x <= 10

Example:

0.3

gas_sponsorship

boolean

default:false

If true, returns EIP-712 typed data for gas-sponsored execution instead of an unsigned transaction.

Example:

false

Response

Successful Response

The atomic rebalance transaction plus its guaranteed-floor preview.

preview

CreditRebalancePreview · object

required

Projected end state, computed on guaranteed swap floors.

Show child attributes

transaction

UnsignedTransaction · object | null

Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false. Null when the book is already at its target — nothing to execute.

Show child attributes

Example:

{
  "chainId": "0x2105",
  "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
  "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
  "gas": "0x7a120",
  "maxFeePerGas": "0x59682f00",
  "maxPriorityFeePerGas": "0x3b9aca00",
  "nonce": "0x5",
  "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
  "value": "0x0"
}

eip_712

BatchedSafeOperationsResponse · object | null

EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true.

Show child attributes

Example:

{
  "domain": {
    "chainId": 8453,
    "verifyingContract": "0x6B90E8B4E3E971E74C1A47a3a20976377E2dB4b1"
  },
  "message": {
    "baseGas": "0",
    "data": "0x8d80ff0a0000000000000000000000000000000000000000000000000000000000000020",
    "gasPrice": "0",
    "gasToken": "0x0000000000000000000000000000000000000000",
    "nonce": "7",
    "operation": 1,
    "refundReceiver": "0x0000000000000000000000000000000000000000",
    "safeTxGas": "0",
    "to": "0x93C23AAE4793C14D6DF35D2A2A2234204e1559dA",
    "value": "0"
  },
  "primaryType": "SafeTx",
  "types": {
    "EIP712Domain": [
      { "name": "chainId", "type": "uint256" },
      {
        "name": "verifyingContract",
        "type": "address"
      }
    ],
    "SafeTx": [
      { "name": "to", "type": "address" },
      { "name": "value", "type": "uint256" },
      { "name": "data", "type": "bytes" },
      { "name": "operation", "type": "uint8" },
      { "name": "safeTxGas", "type": "uint256" },
      { "name": "baseGas", "type": "uint256" },
      { "name": "gasPrice", "type": "uint256" },
      { "name": "gasToken", "type": "address" },
      {
        "name": "refundReceiver",
        "type": "address"
      },
      { "name": "nonce", "type": "uint256" }
    ]
  }
}

⌘I