Endpoints da API

Todos os endpoints disponíveis

URL Base

Produção: https://api.usdtlowfee.com

Convenções Gerais

Unidades

  • • sun: 1 TRX = 1.000.000 sun (todos os campos de valor usam sun)
  • • energyValue: unidade de energia (número int64)
  • • durationHours: horas (número int)

Tipos de Dados

  • • Campos ID: número int64 (snowflake ID)
  • • Campos de valor: número int64 (sufixo *Sun, exemplo: balanceSun, priceSun)
  • • Campos de tempo: string (formato ISO8601 UTC, exemplo: "2025-01-15T10:30:00Z")
  • • Campos booleanos: true/false

Formato de Resposta

  • • Sucesso: { "data": {...}, "meta": {...} } (meta opcional)
  • • Erro: { "error": { "code": "...", "message": "..." } }

Gerenciamento de Conta

Consultar saldo da carteira e informações do usuário

GET /v1/wallet/balance

Obter Saldo

Obter saldo atual da carteira

Exemplo de resposta:

{
  "data": {
    "balanceSun": 1000000,
    "frozenSun": 0,
    "totalSun": 1000000
  }
}
GET /v1/users/me

Informações do Usuário

Obter informações básicas do usuário atual

Exemplo de resposta:

{
  "data": {
    "id": 123456,
    "email": "user@example.com",
    "emailVerified": true,
    "createdAt": "2025-01-01T00:00:00Z"
  }
}

Gerenciamento de Pedidos

Criar e consultar pedidos de energia

POST /v1/energy/orders

Criar Pedido

Criar um pedido de aluguel de energia para um endereço especificado (atualmente suporta apenas tipo manual)

Parâmetros de solicitação:

Parâmetro Tipo Obrigatório Descrição
type string Sim Tipo do pedido, atualmente suporta apenas "manual"
data.tronAddress string Sim Endereço TRON que receberá a energia (34 caracteres, começa com T)
data.energyValue int64 Sim Quantidade de energia (número, mínimo 32000, recomendado 65000 para transferência USDT)
data.durationHours int Sim Duração do aluguel (horas, valores válidos: 1, 24, 72, 168, 336, 720)

Exemplo de solicitação:

{
  "type": "manual",
  "data": {
    "tronAddress": "TYour1Address2Here3...",
    "energyValue": 65000,
    "durationHours": 1
  }
}

Exemplo de resposta:

{
  "data": {
    "id": 1234567890,
    "userId": 9876543210,
    "tronAddress": "TYour1Address2Here3...",
    "energyValue": 65000,
    "durationHours": 1,
    "priceSun": 3000000,
    "priceTrx": 3.0,
    "orderType": "manual",
    "status": "processing",
    "createdAt": "2025-01-15T10:30:00Z",
    "updatedAt": "2025-01-15T10:30:00Z",
    "statusUpdatedAt": "2025-01-15T10:30:00Z",
    "canTransitionTo": ["completed", "failed"]
  }
}
GET /v1/energy/orders/:id

Obter Pedido

Consultar detalhes do pedido por ID

Exemplo de resposta:

{
  "data": {
    "id": 1234567890,
    "userId": 9876543210,
    "tronAddress": "TYour1Address2Here3...",
    "energyValue": 65000,
    "durationHours": 1,
    "priceSun": 3000000,
    "priceTrx": 3.0,
    "orderType": "manual",
    "status": "completed",
    "txid": "abc123...",
    "createdAt": "2025-01-15T10:30:00Z",
    "completedAt": "2025-01-15T10:30:05Z",
    "updatedAt": "2025-01-15T10:30:05Z",
    "statusUpdatedAt": "2025-01-15T10:30:05Z",
    "canTransitionTo": []
  }
}
GET /v1/energy/orders

Listar Pedidos

Consultar lista de pedidos (suporta paginação e filtros)

Parâmetros de solicitação:

Parâmetro Tipo Obrigatório Descrição
offset number Não Deslocamento, padrão 0
limit number Não Número de itens por página, padrão 20, máximo 100
status string Não Filtrar por status do pedido: processing, completed, failed

Exemplo de resposta:

{
  "data": {
    "orders": [
      {
        "id": 1234567890,
        "userId": 9876543210,
        "tronAddress": "TYour1...",
        "energyValue": 65000,
        "durationHours": 1,
        "priceSun": 3000000,
        "priceTrx": 3.0,
        "orderType": "manual",
        "status": "completed",
        "createdAt": "2025-01-15T10:30:00Z",
        "updatedAt": "2025-01-15T10:30:05Z",
        "statusUpdatedAt": "2025-01-15T10:30:05Z",
        "canTransitionTo": []
      }
    ],
    "total": 100,
    "offset": 0,
    "limit": 20
  }
}

Gerenciamento de Endereços

Gerenciar endereços destinatários frequentemente usados

POST /v1/addresses

Adicionar Endereço

Salvar um novo endereço

Exemplo de solicitação:

{
  "tronAddress": "TYour1Address2Here3...",
  "label": "Carteira Principal",
  "isDefault": false
}

Exemplo de resposta:

{
  "data": {
    "id": 1,
    "tronAddress": "TYour1Address2Here3...",
    "label": "Carteira Principal",
    "isDefault": false,
    "usageCount": 0,
    "createdAt": "2025-01-01T00:00:00Z"
  }
}
GET /v1/addresses

Listar Endereços

Obter lista de endereços salvos

Exemplo de resposta:

{
  "data": {
    "addresses": [
      {
        "id": 1,
        "tronAddress": "TYour1Address2Here3...",
        "label": "Carteira Principal",
        "isDefault": true,
        "usageCount": 5,
        "lastUsedAt": "2025-01-15T10:30:00Z",
        "createdAt": "2025-01-01T00:00:00Z"
      }
    ],
    "total": 1
  }
}
GET /v1/addresses/:id

Obter Detalhes do Endereço

Consultar informações de um endereço

Exemplo de resposta:

{
  "data": {
    "id": 1,
    "tronAddress": "TYour1Address2Here3...",
    "label": "Carteira Principal",
    "isDefault": true,
    "usageCount": 5,
    "lastUsedAt": "2025-01-15T10:30:00Z",
    "createdAt": "2025-01-01T00:00:00Z"
  }
}
PUT /v1/addresses/:id/label

Atualizar Rótulo do Endereço

Alterar o rótulo de um endereço

Exemplo de solicitação:

{
  "label": "Novo Rótulo"
}

Exemplo de resposta:

{
  "data": {
    "id": 1,
    "tronAddress": "TYour1Address2Here3...",
    "label": "Novo Rótulo",
    "isDefault": false,
    "usageCount": 3,
    "lastUsedAt": "2025-01-15T10:30:00Z",
    "createdAt": "2025-01-01T00:00:00Z"
  }
}
PUT /v1/addresses/:id/default

Definir Endereço Padrão

Definir o endereço especificado como endereço destinatário padrão

Exemplo de resposta:

// HTTP 204 No Content
// Sem conteúdo de resposta

Retorna código de status 204 sem conteúdo quando bem-sucedido.
DELETE /v1/addresses/:id

Excluir Endereço

Excluir um endereço salvo