Onboarding

Set up your project, generate credentials, configure the dashboard, and integrate the API.

Onboarding to yield.xyz moves through four stages: create your account and project, generate API credentials, configure dashboard settings for your use case, and integrate the API or widget.

1. Account and project setup

Everything in yield.xyz is scoped to a project. A project represents one integration or business line and holds its own enabled yields, fee configuration, and API keys.

1. Sign in to the dashboard

   Sign in at dashboard.yield.xyz.

2. Create a project

   Create a project for your integration. A fresh project starts with no yields enabled and no API keys.

3. Enable yields

   Select the yields to activate for the project. You can filter by network, token, and provider.

GET /v1/yields returns only the yields enabled for your project, so a fresh project with nothing enabled returns an empty list. Calling an action on a yield that isn’t enabled for your project returns 400 Bad Request with "is not enabled for this project", not a 404. Enable yields in the dashboard before testing discovery or actions.

2. API credentials

Create an API key on your project page and send it as the x-api-key header on every request. The key is shown once; store it in a secrets manager. See Projects & API keys for scoping, rotation, and expiry.

3. Dashboard configuration

Configure the settings that shape how your project behaves before going to production. Enterprise teams can automate projects, keys, enabled yields, and fees through Programmatic access. Each setting is covered in Advanced setup:

Configuration	What it controls
Dashboard overview	Projects, access control, compliance, fees, and infrastructure settings
Payout wallets	Where your fee revenue is paid out
Discretionary fees	Deposit, performance, and management fees applied to your project’s actions
Yield blocking	Restricting which enabled yields end users can access
Custom RPC URIs	Bringing your own node endpoints per network
Geoblocking	Restricting yield actions by country or region
Single sign-on	Signing in to the dashboard through your identity provider
Roles & permissions	Scoping teammate access to the dashboard

4. Integration work

With a project, enabled yields, and an API key in place, integrate against the Yield API or widget.

Quickstart

Discover a yield, request an action, sign, and submit in one walkthrough.

AI & Agents

Use yield.xyz agent skills and MCP tooling with AI coding tools.

Guides

Implementation guides for enter, exit, and manage flows.

Next steps

Authentication

Header format and error responses for authenticated requests.

Projects & API keys

Understand project scoping and key management in depth.