Skip to content

Commit fe5d0cc

Browse files
kakagrikakagri
committed
pushing minimal v0
1 parent 4c4cd72 commit fe5d0cc

File tree

8 files changed

+144
-20
lines changed

8 files changed

+144
-20
lines changed

‎.gitignore‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
.DS_STORE
1+
.DS_STORE
2+
vendor
3+
.bundle
4+
_site
5+
Gemfile.lock

‎Gemfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ source 'https://rubygems.org'
22
gem 'github-pages', group: :jekyll_plugins
33
gem 'jekyll-remote-theme'
44
gem 'jekyll-seo-tag'
5+
gem 'just-the-docs'

‎_config.yml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ url: https://docs.allez.xyz
66
remote_theme: just-the-docs/just-the-docs
77
color_scheme: light
88
logo: assets/images/allez_logo.jpg
9-
footer_content: "2025 Allez"
9+
10+
11+
footer_content: "Allez Labs, 2025"
1012

1113

1214
# Enable plugins
1315
plugins:
1416
- jekyll-remote-theme
15-
- jekyll-seo-tag
17+
- jekyll-seo-tag

‎docs/endpoints/fees.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎docs/kamino.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
layout: default
3+
title: Kamino
4+
parent: API Reference
5+
nav_order: 4
6+
has_children: true
7+
permalink: /api-reference/kamino/
8+
---
9+
10+
# Kamino API
11+
12+
Allez Labs' Kamino APIs provide access to data and metrics related to the Kamino protocol, including fees, liquidity, and lending operations.
13+
14+
## Overview
15+
16+
The Kamino API allows you to retrieve comprehensive data about the Kamino protocol's performance, revenue, and operations. Use these endpoints to integrate Kamino data into your applications, dashboards, or analytics tools.
17+
18+
## Authentication
19+
20+
Endpoints listed in these docs are mostly available without needing an authentication.
21+
22+
To get access to private APIs, or increase rate limits contact [[email protected]](mailto:[email protected]).

