Display Your Native APR

Display your protocol's native APR (lending yield, staking rewards, pool fees) next to Merkl incentive APRs on the Merkl frontend, so users see their total return.

Implementation

Endpoint Requirements

To integrate your native APR data, you must create and host a public API endpoint that returns APR data in the following JSON format:

[
  {
    "title": "Protocol Name APR",       // Required: String - Display name for the APR (e.g., "Aave Supply APR", "Uniswap Fee APR")
    "opportunityId": "12345678901234567",  // Required: String - The Merkl Opportunity ID (numeric string)
    "timestamp": 1716900000,            // Required: Number - Unix timestamp in seconds when the APR was calculated
    "value": 5.5,                       // Required: Number - The APR as a percentage (e.g., 5.5 for 5.5%)
    "description": "Optional details"   // Optional: String - Additional context about the APR calculation
  },
  {
    "title": "Protocol Name APR",
    "opportunityId": "98765432109876543",
    "timestamp": 1716900000,
    "value": 12.4
  }
]

Field Descriptions

• title: A clear, descriptive name for the APR type (e.g., "Aave Supply APR", "Compound Borrow APR", "Uniswap V3 Fee APR")
• opportunityId: The internal numeric opportunity ID: the top-level id of an opportunity object, not an id nested inside it (e.g., in tokens). See Finding opportunities and ID types.
• timestamp: When the APR value was last calculated or updated, in Unix timestamp format (seconds)
• value: The APR value as a percentage. For example, use 5.5 to represent 5.5% APR
• description (optional): Additional information about how the APR is calculated or what it represents

Next Steps

Once you have prepared your endpoint:

1. Test your endpoint to ensure it returns data in the correct format
2. Verify that all opportunity IDs are accurate
3. Contact the Merkl team to register your endpoint and complete the integration

If you have questions or need assistance, please reach out to the Merkl team.