API Reference¶
A API REST do QuantFX expõe sinais, status e gerenciamento de conta. Base URL em produção: https://api.quantfx.com.br.
Páginas¶
- Autenticação — X-API-Key, X-Admin-Secret, planos, rate limits
- Endpoints — referência completa dos 30+ endpoints
- Webhooks — Eduzz HMAC-SHA256 + payload examples
- Exemplos de Integração — Python, JS, curl, MQL5
OpenAPI¶
FastAPI auto-gera spec OpenAPI 3.0:
| URL | Conteúdo |
|---|---|
/docs |
Swagger UI interativo |
/redoc |
ReDoc (alternativa visual) |
/openapi.json |
Spec JSON (para importar em Postman) |
Convenções¶
- Todas as datas: ISO 8601 com timezone UTC (
2026-05-27T14:32:00Z) - Encoding: UTF-8
- Content-Type:
application/jsonem POSTs - CORS: apenas
quantfx.com.brpermitido em browsers (curl funciona sem CORS)
Status codes¶
| Code | Significado |
|---|---|
| 200 | OK |
| 201 | Created (POST de execution) |
| 400 | Bad request (payload inválido) |
| 401 | Unauthorized (key inválida ou expirada) |
| 403 | Forbidden (admin secret faltando, HMAC fail) |
| 404 | Not found (recurso ou chave revogada) |
| 422 | Validation error (Pydantic) |
| 429 | Rate limit excedido |
| 500 | Server error |
| 503 | Service degraded/down (health check) |
Versionamento¶
API segue major.minor.patch (2.0.0 atual).
Quebra de compatibilidade só em major bump. Adição de campos opcionais não quebra compatibilidade.
| Mudança | Versão |
|---|---|
| Renomear campo | Major bump |
| Mudar tipo de campo | Major bump |
| Adicionar endpoint | Minor bump |
| Adicionar campo opcional | Patch bump |
| Bug fix | Patch bump |