Referência da API

Catálogos

Estratégias, corretoras e mercados disponíveis para o seu contrato. Use para montar as opções das telas.

GET/v1/strategiesEstratégias disponíveis GET/v1/providersCorretoras disponíveis GET/v1/marketsMercados da corretora

GET/v1/strategies

Estratégias disponíveis

Tela do clienteVer no app modelo: Risco e estratégia ↗

Estratégias publicadas concedidas a você, com nome, descrição, corretoras suportadas e limites de parâmetros. Mostre displayName e summary na tela.

Requisição

curl -X GET "$FIN_API/v1/strategies" \
  -u "$FIN_CLIENT_ID:$FIN_CLIENT_SECRET"

Resposta200

{
  "strategies": [
    {
      "strategyId": "FUTURES_MAIN_V1",
      "version": "1.0.0",
      "status": "AVAILABLE",
      "displayName": "Futures Main",
      "summary": "Estratégia de futuros perpétuos em produção, com alvos escalonados e proteção obrigatória.",
      "supportedProviders": [
        "BINANCE",
        "HYPERLIQUID"
      ],
      "supportedMarkets": [
        "PERP"
      ],
      "configurableParameters": [
        {
          "key": "leverage",
          "type": "number",
          "label": "Alavancagem",
          "min": 1,
          "max": 20,
          "default": 5
        }
      ],
      "riskRequirements": {
        "minLeverage": 1,
        "maxLeverage": 20,
        "minMarginPerTradeUsd": 10,
        "requiresStopLoss": true
      }
    }
  ],
  "requestId": "req_muyn0vsw_99hgshny"
}

GET/v1/providers

Corretoras disponíveis

Tela do clienteVer no app modelo: Conectar corretora ↗

Corretoras habilitadas para você e o que cada uma suporta.

Requisição

curl -X GET "$FIN_API/v1/providers" \
  -u "$FIN_CLIENT_ID:$FIN_CLIENT_SECRET"

Resposta200

{
  "providers": [
    {
      "providerId": "BINANCE",
      "name": "Binance",
      "kind": "PERP_CEX",
      "capabilities": [
        "PERP_TRADING",
        "LEVERAGE",
        "STOP_LOSS",
        "TAKE_PROFIT"
      ]
    },
    {
      "providerId": "HYPERLIQUID",
      "name": "Hyperliquid",
      "kind": "PERP_DEX",
      "capabilities": [
        "PERP_TRADING",
        "LEVERAGE",
        "BUILDER_FEE",
        "AGENT_WALLET"
      ]
    }
  ],
  "requestId": "req_muyn0vtx_w89iuno4"
}

GET/v1/markets

Mercados da corretora

Rotina do servidor

Mercados (símbolo, mínimo, precisão, alavancagem máxima). Útil para o campo "Ativos permitidos".

Query string

providerIdBINANCE | HYPERLIQUIDobrigatório
corretora
symbolstringopcional
filtra um símbolo

Erros comuns

400VALIDATION_ERRORfaltou providerId

Requisição

curl -X GET "$FIN_API/v1/markets?providerId=BINANCE" \
  -u "$FIN_CLIENT_ID:$FIN_CLIENT_SECRET"

Resposta200

{
  "markets": [
    {
      "symbol": "BTCUSDT",
      "providerSymbol": "BTCUSDT",
      "kind": "PERPETUAL",
      "base": "BTC",
      "quote": "USDT",
      "active": true,
      "tickSize": 0.1,
      "stepSize": 0.001,
      "minQty": 0.001,
      "minNotionalUsd": 50,
      "quantityPrecision": 3,
      "maxLeverage": 125
    }
  ]
}