Skip to content

Commit 3781baa

Browse files
committed
updated API.md
1 parent 7398a58 commit 3781baa

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

API.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Get real-time statistics for a specific publisher (using player ID).
130130
- `reset` (query, optional) - Reset statistics after retrieval
131131
- `legacy` (query, optional) - Use legacy format with detailed information (set to "1")
132132

133-
**Response (Default Format):**
133+
**Response:**
134134
```json
135135
{
136136
"publisher": {
@@ -145,7 +145,9 @@ Get real-time statistics for a specific publisher (using player ID).
145145
}
146146
```
147147

148-
**Response (Legacy Format with `legacy=1`):**
148+
<details>
149+
<summary>Legacy Format with `legacy=1`</summary>
150+
149151
```json
150152
{
151153
"publishers": {
@@ -166,28 +168,7 @@ Get real-time statistics for a specific publisher (using player ID).
166168
"status": "ok"
167169
}
168170
```
169-
170-
### Configuration
171-
172-
#### Get Server Configuration
173-
174-
```
175-
GET /api/config
176-
Authorization: Bearer <API_KEY>
177-
```
178-
179-
**Response:**
180-
```json
181-
{
182-
"status": "success",
183-
"data": {
184-
"listen_publisher": 4001,
185-
"listen_player": 4000,
186-
"http_port": 8080,
187-
"latency": 2000
188-
}
189-
}
190-
```
171+
</details>
191172

192173
### API Key Management
193174

@@ -231,7 +212,6 @@ The API implements rate limiting to prevent abuse. Each endpoint type has its ow
231212
- **Statistics** (`stats`): 300 requests per minute per IP (configurable via `rate_limit_stats`)
232213
- GET /stats/{player_id}
233214
- **Configuration** (`config`): 20 requests per minute per IP (configurable via `rate_limit_config`)
234-
- GET /api/config
235215
- POST /api/keys
236216

237217
Each endpoint type is tracked separately, so high usage of statistics endpoints won't affect your ability to use other API endpoints.

0 commit comments

Comments
 (0)