OrbitYield API Overview

Introduction

The OrbitYield API enables developers to build applications that interact with our yield optimization platform. Whether you're building a portfolio tracker, a DeFi dashboard, or integrating yield opportunities into your own application, our API provides the tools you need.

Our API follows RESTful principles and uses standard HTTP response codes, authentication, and verbs. All responses are returned in JSON format, making it easy to parse and use in any programming language.

Authentication

The OrbitYield API uses API keys to authenticate requests. You can view and manage your API keys in the developer section of your OrbitYield dashboard.

Authentication is performed via the X-API-KEY HTTP header:

Rate Limiting

To ensure the stability of our API and fair usage across all users, we implement rate limiting. The current limits are:

When you exceed the rate limit, the API will return a 429 Too Many Requests response. Each response includes the following headers to help you manage your rate limits:

• X-RateLimit-Limit: The maximum number of requests you're permitted to make per minute.
• X-RateLimit-Remaining: The number of requests remaining in the current rate limit window.
• X-RateLimit-Reset: The time at which the current rate limit window resets in UTC epoch seconds.

Response Formats

All responses are returned in JSON format. A typical successful response will have the following structure:

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "pagination": {
      "total": 100,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 10
    }
  }
}

Error responses will have the following structure:

{
  "success": false,
  "error": {
    "code": "error_code",
    "message": "A descriptive error message",
    "details": {
      // Additional error details if available
    }
  }
}

HTTP Status Codes

The OrbitYield API uses standard HTTP status codes to indicate the success or failure of an API request:

Pagination

For endpoints that return collections of resources, the OrbitYield API supports pagination through query parameters:

Example request with pagination:

API Versioning

The OrbitYield API is versioned to ensure backward compatibility as we develop new features. The current version is v1, which is included in the base URL.

We will notify all API users well in advance of any changes that would break compatibility. When a new version is released, the previous version will remain available for a deprecation period of at least 6 months.

Client Libraries & SDKs

To make integration easier, we provide official client libraries for popular programming languages: