get_returns
Query historical DeFi lending returns from the ProfitLens engine.
Returns real, empirically measured after-fee returns — not theoretical
APY projections. Data is computed from on-chain index ratios every 30 min.
Args:
api_key: Your PreFlyte API key (required).
chain: Filter by chain — "ethereum" or "arbitrum". Empty = all chains.
protocol: Filter by protocol — "aave-v3" or "compound-v3". Empty = all.
asset: Filter by asset symbol — "USDC", "WETH", etc. Empty = all.
strategy: Filter by strategy — "supply" or "borrow". Empty = both.
window_days: Return window — 7, 14, 30, or 90 days. Default 7.
limit: Max results to return. Default 20, max 50.
Returns:
Dictionary with 'results' array and metadata. Each result includes:
gross_apy_pct, net_apy_pct, gas_cost_pct, data_completeness_pct,
chain, protocol, asset, strategy, and more.
get_ranking
Get ranked list of best DeFi lending returns, sorted by net APY.
Args:
api_key: Your PreFlyte API key (required).
window_days: Return window — 7, 14, 30, or 90 days. Default 7.
strategy: "supply" or "borrow". Default "supply".
top_n: Number of top results. Default 10, max 30.
Returns:
Ranked list with position number, net_apy_pct, gross_apy_pct,
gas details, and data completeness scores.
get_market_snapshot
Get current market snapshot for a specific lending market.
Returns the latest rates, risk parameters, token price, and gas price.
This is the foundation of RealityCheck — giving agents ground truth
about current market conditions before they act.
Args:
api_key: Your PreFlyte API key (required).
protocol: Protocol name — "aave-v3" or "compound-v3".
chain: Chain name — "ethereum" or "arbitrum".
asset: Asset symbol — "USDC", "USDT", "DAI", "WETH", "WBTC", "wstETH".
Returns:
Dictionary with latest lending rates, risk parameters (if available),
current token price, current gas price, data freshness timestamps,
and rate_context (7-day averages, standard deviations, anomaly flags).
verify_claim
Verify factual claims about current DeFi market conditions.
Supports two modes:
- Single claim: provide claim_type, value, operator (and protocol/chain/asset
as needed). Returns one verification result.
- Batch mode: provide a JSON-encoded array in 'claims'. Each element has
the same fields (claim_type, value, operator, protocol, chain, asset).
Returns all results in one response. If 'claims' is provided, single-claim
parameters are ignored.
Args:
api_key: Your PreFlyte API key (required).
claim_type: What you're checking. One of:
"supply_rate" — current supply APY (%)
"borrow_rate" — current borrow APY (%)
"price" — current token price (USD)
"gas" — current base fee (gwei)
"utilization" — current pool utilization (%)
value: The numeric value you believe to be true.
operator: Comparison operator. One of:
"above" — actual must be >= value
"below" — actual must be <= value
"around" — actual must be within 10% of value
protocol: Required for supply_rate, borrow_rate, utilization.
Use "aave-v3" or "compound-v3".
chain: Chain name — "ethereum" or "arbitrum". Default "ethereum".
asset: Required for supply_rate, borrow_rate, price, utilization.
Use token symbol like "USDC", "WETH", etc.
claims: JSON-encoded array of claim objects for batch verification.
Each object contains: claim_type, value, operator, and optionally
protocol, chain, asset. When provided, single-claim params are ignored.
Returns:
Single mode: Dictionary with status (TRUE/FALSE), actual_value,
claimed_value, delta, delta_pct, data_timestamp, and summary.
Batch mode: Dictionary with 'mode', 'results' array, 'summary' counts,
and 'verified_at' timestamp.
Examples:
Single:
verify_claim(api_key="...", claim_type="supply_rate", value=5.0,
operator="above", protocol="aave-v3", asset="USDC")
Batch:
verify_claim(api_key="...", claims='[{"claim_type": "supply_rate", ...}, ...]')
assess_opportunity
Assess the best DeFi opportunity for a given capital amount and strategy.
This is the "cold start" tool — call it first to understand where your
capital is viable before making any moves. One call gives you chain
viability, ranked opportunities, gas impact, and an actionable recommendation.
Args:
api_key: Your PreFlyte API key (required).
asset: Token symbol, e.g. "USDC", "WETH".
action: "supply" or "borrow".
position_size_usd: Capital amount in USD.
strategy: One of "yield_farming", "active_trading", "idle_capital".
chain: "ethereum", "arbitrum", or "any" (default: "any").
trades_per_day: For active_trading strategy only. Default 10.
Returns:
JSON with chain viability, ranked opportunities, gas analysis,
break-even calculations, and an actionable recommendation.
gas_timing
Tell agents whether now is a good or bad time to transact, based on
historical gas patterns.
Compares current gas to 24-hour and 7-day averages, identifies the
cheapest hours of the day, and estimates reference transaction costs.
Args:
api_key: Your PreFlyte API key (required).
chain: Chain name — "ethereum" or "arbitrum".
Returns:
Dictionary with current gas, 24h/7d context, timing assessment
with cheapest hours, and reference transaction costs in USD.