API Reference

The Upshift API provides programmatic access to Upshift Finance's tokenized vault ecosystem, enabling developers to integrate sophisticated DeFi yield strategies into their applications.

Welcome to the Upshift API

This RESTful API allows you to query vault information, track user points, calculate returns, and access comprehensive vault performance data.

What is Upshift Finance?

Upshift Finance is a decentralized finance platform that creates tokenized vaults managed by professional strategists. These vaults enable users to participate in sophisticated yield generation strategies while maintaining liquidity through receipt tokens that can be integrated across the DeFi ecosystem.

API Overview

The Upshift API v1 provides access to four core areas of functionality:

🏦 Tokenized Vaults

Access comprehensive information about Upshift's tokenized vaults, including:

  • Vault details, descriptions, and metadata

  • Performance metrics and APY calculations

  • Risk profiles and fee structures

  • Strategist information and subaccount data

  • Receipt token integrations across DeFi protocols

📊 Points System

Query user engagement and reward data:

  • Total points accumulated by users

  • Pool-specific balances and deposits

  • Referral earnings and hierarchies

  • Deposit streaks and activity tracking

📈 Performance Analytics

Calculate and retrieve vault performance metrics:

  • Annualized APY calculations

  • Historical performance data

  • Liquid APY for different time periods

  • Fee-adjusted returns

⚡ System Health

Monitor API status and connectivity with health check endpoints.

Key Features

Multi-Chain Support

The API supports vaults across multiple blockchain networks, with EVM-compatible chains as the primary focus.

Real-Time Data

Access up-to-date vault information, performance metrics, and user balances with low-latency API responses.

Flexible Filtering

Query vaults by status (active/closed), retrieve specific vault data by address, and filter results based on your application's needs.

Receipt Token Integration

Discover how vault receipt tokens integrate with other DeFi protocols, enabling composability and enhanced liquidity options.

Supported Vaults

The API currently supports several key vault types, including but not limited to:

  • cUSDO - Stablecoin-based strategies

  • tETH - Tokenized Ethereum strategies

  • wstETH - Wrapped staked Ethereum

  • rsETH - Restaked Ethereum strategies

Getting Started

Base URL

All API requests should be made to:

https://api.upshift.finance/v1

Authentication

The Upshift API currently operates without authentication requirements for public endpoints. All endpoints return JSON responses and follow REST conventions.

Rate Limits

Please refer to the response headers for current rate limiting information and ensure your application implements appropriate request throttling.

API Endpoints

Health Check

  • GET / - Verify API availability and system status

User Points

  • GET /points/{user_address} - Retrieve comprehensive points data for a specific user address

Tokenized Vaults

  • GET /tokenized_vaults - List all vaults with optional status filtering

  • GET /tokenized_vaults/{vault_address} - Get detailed information for a specific vault

  • GET /tokenized_vaults/{vault_address}/annualized_apy - Calculate annualized APY for a vault

Response Format

All API responses follow a consistent JSON structure with appropriate HTTP status codes:

  • 200 - Successful responses

  • 422 - Validation errors with detailed error information

Error responses include validation details to help debug request issues quickly.

Important Notes

Deprecation Notice

The API includes some deprecated fields for backward compatibility:

  • hgETH30dLiquidAPY and hgETH7dLiquidAPY fields are deprecated

  • These will be removed on January 1, 2026

  • Use liquidAPY30Day and liquidAPY7Day fields instead

Data Accuracy

Performance data and APY calculations are provided for informational purposes. Always verify critical financial data through multiple sources before making investment decisions.

Next Steps

Ready to start building with the Upshift API? Check out our endpoint documentation for detailed request/response schemas, example queries, and integration guides.

For support or questions about integrating with the Upshift API, please reach out to our development team or visit our community resources.

This API documentation covers Upshift API v0.1.0. Features and endpoints may evolve as the platform develops.

PreviousCookie PolicyNextVaults

Last updated