Integrator guides
This companion API lets integrators manage API keys and dashboard members, then read analytics for users and agents attributed to their integrator.
Read the Developer guides first if you haven’t already; they cover authentication and the User and Agent resource models this API builds on.
Authentication
Section titled “Authentication”Read-only integrator details and analytics routes — GET /integrators/v1/{integratorId}, GET /integrators/v1/{integratorId}/users, GET /integrators/v1/{integratorId}/revenue-summary, and GET /integrators/v1/{integratorId}/agents — accept either a SIWE signature from an integrator member or master user, or an active X-Api-Key for that integrator. The key must match the path’s integratorId and pass its configured Origin allowlist, if one is set.
Listing, creating, or deactivating API keys and listing dashboard members require a SIWE signature from an integrator member. Only the master can add or remove dashboard members. A new key’s secret is returned once at creation; later listings expose key metadata only.
On the core API’s createUser endpoint, the wallet signature is still verified; a valid X-Api-Key attributes the new account to its integrator and takes precedence over a referral code in that request. On other signed-in core routes that support optional integrator context, the key does not replace the user’s signature and adds context only if the signed-in user was referred through that integrator; it does not re-attribute other users.
Treat API keys as bearer secrets: keep them server-side and never embed them in browser code. An origin allowlist does not make a key safe to expose.
Why integrate with YieldSeeker?
Section titled “Why integrate with YieldSeeker?”Give your users an automated way to seek yield across supported DeFi vaults while retaining control of their wallets. YieldSeeker configures a revenue-share rate for each integrator and reports its share of eligible platform fees for users attributed to that integrator.
The dashboard and API let you manage access and track referred users, agents, performance, and revenue-share analytics.
To get started, email krishan@yieldseeker.xyz. We can help set up your integration, API access, and revenue-share terms.
Referred users and revenue share
Section titled “Referred users and revenue share”Attribution follows the user’s referrer: referred users are users whose referrerUserId is the integrator’s master user. A dashboard member gets access to integrator data but does not become a referred user.
Revenue summaries report all-time counts, cumulative yield, platform-fee totals, and transaction totals, alongside current holdings, APY percentiles, and the configured revenueShareBps. integratorFeeShareUsd is calculated from collected and owed platform fees; estimated pending fees are reported separately and are not included in that share. These routes provide analytics, not a revenue-share payout.
The reference lists the exact routes and schemas generated from the API’s request and response models. This page describes authentication and attribution behavior.