‎docs/kamino_endpoints/fess-lifetime.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: default
3+
title: Fees Lifetime
4+
parent: Kamino
5+
grand_parent: API Reference
6+
nav_order: 1
7+
permalink: /api-reference/kamino/fees-lifetime/
8+
---
9+
10+
# Fees Lifetime Endpoint
11+
12+
The Fees Lifetime endpoint provides comprehensive data on Kamino protocol fees and revenue across all product lines, including Klend (lending) and Kamino Liquidity services.
13+
14+
## Endpoint
15+
16+
```http
17+
GET https://api.allez.xyz/kamino/fees
18+
```
19+
20+
Retrieves daily revenue and fee metrics for the Kamino protocol.
21+
22+
## Response Fields
23+
24+
| Field | Description |
25+
|-------|-------------|
26+
| `day` | Date in YYYY-MM-DD format |
27+
| `timestamp` | Unix timestamp for the day |
28+
| `KlendInterestFeesUSD` | Total interest fees collected by Klend in USD |
29+
| `KlendInterestRevenueUSD` | Protocol revenue from interest fees in USD |
30+
| `KlendLiquidationFeesUSD` | Total liquidation fees collected by Klend in USD |
31+
| `KlendLiquidationRevenueUSD` | Protocol revenue from liquidation fees in USD |
32+
| `KlendOriginationFeesUSD` | Total origination fees collected by Klend in USD |
33+
| `KlendOriginationRevenueUSD` | Protocol revenue from origination fees in USD |
34+
| `KlendFeesUSD` | Total fees collected by Klend (sum of interest, liquidation, and origination fees) in USD |
35+
| `KlendRevenueUSD` | Total protocol revenue from Klend in USD |
36+
| `KaminoLiquidityTvlUsd` | Total value locked in Kamino Liquidity in USD |
37+
| `KaminoLiquidityFeesUsd` | Total fees collected by Kamino Liquidity in USD |
38+
| `KaminoLiquidityRevenueUsd` | Protocol revenue from Kamino Liquidity in USD |
39+
| `KaminoFeesUSD` | Total fees collected across all Kamino products (Klend + Kamino Liquidity) in USD |
40+
| `KaminoRevenueUSD` | Total protocol revenue across all Kamino products in USD |
41+
42+
## Example Request
43+
44+
```bash
45+
curl -X GET "https://api.allez.xyz/kamino/fees"
46+
```
47+
48+
## Notes
49+
50+
- Historical data is available from October 2023 onwards
51+
- The endpoint data is refreshed daily and has a 1-day lag (i.e., yesterday's data is available today)
52+
- All monetary values are denominated in USD

‎docs/kamino_endpoints/tvl-endpoint.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
layout: default
3+
title: TVL Data
4+
parent: Kamino
5+
grand_parent: API Reference
6+
nav_order: 2
7+
permalink: /api-reference/kamino/tvl/
8+
---
9+
10+
# TVL Data Endpoint
11+
12+
The TVL (Total Value Locked) endpoint provides historical and current data on the total value locked across Kamino protocol products.
13+
14+
## Endpoint
15+
16+
```http
17+
https://api.allez.xyz/kamino/tvl
18+
```
19+
20+
Retrieves daily TVL metrics for the Kamino protocol.
21+
22+
## Query Parameters
23+
24+
| Parameter | Type | Required | Description |
25+
|-----------|--------|----------|-------------|
26+
| `start_date` | string | No | Filter results from this date onwards (format: YYYY-MM-DD) |
27+
| `end_date` | string | No | Filter results up to this date (format: YYYY-MM-DD) |
28+
| `product` | string | No | Filter by product: `all` (default), `lending`, or `liquidity` |
29+
| `limit` | integer | No | Maximum number of days to return (default: 30, max: 365) |
30+
31+
## Response Fields
32+
33+
| Field | Description |
34+
|-------|-------------|
35+
| `day` | Date in YYYY-MM-DD format |
36+
| `timestamp` | Unix timestamp for the day |
37+
| `lending_tvl` | Total value locked in Klend (lending) in USD |
38+
| `liquidity_tvl` | Total value locked in Kamino Liquidity in USD |
39+
| `total_tvl` | Combined TVL across all Kamino products in USD |
40+
41+
## Example Request
42+
43+
```bash
44+
curl -X GET "https://api.allez.xyz/kamino/tvl?product=lending&start_date=2023-12-01&end_date=2023-12-31" \
45+
-H "Authorization: Bearer YOUR_API_KEY"
46+
```
47+
48+
## Notes
49+
50+
- Historical data is available from October 2023 onwards
51+
- The endpoint data is refreshed daily and has a 1-day lag
52+
- All monetary values are denominated in USD

‎index.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
22
layout: default
3-
title: Allez documentation
3+
title: Allez docs
44
nav_order: 1
55
---
66

7-
# Welcome to the Allez API
7+
# Welcome to the Allez Documentation
88

9-
The Allez API provides developers with tools to integrate our services into their applications. This documentation will help you get started with using our API
9+
Welcome to Allez's comprehensive documentation portal! Here you'll find everything you need to integrate and make the most of our services.
1010

11-
## Documentation
11+
## What You'll Find Here
1212

13-
Our documentation is organized into the following sections:
13+
- **API Documentation**: Detailed documentation of our public API endpoints.
14+
- **Dashboards**: References to our dashboards.
15+
- **Resources**: Specs
1416

15-
- [**Getting Started**](/docs/getting-started): Learn how to set up and make your first API request
16-
- [**API Reference**](/docs/api-reference): Complete reference for all available endpoints and parameters
17+
Whether you're just getting started or looking to optimize your existing integration, our documentation is designed to provide clear, practical guidance for developers at all levels.

0 commit comments

Comments
 (0)