# Yieldo

> Cross-chain deposit aggregator for ERC-4626 and custom yield vaults

## Docs

- [Confidence Multiplier](https://docs.yieldo.xyz/Scoring/confidence-multiplier.md)
- [Data Architecture](https://docs.yieldo.xyz/Scoring/data-architecture.md)
- [Design Principles](https://docs.yieldo.xyz/Scoring/design-principles.md)
- [Flags](https://docs.yieldo.xyz/Scoring/flags.md)
- [Four Dimensions](https://docs.yieldo.xyz/Scoring/four-dimensions.md)
- [Overview](https://docs.yieldo.xyz/Scoring/overview.md)
- [Roadmap](https://docs.yieldo.xyz/Scoring/roadmap.md)
- [Scoring Model](https://docs.yieldo.xyz/Scoring/scoring-model.md)
- [Admin List Vaults](https://docs.yieldo.xyz/api-reference/admin/admin-list-vaults.md): Admin-only vault list. Source of truth is the UNION of:   - vaults.json (registry — has deposit_router + type + paused + curator)   - yieldo_v1.vaults (indexer — has metrics + score components)
- [Admin Login](https://docs.yieldo.xyz/api-reference/admin/admin-login.md)
- [Admin Logout](https://docs.yieldo.xyz/api-reference/admin/admin-logout.md)
- [Admin Me](https://docs.yieldo.xyz/api-reference/admin/admin-me.md): Light health-check the FE uses to confirm the saved token is still good.
- [Admin Nonce](https://docs.yieldo.xyz/api-reference/admin/admin-nonce.md): Issue a one-time nonce for the SIWE message. Pre-checks the wallet is on the allowlist so a non-admin gets a clean rejection instead of having to sign first and find out.
- [Admin Toggle Vault](https://docs.yieldo.xyz/api-reference/admin/admin-toggle-vault.md): Upsert an admin state row. Pass any subset of {enabled, deposits_enabled, withdrawals_enabled} — unspecified flags are left untouched.
- [Admin Vault Detail](https://docs.yieldo.xyz/api-reference/admin/admin-vault-detail.md): Full vault detail bypassing the public-side disable filter. Mirrors /api/vaults/[vaultId].js so the admin can review metrics — including snapshots for the APY chart — before flipping a vault live.
- [Application Nonce](https://docs.yieldo.xyz/api-reference/applications/application-nonce.md)
- [Approve Application](https://docs.yieldo.xyz/api-reference/applications/approve-application.md)
- [List Apps](https://docs.yieldo.xyz/api-reference/applications/list-apps.md)
- [My Application](https://docs.yieldo.xyz/api-reference/applications/my-application.md): Public — let an applicant poll their own status. No auth needed.
- [Reject Application](https://docs.yieldo.xyz/api-reference/applications/reject-application.md)
- [Submit Application](https://docs.yieldo.xyz/api-reference/applications/submit-application.md)
- [Chains & Tokens](https://docs.yieldo.xyz/api-reference/chains-and-tokens.md): Supported blockchain networks and source tokens
- [Apply For Creator](https://docs.yieldo.xyz/api-reference/creators/apply-for-creator.md): Submit a manual Creator application for review.
- [Get Dashboard](https://docs.yieldo.xyz/api-reference/creators/get-dashboard.md)
- [Get Nonce](https://docs.yieldo.xyz/api-reference/creators/get-nonce.md)
- [Get Profile](https://docs.yieldo.xyz/api-reference/creators/get-profile.md)
- [Get Public Profile](https://docs.yieldo.xyz/api-reference/creators/get-public-profile.md)
- [Get Referrals](https://docs.yieldo.xyz/api-reference/creators/get-referrals.md)
- [Login](https://docs.yieldo.xyz/api-reference/creators/login.md)
- [Logout](https://docs.yieldo.xyz/api-reference/creators/logout.md)
- [Register](https://docs.yieldo.xyz/api-reference/creators/register.md)
- [Resolve Handle](https://docs.yieldo.xyz/api-reference/creators/resolve-handle.md): Resolve a Creator handle to their referrer address (fee_collector_address).
- [Update Settings](https://docs.yieldo.xyz/api-reference/creators/update-settings.md)
- [Update Vaults](https://docs.yieldo.xyz/api-reference/creators/update-vaults.md)
- [Verify Invite](https://docs.yieldo.xyz/api-reference/creators/verify-invite.md): Check if an invite code is valid (unused). Does not consume it.
- [Abandon Deposit](https://docs.yieldo.xyz/api-reference/deposits/abandon-deposit.md): Mark a previously-built deposit as abandoned. Called when the user rejects the wallet prompt or otherwise never broadcasts. Without this the record sits in `pending` for the full 4h abandon timeout.
- [Get User Deposit Summary](https://docs.yieldo.xyz/api-reference/deposits/get-user-deposit-summary.md)
- [Get User Deposits](https://docs.yieldo.xyz/api-reference/deposits/get-user-deposits.md)
- [Report Deposit Tx](https://docs.yieldo.xyz/api-reference/deposits/report-deposit-tx.md): Report the actual on-chain tx hash for a previously-built deposit. Closes the loop between /v1/quote/build (which saves the request before the tx exists) and /v1/status (which needs a tx_hash to fetch LiFi state). Without this, transactions stay `pending` forever in HistoryPage.
- [Health](https://docs.yieldo.xyz/api-reference/health.md)
- [List Chains](https://docs.yieldo.xyz/api-reference/info/list-chains.md)
- [List Tokens](https://docs.yieldo.xyz/api-reference/info/list-tokens.md)
- [Get Signal](https://docs.yieldo.xyz/api-reference/intel/get-signal.md): Permalink to a single signal — used for /R-008/<vault> deep-links from HIGH cards or X posts.
- [List Activity](https://docs.yieldo.xyz/api-reference/intel/list-activity.md): LOW-tier signals — 'All activity' firehose. Activity rows are NOT deduplicated by incident — each event is its own row by design (this is the firehose, not the alert list).
- [List Feed](https://docs.yieldo.xyz/api-reference/intel/list-feed.md): One-shot feed — returns all three tiers in a single call. Convenience for the Intel page so it doesn't need three round-trips.
- [List High](https://docs.yieldo.xyz/api-reference/intel/list-high.md): HIGH-tier signals — hero 'What matters today' cards.
- [List Notable](https://docs.yieldo.xyz/api-reference/intel/list-notable.md): MEDIUM-tier signals — 'Notable signals' feed rows.
- [List Rules](https://docs.yieldo.xyz/api-reference/intel/list-rules.md): Public alert-rule registry. Drives the Methodology page and supports /R-### permalinks for verifiability ('this fired because of rule R-008').
- [Get Dashboard](https://docs.yieldo.xyz/api-reference/partners/get-dashboard.md)
- [Get Nonce](https://docs.yieldo.xyz/api-reference/partners/get-nonce.md): Get a nonce to sign for registration or login.
- [Get Profile](https://docs.yieldo.xyz/api-reference/partners/get-profile.md)
- [Get Transactions](https://docs.yieldo.xyz/api-reference/partners/get-transactions.md)
- [Login](https://docs.yieldo.xyz/api-reference/partners/login.md): Login with wallet signature. Returns session token.
- [Logout](https://docs.yieldo.xyz/api-reference/partners/logout.md)
- [Register](https://docs.yieldo.xyz/api-reference/partners/register.md): Register a new wallet partner with signature verification.
- [Rotate Api Keys](https://docs.yieldo.xyz/api-reference/partners/rotate-api-keys.md): Generate new API key + secret. Old ones are immediately invalidated.
- [Update Settings](https://docs.yieldo.xyz/api-reference/partners/update-settings.md)
- [Update Vaults](https://docs.yieldo.xyz/api-reference/partners/update-vaults.md)
- [Positions](https://docs.yieldo.xyz/api-reference/positions.md): Read a user's vault positions with current value and yield
- [Get Positions](https://docs.yieldo.xyz/api-reference/positions/get-positions.md): Read user's vault positions with current value + historical deposited amount.
- [Zerion Usage](https://docs.yieldo.xyz/api-reference/positions/zerion-usage.md): Current day's Zerion API call count (for debugging / monitoring).
- [Quote & Build](https://docs.yieldo.xyz/api-reference/quote.md): Get a deposit quote with route options, then build the transaction
- [Build Transaction](https://docs.yieldo.xyz/api-reference/quote/build-transaction.md)
- [Get Quote](https://docs.yieldo.xyz/api-reference/quote/get-quote.md)
- [Anomalies](https://docs.yieldo.xyz/api-reference/scores/anomalies.md): Detected anomalies — for the alerts feed and socials content.
- [Compare](https://docs.yieldo.xyz/api-reference/scores/compare.md): Compare 2-5 vaults on the same metric over the same time window — for overlay charts.
- [History](https://docs.yieldo.xyz/api-reference/scores/history.md): Full score history for charting. Returns hourly or daily resolution.
- [Leaderboard](https://docs.yieldo.xyz/api-reference/scores/leaderboard.md): Current ranking — latest snapshot per vault, sorted by the chosen dimension.
- [Movers](https://docs.yieldo.xyz/api-reference/scores/movers.md): Biggest score movers in window — perfect for socials content.
- [Timeseries](https://docs.yieldo.xyz/api-reference/scores/timeseries.md): Single-metric series — returns [{x: ts_iso, y: value}] for chart libs.
- [Status & Tracking](https://docs.yieldo.xyz/api-reference/status.md): Track cross-chain transfer progress
- [Get Transfer Status](https://docs.yieldo.xyz/api-reference/status/get-transfer-status.md)
- [Get Me](https://docs.yieldo.xyz/api-reference/users/get-me.md)
- [Get Nonce](https://docs.yieldo.xyz/api-reference/users/get-nonce.md)
- [Get Referrals](https://docs.yieldo.xyz/api-reference/users/get-referrals.md): Return referral stats + tier for an investor's own referral link.
- [Get Role](https://docs.yieldo.xyz/api-reference/users/get-role.md)
- [Login](https://docs.yieldo.xyz/api-reference/users/login.md)
- [Logout](https://docs.yieldo.xyz/api-reference/users/logout.md)
- [Resolve Ref](https://docs.yieldo.xyz/api-reference/users/resolve-ref.md): Resolve a random user referral code to its owner address.
- [Vaults](https://docs.yieldo.xyz/api-reference/vaults.md): List and inspect available yield vaults
- [Get Vault Detail](https://docs.yieldo.xyz/api-reference/vaults/get-vault-detail.md)
- [Get Vault Registry Integrity](https://docs.yieldo.xyz/api-reference/vaults/get-vault-registry-integrity.md): Diff vaults.json against the public/indexer registry. Returns lists of vault_ids missing from each side. Use this in CI / monitoring to fail fast when the two registries drift apart.
- [Get Vault Stats](https://docs.yieldo.xyz/api-reference/vaults/get-vault-stats.md): Real success-rate stats from historical deposits, optionally filtered by source chain + token. Returns overall + per-bridge breakdown so the deposit UI can tag each route option with its observed success rate.
- [List Vaults](https://docs.yieldo.xyz/api-reference/vaults/list-vaults.md)
- [Abandon Withdraw](https://docs.yieldo.xyz/api-reference/withdraw/abandon-withdraw.md): Mark a built-but-never-broadcast withdraw as abandoned (wallet rejected or never signed). Without this it sits in `pending` until the abandon timeout.
- [Get Pending Requests](https://docs.yieldo.xyz/api-reference/withdraw/get-pending-requests.md): Async withdraw requests submitted through Yieldo. Direct-to-protocol means fulfillment tokens land in the user's own wallet — no claim step. We just track `status` for dashboard UX.
- [List User Withdrawals](https://docs.yieldo.xyz/api-reference/withdraw/list-user-withdrawals.md): All withdraws for a user, newest-first. Mirrors /v1/deposits.
- [Report Withdraw Tx](https://docs.yieldo.xyz/api-reference/withdraw/report-withdraw-tx.md): Report the broadcast tx hash for a built withdraw. Mirrors deposits/{id}/tx.
- [Withdraw Build](https://docs.yieldo.xyz/api-reference/withdraw/withdraw-build.md)
- [Withdraw Quote](https://docs.yieldo.xyz/api-reference/withdraw/withdraw-quote.md)
- [Getting Started](https://docs.yieldo.xyz/getting-started.md): Auth, request format, and a full integration walkthrough
- [Cross-Chain Deposits](https://docs.yieldo.xyz/guides/cross-chain-deposits.md): How cross-chain deposits work — bridging, vault dispatch, and tracking
- [Deposit Flow](https://docs.yieldo.xyz/guides/deposit-flow.md): Complete deposit flow for integrating Yieldo into a frontend application
- [Deposit Router Contracts](https://docs.yieldo.xyz/guides/deposit-router-contracts.md): V3.2.0 attribution-only router, vault dispatch, open caller model, depositForAvailable for cross-chain composer
- [Error Handling](https://docs.yieldo.xyz/guides/error-handling.md): Common errors, HTTP status codes, and best practices
- [Introduction](https://docs.yieldo.xyz/index.md): Cross-chain deposit aggregator for ERC-4626 and custom yield vaults
- [Introduction](https://docs.yieldo.xyz/introduction.md)
- [Hashlock Smart Contract Audit](https://docs.yieldo.xyz/security/hashlock-audit.md): May 2026 audit of Yieldo's attribution and routing layer by Hashlock. Final rating: Secure.

## OpenAPI Specs

- [openapi](https://docs.yieldo.xyz/api-reference/openapi.json)