For the complete documentation index, see llms.txt. This page is also available as Markdown.

APIs e limites

O gateway REST e WebSocket: URL base, autenticação e o modelo de limite de requisições.

A Nexus Exchange é API-first. Tudo o que um trader pode fazer está disponível via REST e WebSocket: abastecer uma conta, enviar e cancelar ordens, consultar posições, fazer streaming do livro de ofertas. O frontend web é uma visualização somente leitura, e o acesso programático é a interface principal.

URL base

https://api.testnet.nexus.xyz/v1

Esta é a base pública da testnet. Ela substitui https://exchange.nexus.xyz/api/exchange, que retornava HTTP 500 nos caminhos da API quando verificado em 2026-09-28. A mainnet está planejada em https://api.nexus.xyz/v1, um host que ainda não resolve. A especificação OpenAPI legível por máquina é servida em /openapi.json e versionada em nexus-xyz/nexus-exchange-api; as versões são acompanhadas no GitHub Releases.

Modelo de autenticação

Há dois tipos de credencial:

  1. Token de sessão (Bearer). Criado ao assinar uma mensagem fixa com sua carteira Ethereum (EIP-191). Usado apenas para criar e gerenciar chaves de API, nunca para negociar. Expira após 24 horas.

  2. Chave de API (HMAC). Um par key_id + secret. Toda requisição de negociação e de conta é assinada com HMAC-SHA256 sobre uma string canônica da requisição. O segredo é exibido uma única vez na criação e não pode ser recuperado depois.

1. POST /auth/login   (wallet signature)        → session Bearer token
2. POST /keys         (Bearer)                   → API key_id + secret
3. sign each request  (HMAC over canonical str)  → trade

Consulte o Guia rápido para o fluxo completo com cURL executável.

CCXT

A conformidade com CCXT e CCXT-Pro é uma meta declarada da API da Exchange e ainda está sendo construída e testada. Na especificação OpenAPI, cada operação que corresponde a um método unificado do CCXT, incluindo o envio de ordens, traz uma anotação x-ccxt-method.

Referência

  • Guia rápido: sua primeira negociação

  • Referência da API REST

  • Referência da API WebSocket

  • Limites de requisições e de conexão

  • Versionamento da API

Status: prévia na testnet. Credenciais, sessões e o estado dos limites de requisições ainda não persistem entre reinicializações do gateway, então trate as chaves de API como recriáveis. O reforço para produção está em andamento.

Atualizado