Chaves API

Última atualização: 20 de agosto de 2026

As chaves de API fornecem acesso programático às contas da sua Organização para sistemas automatizados, bots de trading, scripts operacionais, pipelines de relatórios e sessões de trading FIX. Este artigo aborda o modelo de permissões das chaves de API, como as chaves se mapeiam às contas, como a Governança da Organização se aplica às operações iniciadas por chaves e como a própria administração de chaves é governada.

As chaves de API não são Membros com credenciais. Elas seguem um modelo de permissões próprio e mais simples:

Membro

Chave API

Autenticação

Login individual com 2FA

Credenciais da chave de API

Acesso à interface

Sim

Não, somente via API

Modelo de permissões

Perfil de Workflow + Funções de Conta

Permissões da chave de API aplicadas às contas selecionadas

Variação por conta

Sim, as funções podem conceder permissões diferentes em contas diferentes

Não, as permissões da chave se aplicam de forma uniforme a todas as contas selecionadas

Pode iniciar solicitações de saque e transferência

Sim, quando permitido

Sim, quando permitido

Pode aprovar solicitações

Sim, exceto as próprias

Nunca

Fluxos de trabalho administrativos

Sim, conforme o Perfil de Workflow

Nunca

Os dois modelos são intencionalmente separados. Os Membros recebem funções, perfis e granularidade por conta porque pessoas acumulam responsabilidades variadas. As Chaves seguem um modelo simples de escopo e contas porque a automação deve ser restrita, uniforme e fácil de auditar.

Uma chave de API combina duas seleções: o que ela pode fazer (suas permissões) e onde (suas contas).

Permissões

Grupo

Permissão

O que permite

Fundos

Consultar fundos

Ver saldos e status de financiamento

Depositar

Gerar endereços de depósito e ver histórico de depósitos

Retirar

Iniciar solicitações de saque (consulte «Governança e chaves de API»)

Ganhe

Alocar e desalocar produtos Earn

Ordens

Consultar ordens em aberto

Ver ordens em aberto e negociações ativas

Consultar ordens fechadas

Ver histórico de ordens e negociações concluídas

Criar e modificar ordens

Enviar e modificar ordens

Cancelar e fechar ordens

Cancelar ordens em aberto e fechar posições

Endereços

Adicione o endereço de retirada

Iniciar solicitações para adicionar endereços na lista de permissões

Atualizar endereço de retirada

Iniciar solicitações para alterar endereços na lista de permissões

Dados

Consultar ledger

Ver histórico de transações e do ledger

Exportar dados

Exportar dados da conta para relatórios e reconciliação

Mapeamento de contas

Cada chave é mapeada para uma ou mais contas, definidas no momento da criação e editáveis posteriormente. As permissões da chave se aplicam uniformemente a todas as contas selecionadas:

  • Uma chave com Query funds e Create and modify orders em duas contas selecionadas pode consultar saldos e negociar em ambas, sem acessar nada além disso.
  • Não há variação por conta dentro de uma chave. Se a sua automação precisar negociar em uma conta, mas apenas ler outra, use duas chaves. Isso mantém o raio de impacto de cada chave evidente.

Selecione uma conta específica quando necessário

As solicitações privadas de API usam a conta principal da Organização quando account_id é omitido:

bash

Bash

POST /0/private/AddOrder

Para operar em uma conta específica, passe account_id como parâmetro de consulta na URL:

bash

Bash

POST /0/private/AddOrder?account_id=W5PB62NTPNYT6TYH

Passe-o na URL, não no corpo da solicitação. Um account_id explícito tem precedência sobre o fallback da conta principal. Ele não expande o mapeamento de contas nem as permissões da chave. Se a chave não puder operar na conta selecionada, a solicitação será recusada.

Conectividade FIX

Chaves com permissões de ordens suportam conectividade FIX para negociação spot, além das APIs REST e WebSocket. Uma sessão FIX herda as mesmas permissões e mapeamento de contas da chave vinculada: opera apenas nas contas selecionadas por ela, dentro das suas permissões. Empresas que operam fluxo de ordens via FIX geralmente dedicam uma chave por sessão, com escopo nas contas negociadas pela mesa.

Observação:

A negociação via WebSocket em contas diferentes da conta principal ainda não está disponível para chaves de API; por ora, permanece como funcionalidade exclusiva do Proprietário. O fluxo automatizado de ordens em contas adicionais deve usar REST ou FIX. Consulte Disponibilidade e limitações.

Configurações de segurança

Configuração

Description

Validade da chave

Data opcional após a qual a chave deixa de funcionar

Data de início / término da consulta

Restringe as consultas de dados a um intervalo de datas

Conexões WebSocket

Ativar ou desativar o streaming em tempo real

Janela nonce personalizada

Ajuste de proteção contra replay para uso de alta frequência

Restrições de IP

Limitar o uso da chave a endereços IP específicos ou faixas CIDR

Dica:

Conceda a cada chave as permissões mínimas necessárias, o menor número de contas e as restrições de IP mais rígidas para que ela cumpra sua função. Use chaves separadas por sistema – uma para o bot de trading, outra para relatórios – e mantenha as revogações cirúrgicas.

A Governança da Organização se aplica tanto ao que as chaves fazem quanto à forma como são gerenciadas.

O que as chaves fazem

