SPB Git forge

spb/hfmarketdata

Public

Open high-frequency market data platform — FirstRate full-history downloader, DuckDB/Parquet lake, open REST API and React docs platform (www.hfmarketdata.io)

127commits 1branches 0releases
24.7 MBsize
maindefault branch
11 days agolast push
JavaScript 53.7% Python 38.3% CSS 4.6% TypeScript 3.1%

docs: inventaire des routes comptes généré depuis l'OpenAPI

Simon-Pierre Boucher committed 18 days ago (Sep 6, 2026) parent fc66140

1 changed file +35 −1

modified docs/accounts-ratelimit.md +35 −1
@@ -161,7 +161,41 @@ or tokens (an existing pending invitation link is printed again).
161 161 Behind ngrok the client IP is the first hop of `X-Forwarded-For`; make sure nothing upstream lets clients
162 162 spoof it (ngrok overwrites it).
163 163
164 −## Inventaire des routes comptes (généré 2026-09-06)
164 +## Inventaire des routes comptes (généré 2026-09-06 depuis /openapi.json)
165 165
166 166 | Route | Méthode | Résumé |
167 167 |---|---|---|
168 +| `/v1/admin/audit` | GET | Audit log |
169 +| `/v1/admin/usage` | GET | Global usage: totals per day + top principals |
170 +| `/v1/admin/users` | GET | List users |
171 +| `/v1/admin/users` | POST | Create or invite a user |
172 +| `/v1/admin/users/{user_id}` | DELETE | Delete (anonymise) a user |
173 +| `/v1/admin/users/{user_id}` | GET | User detail: keys, pending links, 7-day usage |
174 +| `/v1/admin/users/{user_id}` | PATCH | Update tier / role / status / name |
175 +| `/v1/admin/users/{user_id}/invite` | POST | (Re-)send the invitation |
176 +| `/v1/admin/users/{user_id}/keys` | POST | Create an API key for a user (shown once) |
177 +| `/v1/admin/users/{user_id}/keys/{key_id}` | DELETE | Revoke a user's API key |
178 +| `/v1/admin/users/{user_id}/reset-password` | POST | Send a password-reset link to a user |
179 +| `/v1/auth/accept-invite` | POST | Accept an invitation (set your password) |
180 +| `/v1/auth/forgot` | POST | Request a password-reset link |
181 +| `/v1/auth/login` | POST | Sign in with e-mail + password |
182 +| `/v1/auth/logout` | POST | Sign out (this browser) |
183 +| `/v1/auth/reset` | POST | Set a new password from a reset link |
184 +| `/v1/auth/signup` | POST | Create an account (sends a verification e-mail) |
185 +| `/v1/auth/verify` | GET | Verification link landing (redirects to the web page, does not consume the token) |
186 +| `/v1/auth/verify` | POST | Verify an e-mail address (or confirm an e-mail change) |
187 +| `/v1/limits` | GET | Tier table + your current counters (works without a key) |
188 +| `/v1/me` | DELETE | Delete your account |
189 +| `/v1/me` | GET | Your profile, tier and limits |
190 +| `/v1/me` | PATCH | Update your profile (name, quota alerts) |
191 +| `/v1/me/email` | POST | Change your e-mail address (confirmation link sent to the new address) |
192 +| `/v1/me/keys` | GET | List your API keys |
193 +| `/v1/me/keys` | POST | Create an API key (shown once) |
194 +| `/v1/me/keys/{key_id}` | DELETE | Revoke an API key |
195 +| `/v1/me/keys/{key_id}` | PATCH | Rename a key / edit its note |
196 +| `/v1/me/keys/{key_id}/rotate` | POST | Rotate an API key (revoke + create) |
197 +| `/v1/me/limits` | GET | Live quota of your keys (remaining requests / rows in the current window) |
198 +| `/v1/me/password` | POST | Change your password |
199 +| `/v1/me/sessions/revoke-all` | POST | Sign out everywhere |
200 +| `/v1/me/usage` | GET | Your usage series (requests, rows, 429s) |
201 +| `/v1/me/usage.csv` | GET | Your usage series as CSV |
168 202