Optimize Allocations

Send X-Partner-Name and X-Partner-API-Key, or pay with x402: without partner headers the route answers 402 with a PAYMENT-REQUIRED header; retry with PAYMENT-SIGNATURE. Payment settles only on a 2xx and the receipt is returned in PAYMENT-RESPONSE.

POST /api/v1/optimizer/{chain_id}/optimize

Optimize Allocations

cURL

curl --request POST \
  --url https://si.ampli.net/api/v1/optimizer/{chain_id}/optimize \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --header 'X-Partner-Name: <api-key>' \
  --data '
{
  "total_capital": "1000000000",
  "token_address": "<string>",
  "current_allocations": {},
  "protocols": [
    "<string>"
  ],
  "constraints": [
    {
      "params": {}
    }
  ],
  "wallet_address": "<string>"
}
'

200

{
  "optimization_result": {
    "allocations": [
      {
        "protocol": "<string>",
        "allocation": "<string>",
        "apr": 123
      }
    ],
    "total_costs": 123,
    "weighted_apr_initial": 123,
    "weighted_apr_final": 123,
    "apr_improvement": 123,
    "gas_estimate_usd": 123,
    "break_even_days": 123
  },
  "action_plan": [
    {
      "action_type": "<string>",
      "protocol": "<string>",
      "amount": "<string>",
      "underlying_amount": "<string>"
    }
  ],
  "calldata": [
    {
      "contract_address": "<string>",
      "function_name": "<string>",
      "parameters": [
        "<string>"
      ],
      "protocol": "<string>",
      "description": "<string>",
      "value": "0"
    }
  ],
  "market_rules": [
    {
      "protocol": "<string>",
      "eligible": true,
      "max_allocation": "<string>",
      "apr_scale": 123,
      "reasons": [
        "<string>"
      ]
    }
  ]
}

Authorizations

X-Partner-Name · string · header · required

X-Partner-API-Key · string · header · required

Headers

X-Partner-API-Key · string | null

X-Partner-Name · string | null

PAYMENT-SIGNATURE · string | null

Path Parameters

chain_id · integer · required

Body

application/json

total_capital · string · required

Total amount to allocate (bigint as string)

Example:

"1000000000"

token_address · string · required

Token address to optimize for

current_allocations · Current Allocations · object · required

Current holdings mapping protocol names to amounts (bigint as string)

Show child attributes

protocols · string[] · required

Protocol names to consider

constraints · ConstraintSchema · object[] | null

Show child attributes

wallet_address · string | null

Wallet address that will execute the transactions

Response

200

application/json

Successful Response

optimization_result · OptimizationResult · object · required

Show child attributes

action_plan · ActionDetail · object[] · required

Show child attributes

calldata · CalldataInfo · object[] · required

Show child attributes

market_rules · MarketRule · object[]

How each requested market was rated before the solver ran: closed, capped, or APR discounted.

Show child attributes