${escapeHtml(service.name)}
${escapeHtml(service.module)}${escapeHtml(service.role)}
${escapeHtml(service.role)}
This page reads the live OpenAPI schema, the Short Hunter gateway, and the legacy compatibility surface so the docs stay synchronized with the backend.
What the system provides and how requests travel from the browser to the provider router and back.
api_server_extended.py provides the FastAPI app and legacy UI routes.api_compat_routes.py preserves older endpoints and aliases.short_hunter_routes.py exposes the gateway contract.providers/router.py handles rotation, fallback, cache, and cooldowns.The backend stays honest about which upstreams it depends on and where those integrations live.
Expandable route cards with methods, parameters, request bodies, response schemas, and example calls.
/openapi.json...OpenAPI component schemas used by the backend.
How the current frontend calls the backend, which headers are actually needed, and how to wire a consumer safely.
const response = await fetch('/api/short-hunter/snapshot/BTCUSDT');
const snapshot = await response.json();
import apiClient from './apiClient.js';
const data = await apiClient.get('/api/providers/status');
The inspected frontend does not require a user auth header for these routes. Provider secrets stay server-side through environment variables and the backend reads them internally.
The repository includes client-side WebSocket helpers, but no server-side @app.websocket route is exposed in the inspected FastAPI app. Mark real-time usage as undocumented unless a websocket route is added later.
The main UI keeps navigation and refresh behavior in static/js/app.js and tab-specific loaders. Consumers should mirror that pattern: fetch, normalize, and then render from the returned JSON.
Treat success: false, sourceMode: UNAVAILABLE, dataState: UNAVAILABLE, and noTradeGuard: true as truthful signals that the backend could not verify the data.
Real endpoints with generated request and response previews.
${escapeHtml(route.description)}
` : ''}${escapeHtml(param.description || 'undocumented')}
${escapeHtml(String(param.example))}
No parameters documented in OpenAPI.
'}${escapeHtml(responseLabel)}
${responseBody ? escapeHtml(responseBody) : 'undocumented'}
curl -X ${route.method} "${window.location.origin}${exampleUrl}"
${requestBody ? escapeHtml(requestBody) : 'No request body documented.'}
${escapeHtml(schema.description || 'undocumented')}
${escapeHtml(sample)}
${escapeHtml(example.path)}
${escapeHtml(example.purpose)}
${escapeHtml(request)}
${escapeHtml(response)}