/api/hl/address/:addr
GETDisponível

Estado da conta de um endereço na Hyperliquid

Estado da conta de um endereço na Hyperliquid (posições, patrimônio)

GET/api/hl/address/:addr
Lido diretamente da API pública da Hyperliquid a cada requisição; sem cache e sem armazenamento.

Requisição

Parâmetros de consulta

NomeTipoObrigatórioPadrãoValores aceitosDescrição
addr pathstringObrigatório——Endereço de 40 dígitos hexadecimais com prefixo 0x; 400 em caso de formato inválido. Exemplo: 0x5b5d51203a0f9079f8aeb098a6523a13f298c060

Os parâmetros marcados como “path” fazem parte da URL.

Exemplo de requisição

curl -s "https://www.coinboss.com/api/hl/address/0x5b5d51203a0f9079f8aeb098a6523a13f298c060"

Campos da resposta

A tabela de campos é gerada a partir de respostas reais, portanto lista exatamente o que o endpoint retorna. Os caminhos usam a[] para itens de array e {*} para objetos indexados por um nome dinâmico, como uma moeda ou uma corretora.

CampoTipoUnidadeDescrição
successboolean—true quando a requisição foi bem-sucedida. Em caso de falha, o corpo é `{ success: false, code, error, request_id }`.
updatednumbermsQuando os dados foram atualizados pela última vez.
accountValuenumberUSDPatrimônio da conta.
totalNtlPosnumberUSDValor nocional total de todas as posições abertas em perpétuos da conta, obtido do resumo de margem da Hyperliquid.
totalMarginUsednumberUSDMargem atualmente bloqueada pelas posições abertas da conta, obtida do resumo de margem da Hyperliquid.
withdrawablenumberUSDSaldo que a conta pode sacar neste momento, conforme reportado pela Hyperliquid.
positionsarray—Posições abertas.
positions[]object—Posições abertas.
positions[].coinstring—Símbolo da moeda, em maiúsculas (por exemplo, BTC).
positions[].szinumber—Tamanho da posição com sinal, em moedas (negativo = short).
positions[].entryPxnumberUSDPreço médio de entrada.
positions[].positionValuenumberUSDValor nocional da posição.
positions[].unrealizedPnlnumberUSDLucro e prejuízo não realizados.
positions[].returnOnEquitynumberfractionPnL não realizado dividido pela margem da posição, como a Hyperliquid o reporta (0.13 = 13 %).
positions[].liquidationPxnumber|nullUSDPreço de liquidação estimado.
positions[].leverageobject—Alavancagem da posição.
positions[].leverage.typestring—Tipo.
positions[].leverage.valuenumber—Valor.
positions[].marginUsednumberUSDMargem usada pela posição.
positions[].fundingSinceOpennumberUSDFinanciamento acumulado desde a abertura da posição, na convenção de sinais da Hyperliquid (positivo = pago, negativo = recebido); 0 quando não publicado.

Gerada 2026-11-11 23:00 UTC a partir de 1 respostas reais.

Exemplo de resposta

/api/hl/address/0x5b5d51203a0f9079f8aeb098a6523a13f298c060 · Resposta real capturada 2026-11-13 03:58:26 UTC. Arrays e mapas longos são encurtados para exibição: positions tinha 23 itens.

  • {
    • "success": true,
    • "updated": 1794542306834,
    • "accountValue": 72245515.006981,
    • "totalNtlPos": 333028862.928831,
    • "totalMarginUsed": 72245515.006981,
    • "withdrawable": 0,
    • "positions": [
      • { … 10 },
      • { … 10 }
      ]
    }

Detalhes

Autenticação
Nenhuma. Endpoint público.
Limite de requisições
1200 requisições por minuto por IP
Cache do servidor
Sem cache
Frequência de atualização
tempo real a cada requisição, sem cache
Fontes de dados
Estado da conta ao vivo (resumo de margem e posições abertas) de qualquer endereço Hyperliquid, repassado da API info oficial da Hyperliquid.
Cobertura de corretoras
Qualquer endereço 0x válido
Paginação
nenhuma
Unidades
USD; position sizes in coin units
Timestamps
Milissegundos da época Unix (UTC), salvo se a descrição do campo indicar o contrário
Formato da resposta
json
Estabilidade
Estável

Status ao vivo

DisponívelVerificado 2026-11-13 03:58:26 UTCHTTP 200101 msEsquema confereDado mais recente: há 0s

Disponibilidade, últimos 30 dias

100% de 409 verificações aprovadas

Erros

As chamadas com falha têm o mesmo formato em todos os endpoints. A lista completa está na página de erros. Erros e limites de requisições →

CódigoHTTPSignificadoO que fazer
INVALID_PARAM400Falta um parâmetro obrigatório ou um valor não é aceito. `param` indica o nome do parâmetro quando ele é conhecido.Não repita a requisição sem alterações; corrija-a.
UNAUTHORIZED401O cabeçalho `CB-API-KEY` foi enviado, mas a chave é desconhecida ou foi revogada. Dados públicos não exigem chave — remova o cabeçalho ou use uma chave válida.Não repita a requisição sem alterações.
FORBIDDEN403A rota não faz parte da API pública (é interna ou exclusiva de conta).Não tente novamente.
NOT_FOUND404Rota desconhecida, ou a moeda / corretora / fundo solicitado não existe.Não tente novamente; confira o caminho e os identificadores no catálogo.
RATE_LIMITED429Mais requisições do que o limite por minuto. `Retry-After` informa os segundos a aguardar.Aguarde `Retry-After` e então tente novamente com backoff.
INTERNAL500Erro inesperado do servidor. A mensagem é genérica de propósito; cite `request_id` ao reportá-lo.Tente novamente uma vez após alguns segundos; se persistir, reporte-o com o ID da requisição.
UPSTREAM_FAILED503A fonte de dados por trás deste endpoint não respondeu a tempo. Nenhum número desatualizado ou substituto é retornado em seu lugar.Tente novamente com backoff; consulte a página de status.
UNAVAILABLE501 / 503O conjunto de dados ainda não está pronto temporariamente (aquecimento do cache) ou o endpoint ainda não tem uma fonte pública lícita.Tente novamente mais tarde; o catálogo marca os endpoints que são indisponíveis por design.
REQUEST_FAILED200Alguns endpoints mais antigos respondem HTTP 200 com `success: false`. Verifique sempre `success`, não apenas o status HTTP.Depende da mensagem; trate como uma requisição com falha.

Experimente

GET/api/hl/address/:addrDisponível
Parâmetros

string — 0x-prefixed 40-hex address; 400 on bad format.

URL da requisiçãohttps://www.coinboss.com/api/hl/address/0x5b5d51203a0f9079f8aeb098a6523a13f298c060
Escolha um endpoint e clique em “Enviar requisição”. A resposta, os cabeçalhos e o tempo de resposta aparecerão aqui.