Skip to main content
GET
/
api
/
v1
/
{chain_id}
/
wallets
/
{wallet}
/
apr
curl "https://partners-backend-1038109371738.europe-west1.run.app/api/v1/8453/wallets/0x.../apr?start_date=2024-01-01T00:00:00Z"

{
  "apr": 5.5,
  "sub_periods": [
    {
      "start_date": "2024-01-01T00:00:00Z",
      "end_date": "2024-01-15T00:00:00Z",
      "return_": 0.02,
      "initial_value": 1000.0
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gizatech.xyz/llms.txt

Use this file to discover all available pages before exploring further.

SDK Alternative: Use agent.apr(options?) for a simpler TypeScript interface. See SDK docs

​
Description

Retrieves the Annual Percentage Rate (APR) for a wallet based on its historical performance.

​
Path Parameters

​
chain_id
integer
required
The blockchain chain ID
​
wallet
string
required
The wallet address

​
Query Parameters

​
start_date
string
ISO datetime to start APR calculation (e.g., 2025-05-06T01:00:00+02:00)
​
end_date
string
Optional end date for APR calculation
​
use_exact_end_date
boolean
If true, use end_date as the exact last performance point

​
Response

​
apr
number
Annual Percentage Rate as a decimal (e.g., 5.5 = 5.5%)
​
sub_periods
array
Optional breakdown by sub-periods
curl "https://partners-backend-1038109371738.europe-west1.run.app/api/v1/8453/wallets/0x.../apr?start_date=2024-01-01T00:00:00Z"

{
  "apr": 5.5,
  "sub_periods": [
    {
      "start_date": "2024-01-01T00:00:00Z",
      "end_date": "2024-01-15T00:00:00Z",
      "return_": 0.02,
      "initial_value": 1000.0
    }
  ]
}