Programmatic Access
Automate project provisioning, API key management, yield enablement, fee configuration, and reporting through the Programmatic API
Overview
The Yield.xyz Programmatic API gives you full control over the dashboard without manual interaction. It is designed for teams that need deeper integration, such as automating project creation, managing API keys, enabling yields, configuring fees, and pulling reports — all through a dedicated set of admin-level endpoints.
The Programmatic API is separate from the standard Yield API. It uses a dedicated Admin API Key (
X-ADMIN-API-KEY) and is intended for administrative and platform-operator use cases — not end-user flows.
What You Can Do
| Area | Description |
|---|---|
| Projects | Create, update, list, and delete projects programmatically — one per client, workspace, or environment. |
| API Keys | Mint, rotate, and revoke project-level API keys that authenticate requests to the Yield API. |
| Enabled Yields | Control which yield integrations are available per project — enable or disable individually or in bulk. |
| Fee Configuration | Set deposit, management, and performance fees per integration on a per-project basis. |
| Reports | Pull transaction and staking activity across all or individual projects for reconciliation and analytics. |
When to Use Programmatic Access
Programmatic access is ideal when you need to:
- Automate onboarding — Spin up projects and keys for new clients without touching the dashboard.
- Manage at scale — Maintain dozens or hundreds of projects with different yield sets and fee schedules.
- Build platform integrations — Embed Yield.xyz capabilities into your own product, routing all configuration through your backend.
- Enforce consistency — Apply standardized configurations across projects via code rather than manual setup.
Authentication
All programmatic endpoints require a Programmatic Access API Key, passed via the X-ADMIN-API-KEY header. This key is scoped to your team and is not the same as project-level API keys used by the Yield API.
Steps to generate your Admin API Key:
- Open the dashboard — Log in to dashboard.yield.xyz
- Navigate to Developers — Click your avatar (top-right) and select Developers
- Create an Admin API Key — Click Create API Key to generate your Programmatic Access key
Store the API key securely — it grants full administrative access to your team's projects and configuration. The key is only shown once at creation time.
Base URL
All programmatic endpoints are served from:
https://api.stakek.it/v1/programmatic/Available Endpoints
| Resource | Endpoints | Description |
|---|---|---|
| Projects | POST / GET / PATCH / DELETE /v1/programmatic/projects | Create, list, update, and delete projects |
| Keys | POST / GET / PATCH / DELETE /v1/programmatic/projects/{projectId}/keys | Manage API keys per project |
| Enabled Yields | POST / GET / DELETE /v1/programmatic/projects/{projectId}/yields/enabled | Enable or disable yield integrations |
| Fee Configuration | POST / GET / PATCH / DELETE /v1/programmatic/projects/{projectId}/fee-configuration | Configure fees per integration |
| Reports | GET /v1/programmatic/report-entries | Pull transaction and staking activity |
Updated 1 day ago