Referência da API

Performance

Resultado do cliente por período. Exiba os valores como vieram: não recalcule PnL, taxa ou cobrança no seu app.
GET/v1/users/:externalUserId/performance

Performance do período

current = período aberto (LIVE_ESTIMATE: estimativa, NÃO é cobrança) + até 12 extratos fechados. Por corretora: providerNetRealizedPnlUsd (resultado líquido realizado — mostre como "Resultado"), auditComponents (evidência: PnL bruto, taxas, funding — não some de novo), builderFees (receita FINAUTON separada, não reduz o resultado do cliente), carry, base cobrável e taxa estimada.

Parâmetros de caminho

  • externalUserIdstring (1–120)obrigatório

    id do cliente no SEU sistema

Requisição
curl -X GET "$FIN_API/v1/users/cli-1001/performance" \
  -u "$FIN_CLIENT_ID:$FIN_CLIENT_SECRET"
Resposta200
{
  "externalUserId": "cli-1001",
  "tenantId": "TENANT_A",
  "requestId": "req_muyn0wh7_dedkls3c",
  "current": {
    "status": "LIVE_ESTIMATE",
    "contract": {
      "contractId": "CTR-TENANT_A",
      "version": 1,
      "period": "MONTHLY",
      "policy": "CARRY",
      "performanceFeePercent": 0.2,
      "currency": "USDT"
    },
    "periodStart": "2026-10-07T03:30:36.974Z",
    "periodEnd": "2026-11-01T00:00:00.000Z",
    "providers": [
      {
        "providerId": "HYPERLIQUID",
        "basis": "CANONICAL_NET_REALIZED_PNL",
        "providerNetRealizedPnlUsd": 96,
        "auditComponents": {
          "role": "AUDIT_EVIDENCE",
          "providerRealizedPnlUsd": 100,
          "venueFeesUsd": -3,
          "fundingUsd": -1
        },
        "builderFees": {
          "role": "FINAUTON_REVENUE_SEPARATE",
          "builderFeesUsd": -2
        },
        "netPerformanceUsd": 96,
        "carryInUsd": 0,
        "carryOutUsd": 0,
        "chargeablePerformanceUsd": 96,
        "performanceFeeUsd": 19.2,
        "estimatedPerformanceFeeUsd": 19.2
      }
    ]
  },
  "closedStatements": []
}
GET/v1/users/:externalUserId/statements

Extratos fechados

Extratos CLOSED. kind: ORIGINAL ou ADJUSTMENT (fato que chegou depois do fechamento). Cada extrato aponta a fatura gerada (obligationId) e eventual crédito (creditUsd).

Parâmetros de caminho

  • externalUserIdstring (1–120)obrigatório

    id do cliente no SEU sistema

Requisição
curl -X GET "$FIN_API/v1/users/cli-1001/statements" \
  -u "$FIN_CLIENT_ID:$FIN_CLIENT_SECRET"
Resposta200
{
  "externalUserId": "cli-1001",
  "tenantId": "TENANT_A",
  "requestId": "req_muyn0wj8_2hbpz256",
  "statements": [
    {
      "statementId": "PS-6ac6663cf825906d709f2b09-HYPERLIQUID-2026-10-07",
      "kind": "ORIGINAL",
      "status": "CLOSED",
      "adjustsStatementId": null,
      "tenantId": "TENANT_A",
      "providerId": "HYPERLIQUID",
      "contractId": "CTR-TENANT_A",
      "contractVersion": 1,
      "period": "MONTHLY",
      "policy": "CARRY",
      "periodStart": "2026-10-07T03:30:36.974Z",
      "periodEnd": "2026-11-01T00:00:00.000Z",
      "basis": "CANONICAL_NET_REALIZED_PNL",
      "providerNetRealizedPnlUsd": 96,
      "netPerformanceUsd": 96,
      "auditComponents": {
        "role": "AUDIT_EVIDENCE",
        "providerRealizedPnlUsd": 100,
        "venueFeesUsd": -3,
        "fundingUsd": -1
      },
      "builderFees": {
        "role": "FINAUTON_REVENUE_SEPARATE",
        "builderFeesUsd": -2
      },
      "carryInUsd": 0,
      "carryOutUsd": 0,
      "chargeablePerformanceUsd": 96,
      "performanceFeePercent": 0.2,
      "performanceFeeUsd": 19.2,
      "currency": "USDT",
      "creditUsd": 0,
      "sourceFactsCount": 5,
      "reason": null,
      "obligationId": "6ac66741a85aa5764408ce17",
      "createdAt": "2026-10-07T15:37:37.352Z"
    }
  ]
}