A regra de duas categorias para Membros se aplica às chaves da mesma forma:

  • Operações diretas são executadas imediatamente. Negociação, Earn, consultas de saldo, consultas de ledger e exportações de dados são concluídas imediatamente, dentro das permissões e contas da chave.
  • Operações governadas criam solicitações. Um saque ou alteração de endereço iniciado por uma chave segue o mesmo fluxo de um iniciado por um Membro: a política do workflow define se a operação é concluída imediatamente ou entra na fila de aprovação para revisão.

Uma chave só pode iniciar solicitações governadas. Chaves nunca têm permissão de Aprovação – a segregação de funções exige um Membro humano para cada aprovação, e um script não pode substituir esse julgamento. Quando a política de Solicitação de Saque exige duas aprovações, um saque iniciado por uma chave aguarda dois Membros, exatamente como ocorreria com um iniciado por um Membro.

Uma chamada bem-sucedida não é um saque concluído

Construa sua automação levando em conta essa assincronicidade. WithdrawFunds retorna approval_request_id junto com refid:

bash

Bash

{
  "error": [],
  "result": {
    "refid": "FTcLNGa-4ZWmo4GCo8wrBNZz5v53v9",
    "approval_request_id": "656a021a-1d55-42c9-853a-aea57bf5abd1"
  }
}
  • O refid confirma que a solicitação existe, não que os fundos foram movimentados. O valor é bloqueado na conta de origem no momento do envio e só é liquidado após a aprovação da solicitação. Consulte Fundos bloqueados no momento do envio.
  • O approval_request_id é o identificador da aprovação que o saque aguarda. Armazene-o junto ao seu próprio registro do saque.
  • Saques aguardando aprovação não aparecem em WithdrawStatus. Uma solicitação rejeitada ou que expira não gera nenhum registro de saque, portanto a ausência em WithdrawStatus nunca significa que o saque não foi enviado.

Automações que tratam um refid como prova de conclusão vão reportar saques como liquidados enquanto ainda estão na fila de aprovação, e reconciliações que inferem "ausente em WithdrawStatus, portanto nunca enviado" estarão erradas tanto para solicitações pendentes quanto para as rejeitadas.

As chaves também não têm acesso aos fluxos administrativos. Gerenciar acesso da equipe, chaves de API, contas, endereços (além de iniciar solicitações de endereço) e políticas é exclusivo para Membros.

Como as chaves são gerenciadas

Criar, editar e revogar chaves de API é uma operação governada pelo fluxo dedicado Gerenciar Chaves de API, separado do Gerenciar Equipe e Acesso. Essa separação é importante por dois motivos:

  • Administradores diferentes. Você pode permitir que um engenheiro de operações gerencie chaves sem poder alterar o acesso dos Membros, e vice-versa.
  • Políticas diferentes. O gerenciamento de chaves pode ter seus próprios requisitos de aprovação. Muitas Organizações exigem aprovação independente para criar ou modificar uma chave – uma nova credencial é uma nova via de acesso às suas contas – mantendo a revogação ágil.
  1. Acesse Chaves de API e selecione Criar chave.
  2. Nomeie a chave de acordo com sua finalidade, o sistema que ela atende e o que faz, para que sua função seja evidente em revisões e eventos de segurança.
  3. Selecione as permissões da chave.
  4. Selecione as contas em que a chave vai operar. As permissões se aplicam a todas elas de forma uniforme.
  5. Configure as definições de segurança: expiração, restrições de IP e nonce window.
  6. Revise e confirme. Se a política Gerenciar Chaves de API exigir aprovação, a solicitação ficará pendente até que as aprovações necessárias sejam concluídas e a chave seja emitida.
Atenção:

A edição de permissões ou contas de uma chave e a revogação de uma chave seguem o mesmo fluxo de Governança.

Solução de problemas

A chamada criou uma solicitação de saque, e a política de Solicitação de Saque a mantém aguardando aprovação. Verifique a página Solicitações: a solicitação aparece lá com a chave como iniciadora, aguardando as aprovações necessárias dos Membros. Esse é o modelo de Governança funcionando conforme o esperado: a automação propõe, as pessoas aprovam.

O valor fica bloqueado na conta de origem enquanto a solicitação aguarda aprovação, já reservado para o saque. Acompanhe a solicitação usando o approval_request_id retornado com a chamada.

A conta com falha não está no mapeamento de contas da Chave. Uma Chave opera apenas nas contas selecionadas. Edite a Chave para adicionar a conta. Lembre-se de que o conjunto completo de permissões será aplicado a ela, já que Chaves não têm variação por conta. Se isso for amplo demais, crie uma segunda chave com escopo limitado à nova conta.

Uma única chave não pode ter permissões diferentes por conta. Crie duas Chaves: uma de negociação mapeada para a conta A e uma somente leitura mapeada para a conta B. Chaves com escopo mais restrito também são mais fáceis de auditar e mais seguras de revogar.

O fluxo de trabalho Gerenciar Chaves de API provavelmente exige aprovação, e a solicitação ainda está pendente. A chave é emitida e seu segredo exibido somente após todas as aprovações necessárias serem concluídas. Verifique o status da solicitação na página Solicitações.

Não. A aprovação sempre exige um Membro humano. Esta é uma regra do sistema, não uma política configurável: é o que torna a aprovação multiparticipante relevante quando a automação inicia movimentações de fundos.