OrbitYield API Endpoints

Complete reference documentation for all available OrbitYield API endpoints.

User & Authentication

Endpoints for user management, authentication, and wallet connections.

POST /auth/login

GET /auth/logout

GET /user/profile

GET /wallet/connections

Yield Strategies

Endpoints for viewing and interacting with yield strategies.

GET /strategies

GET /strategies/{id}

GET /strategies/performance

GET /strategies/recommended

Investments

Endpoints for managing investments and tracking performance.

GET /investments

POST /investments/deposit

POST /investments/withdraw

GET /investments/history

Wallet Management

Endpoints for managing wallet connections and metamask integration.

GET /wallet/balances

POST /api/metamask

GET /api/metamask

POST /api/metamask/removal-request

Market Data

Endpoints for retrieving market data and analytics.

GET /market/prices

GET /market/trends

GET /market/tvl

GET /market/apy-comparison

Admin APIs

Administrative endpoints for platform management (authorized users only).

GET /admin/users

GET /admin/statistics

GET /admin/metamask

PUT /admin/metamask/{id}

Sample Endpoint Documentation

Below is an example of the detailed documentation provided for each endpoint in the category pages. Click on a category above to see comprehensive documentation for all endpoints.

GET/strategies

List All Strategies

Returns a paginated list of available yield strategies, with filters for various parameters.

Query Parameters

Parameter	Type	Required	Description
`chain`	string	No	Filter by blockchain: ethereum, arbitrum, optimism, etc.
`asset`	string	No	Filter by asset: ETH, USDC, WBTC, etc.
`min_apy`	number	No	Minimum APY percentage (e.g., 5.0 for 5%)
`risk_level`	string	No	Filter by risk level: low, medium, high
`page`	integer	No	Page number (default: 1)
`per_page`	integer	No	Items per page (default: 10, max: 100)

Response Format

{
  "success": true,
  "data": [
    {
      "id": "strat_eth_aave_lending",
      "name": "ETH Aave Lending",
      "description": "Earn yield by lending ETH on Aave v3",
      "chain": "ethereum",
      "asset": "ETH",
      "protocol": "aave",
      "strategy_type": "lending",
      "current_apy": 3.45,
      "historical_apy": {
        "7d": 3.42,
        "30d": 3.38,
        "90d": 3.51
      },
      "risk_level": "low",
      "tvl": 24500000,
      "min_deposit": 0.1,
      "created_at": "2025-01-15T12:00:00Z",
      "updated_at": "2025-03-23T08:15:22Z"
    },
    // More strategies...
  ],
  "meta": {
    "pagination": {
      "total": 45,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 5
    }
  }
}

Example Request

GET https://api.orbityield.cc/v1/strategies?chain=ethereum&min_apy=3.0&risk_level=low

Error Codes

Status Code	Error Code	Description
`400`	`invalid_chain`	The specified chain is not supported
`400`	`invalid_risk_level`	The risk level value is not valid
`401`	`unauthorized`	Authentication is required
`429`	`rate_limit_exceeded`	Too many requests, please try again later

Wallet Management API

Below is a preview of the wallet management API documentation. These endpoints allow you to programmatically manage wallet connections, particularly MetaMask wallets.

POST/api/metamask

Create MetaMask Connection

Stores a new MetaMask wallet connection for a user in the database.

Request Body

Parameter	Type	Required	Description
`walletAddress`	string	Yes	Ethereum wallet address
`userId`	string	Yes	User ID to associate with this wallet

View complete wallet management API documentation →

Get Started with the API

Ready to integrate OrbitYield into your application? Select a category above to explore detailed endpoint documentation, or visit our guides section for step-by-step tutorials.

Integration Guides

Step-by-step tutorials for common integration scenarios.

API Playground

Interactive environment to test API calls and view responses.