API REST
A referência da API REST do AlgoServer: um guia rápido de primeiros passos e as páginas de convenções, autenticação, estratégias e cadastro de conta.
A API REST controla todo o ciclo de vida das estratégias do AlgoServer, além da autenticação e do cadastro de conta. Todas as rotas ficam sob o prefixo /api, e cada chamada é autenticada por token ou por chave de API. A URL base é https://<host>/api.
Primeiros passos
Do login à primeira estratégia
Quatro passos levam você do login à sua primeira estratégia. Os exemplos usam uma ordem única pela simplicidade, mas o fluxo é o mesmo para qualquer estratégia.
Autenticar
Faça login e receba o token de acesso.
Criar
Envie a estratégia com seus parâmetros.
Acompanhar
Inicie e consulte estado, trades e ordens.
Parar
Encerre ou cancele a estratégia.
1. Autenticar
O login devolve um token de acesso. Use-o no cabeçalho Authorization: Bearer nas chamadas seguintes.
curl -X POST https://<host>/api/auth/login \
-H "Content-Type: application/json" \
-d '{"username": "trader1", "password": "sua-senha"}'
{
"access_token": "eyJhbGciOiJI...",
"refresh_token": "b0f3...",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_expires_at": "2026-07-10T21:00:00Z"
}
2. Criar uma estratégia
Crie a estratégia com POST /api/strategy/{tipo}. O id é opcional: informe um, de 1 a 65535, ou deixe em branco, e o AlgoServer gera um e o devolve na resposta.
curl -X POST https://<host>/api/strategy/SingleOrder \
-H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"symbol": "DI1F27", "side": "BUY", "price": 13.505, "quantity": 100}'
3. Iniciar e acompanhar
Inicie a estratégia e depois consulte seu estado, os negócios realizados e as ordens abertas.
curl -X POST https://<host>/api/strategy/start/101 -H "Authorization: Bearer $TOKEN"
curl https://<host>/api/strategy/101 -H "Authorization: Bearer $TOKEN"
curl https://<host>/api/strategy/trades/101 -H "Authorization: Bearer $TOKEN"
curl https://<host>/api/strategy/openOrders -H "Authorization: Bearer $TOKEN"
4. Parar
Para encerrar de forma controlada, use stop; para cancelar, use DELETE.
curl -X POST https://<host>/api/strategy/stop/101 -H "Authorization: Bearer $TOKEN"
curl -X DELETE https://<host>/api/strategy/101 -H "Authorization: Bearer $TOKEN"
Referência