Perguntas frequentes da API OKX

Publicado a 20/09/2024Atualizado a 27/08/2026Leitura de 16 minutos

A que se refere a Frase-Passe?

Esta é a palavra-passe que preencheu ao solicitar a chave de API. Precisa de a memorizar. Se a esquecer, não poderá recuperá-la e terá de criar uma nova chave de API.

Como crio uma chave de API?

Na App:

1. Inicie sessão na sua Conta OKX > Selecione Menu (⋮⋮⋮) > Desça e selecione API > Criar chave de API

2. Preencha o nome da API > Selecione a conta e o propósito > Insira a lista de permissões de endereços IP > Selecione as permissões > Insira a frase de segurança

Na Web:

1. Inicie sessão na sua Conta OKX > Vá ao seu Perfil e selecione API e ligações > Criar chave de API

2. Preencha o nome da chave de API > Selecione Conta e Utilizado para

3. Introduza a lista de permissões de endereços IP > Selecione Permissões > Introduza a Frase de segurança

Nota:

  • Os endereços IP ajudam a proteger a sua chave de API. Pode associar até 20 endereços por chave, separando-os por vírgula ou espaço.

  • É necessário visualizar as informações da API e aceder à sua interface. Por favor, mantenha a sua palavra-passe segura. Pode criar uma nova API se perder a palavra-passe, pois não podemos recuperar APIs.

Como posso gerir ou editar a chave de API?

Para gerir ou editar a sua chave de API na OKX:

  1. Inicie sessão na sua Conta OKX e vá a Perfil > API.

  2. Verá uma lista das suas chaves API existentes. Clique naquela que deseja gerir.

  3. A partir daqui, pode:

    • Visualize o nome da chave de API, permissões e lista branca de IPs vinculados.

    • Edite o nome da chave, permissões (Ler, Trading, Levantar) ou endereços IP vinculados.

    • Eliminar a chave se já não for necessária.

Nota: Não pode visualizar a Frase-Passe após a criação inicial. Se a perder, terá de eliminar a chave existente e criar uma nova. Guarde sempre as suas credenciais de forma segura.

Como posso diferenciar entre trading à vista ou trading com margem se eu negociar usando API?

A forma como o trading à vista e o trading com margem são diferenciados através da API pode variar dependendo do seu tipo de conta e das configurações. Recomendamos consultar a documentação da API OKX para obter os parâmetros mais precisos e atualizados aplicáveis à configuração da sua conta.

Se precisar de mais esclarecimentos, contacte o OKX Assistant para obter orientação personalizada.

Como criar uma chave de API para disco de demonstração?

Para realizar transações na API do disco de demonstração, precisa criar uma chave de API no disco de demonstração. Siga os passos abaixo:

Inicie sessão na sua Conta OKX > Trading > trading de demonstração > Centro Pessoal > Criar chave de API da Conta de Demonstração > Começar trading de demonstração

A chave de API irá expirar?

As chaves API que não estão vinculadas a IP e que possuem permissões de transação ou levantamento serão automaticamente eliminadas após 14 dias de inatividade. As chaves API não serão consideradas inativas se forem usadas para aceder a interfaces privadas ou relacionadas com a conta que exigem verificação de identidade, como visualizar o saldo da conta, dados de faturação ou realizar ordens.

Apenas as chaves API de leitura que estejam vinculadas a um IP ou a permissões específicas não expirarão.

Quais são as permissões de Empréstimo, ganhar e transferir?

  • Transferir: Permite a chave transferir fundos entre as suas contas. Disponível para todas as contas.

  • Empréstimo: Permite ao titular pedir empréstimo, amortizar e gerir empréstimos. Visível apenas se a sua conta tiver a elegibilidade necessária para esta funcionalidade.

  • Ganhar: Permite que a chave subscreva e resgate produtos Ganhar. Visível apenas se a sua conta tiver a elegibilidade necessária para esta funcionalidade.

Se a sua Chave API tinha anteriormente permissões de Trading ativadas, as três permissões serão automaticamente ativadas com esta atualização. Não é necessário configurar manualmente.

É possível fazer ordens em unidades de moeda ao colocar ordens através da interface?

Não; para ordens de contratos, a interface define por padrão ordens em número de contratos. Se precisar calcular a conversão entre o número de contratos e moedas, pode consultar a interface de conversão de contratos para moedas aqui.

Como obter a taxa de flutuação da interface?

A interface não pode obter diretamente o aumento ou diminuição do preço, mas pode ser calculada através de uma fórmula de cálculo.

O valor de subida e descida do preço da última transação comparado com o preço de abertura da linha K há 24 horas / 100% do preço de abertura da linha K há 24 horas.

Os dados da fórmula acima podem ser obtidos através da interface de mercado aqui.

Qual é a razão da mensagem de erro "51000 Parameter posSide error" ao colocar uma ordem?

É necessário verificar primeiro o modo de conta; modo de compra e venda/modo de abertura e fecho, que pode ser consultado aqui para obter posMode.

Nota:

  • No caso de abrir e fechar posições e colocar ordens usando um contrato, o parâmetro posSide é obrigatório, e deve ser preenchido com longa ou curta.

  • Se for um modo de compra e venda, ou uma transação de criptomoeda ou alavancada for realizada no modo de abertura e encerramento, o posSide só suporta líquido ou sem transmissão.

Qual interface pode ser usada para obter o valor nominal do contrato e a quantidade mínima da ordem?

Pode usar a interface para obter informações básicas dos produtos de trading aqui.

valor nominal do contrato: ctVal, quantidade mínima da ordem: minSz.

Qual é o formato do instId?

Pode utilizar diretamente a interface para obter as informações básicas dos produtos de trading aqui.

Como definir stop loss e take profit?

Se a ordem estiver associada a take profit stop loss, pode consultar a interface de ordens aqui: parâmetros do array attachAlgoOrds.

No entanto, se for um stop loss de ordem separado, pode consultar a interface de comissão da estratégia aqui.

Por que é reportado um erro ao definir o preço de desencadeamento para take profit e stop loss: 51046, 51047, 51048, 51049?

Regras para definir o preço de desencadeamento de stop-loss/preço de desencadeamento de take-profit – durante a venda, o preço de desencadeamento de take-profit é superior ao preço da última transação, e o preço de desencadeamento de stop-loss é inferior ao preço da última transação; enquanto durante a compra, o preço de desencadeamento de take-profit é inferior ao preço da última transação, e o preço de desencadeamento de stop-loss é superior ao preço da última transação.

O que significa "Erro de interface: 50102 Pedido de timestamp expirado"?

Este erro ocorre quando o carimbo de data/hora expirou. É necessário chamar a interface de tempo do sistema para sincronizar a sua hora local com a hora do nosso servidor. Manter a diferença de tempo dentro de 30 segundos pode ajudar a evitar este problema.

Nota: a hora no cabeçalho do pedido está em UTC0. Ao chamar a interface de hora do servidor, a hora é fornecida em UTC + 8.

O que significa "Erro de interface: 50101 APIKey não corresponde ao ambiente atual"?

Isto deve-se à incompatibilidade entre a chave de API e o ambiente atual. As chamadas para conta real exigem o uso da chave de API da conta real, e o valor do parâmetro x-simulated-trading no cabeçalho da requisição deve ser 0. As chamadas para conta simulada exigem o uso da chave de API da conta simulada, e o valor do parâmetro x-simulated-trading no cabeçalho da requisição deve ser 1.

O que significa "Erro de interface: 51010 Pedido não suportado no modo de conta atual"?

Isto está relacionado com o seu modo de conta. Se quiser colocar alavancagem ou contrato numa única moeda, precisa de ajustar para um dos outros três modos, exceto o modo à vista! Pode configurá-lo através das definições da interface aqui, ou pode configurá-lo na web ou na app.

Nota: a primeira configuração deve ser definida na página ou na aplicação; opção de configurações no menu principal da página de trading - modo de conta.

O que significa "Erro de interface: 51121 A quantidade da ordem deve ser um múltiplo do tamanho do lote"?

Na API, as ordens de contrato estão em unidades de contratos e devem ser múltiplos da quantidade mínima de ordem do par de moedas. A quantidade mínima de ordem pode ser obtida através do campo minSz da interface do produto aqui.

"Erro de levantamento: 58207 O endereço do levantamento não está na lista de permissões para isenção de verificação"; por que a verificação da lista de permissões ainda reporta um erro quando está desativada na página de levantamento?

Para levantar moedas usando a interface API, é necessário adicionar um endereço do levantamento na página e assinalar o botão "não verificado pelo Visa". Se a verificação da lista de permissões estiver desativada na página, isso não afetará a função da interface.

O que significa "Erro de interface: 50004 tempo limite de pedido do ponto final da API" (não significa que o pedido foi bem-sucedido ou falhou, por favor verifique o resultado do pedido)?

O erro 50004 é geralmente causado por pressão excessiva no servidor. Os horários das 8, 16 e 24 horas são os pontos de recolha das taxas de capital todos os dias. Nestes momentos, a pressão no servidor é elevada. Recomenda-se escalonar as transações nestes horários. Se um erro 50004 for reportado em outros momentos, pode ser tentado novamente mais tarde. Se uma ordem for colocada com um erro 50004, isso não representa o resultado real do pedido da interface. O pedido pode ter sucesso ou falhar. Por favor, consulte o resultado real.

O que significa o erro "50119 API key não existe"?

Este erro geralmente ocorre quando o domínio da sua conta não corresponde à sua região.

  • Para utilizadores da EEE, por favor altere o nome de domínio do seu pedido API para eea.okx.com em vez de www.okx.com.

  • Para utilizadores dos EUA, por favor altere o nome de domínio do seu pedido API para us.okx.com em vez de www.okx.com.

  • Se estiver a usar um software de terceiros para se ligar à OKX e vir este erro, por favor verifique com o fornecedor do software se suporta domínios regionais. Por exemplo, os utilizadores da EEE devem ligar-se através de eea.okx.com, caso contrário o pedido irá falhar.

Por que aparece o erro "50110" ao ligar a um software de terceiros?

Este erro pode ocorrer se o tipo atual de chave de API não for compatível com a ligação de software de terceiros. Tente solicitar o tipo de transação da chave de API, sem vincular uma lista de IP, e depois reconecte o software de terceiros.

Como posso obter o preço da transação mais recente de um determinado par de moedas?

Use os detalhes aqui para os símbolos ticker e para o símbolo ticker, aqui. A interface de símbolos ticker é usada para obter o preço da transação mais recente de pares de moedas em lotes, e o símbolo ticker é usado para obter o preço da transação mais recente de pares de moedas individuais.

Exemplo do parâmetro de resposta do último preço transacionado na secção Símbolos ticker

Quais são os requisitos para criar uma chave de API?

É necessário um saldo mínimo de 100 USD em Ativos Sob Gestão (AUM) para criar uma chave de API.

  • É necessário um AUM superior a 100 USD (AUM > 100U) para criar uma chave de API

  • Para contas master ou subcontas, apenas contas com AUM > 100U podem criar chaves API

Nota: Este requisito aplica-se apenas a utilizadores em determinadas áreas

O que devo fazer se o WebSocket não conseguir conectar ou continuar a desconectar?

Confirme que está a usar o URL WebSocket correto para o seu site e serviço API. Verifique a sua rede, proxy, definições TLS, parâmetros de subscrição, o sinal Ping/Pong e a lógica de reconexão. Se o problema persistir, forneça o canal, a hora da ocorrência, a mensagem de erro completa e os registos anonimizados.

Como devo resolver um código de erro de API ou um parâmetro de pedido inválido?

Consulte o código de erro na documentação oficial da API do seu site, depois verifique o ponto final, o método HTTP, os parâmetros da solicitação, o modo de conta e as restrições do produto. Se a causa ainda não estiver clara, forneça o código de erro completo, sCode/sMsg, hora da ocorrência e a solicitação e resposta com dados confidenciais ocultados.

Por que é que a colocação, alteração ou cancelamento da minha ordem via API falhou?

Por favor, utilize a mensagem de erro e o código de erro retornados pela API para determinar a causa específica. Se não tiver certeza do que o erro significa, forneça os parâmetros completos da solicitação e os detalhes do erro para que possamos investigar mais a fundo.

O que devo fazer se os dados de mercado, gráficos de velas ou dados do livro de ordens parecerem incorretos?

Confirme o nome do canal, instId, parâmetros de subscrição e frequência do pedido, e distinga os dados de snapshot das atualizações incrementais. Para livros de ordens, verifique também os IDs de sequência e os carimbos de data/hora. Se parecer que faltam dados, registe o canal, o intervalo de tempo e a resposta bruta redigida.

Por que os saldos, posições ou valores de margem da API diferem do site ou da aplicação?

Primeiro, distinga entre a conta de trading e a conta de financiamento, depois verifique o modo de conta, a dimensão da moeda, o ponto final e o tempo de atualização dos dados. Para os cálculos de saldo, posição e margem, utilize a documentação mais recente do produto e da API para o site aplicável.

O que devo fazer se um depósito, levantamento ou transferência via API falhar?

Verifique as permissões da API, moeda, rede, conta de destino e quaisquer requisitos de lista de endereços ou lista branca, depois resolva problemas usando o código de erro retornado. Restrições de segurança da conta, conformidade ou risco podem exigir uma revisão adicional pelo suporte para o site aplicável.

Como criar e usar uma chave de API para uma subconta?

Crie a chave de API na subconta pretendida e utilize as permissões, a Passphrase e o domínio do site dessa subconta. Não misture a chave de API, o Secret ou a Passphrase da conta principal com os da subconta.

O que devo fazer após atingir o limite de taxa da API?

Reduza a taxa de pedidos de acordo com o limite para o ponto final específico e utilize filas de pedidos, retrocesso exponencial ou pontos finais em lote quando apropriado. O âmbito e a quota do limite de taxa podem diferir consoante o ponto final, por isso não presuma que todos os pontos finais partilham a mesma autorização.

Onde posso encontrar documentação da API, SDKs e exemplos de código?

Pode consultar a Documentação da API (V5). Referência REST + WebSocket, registo de alterações, códigos de erro, exemplos de pedidos/respostas por ponto final. SDKs oficiais (GitHub) — github.com/okxapi Exemplo de código disponível no SDK.

Que informações devo fornecer se só puder dizer "a API não está a funcionar"?

Forneça o ponto final, método HTTP, operação pretendida, código de erro completo ou mensagem, hora da ocorrência, site da conta, ambiente da rede e pedido e resposta anonimizados. Nunca envie um API Secret, Passphrase, código de verificação ou assinatura não anonimizados.

O que devo fazer se ainda tiver dúvidas sobre a API? Ou posso conversar com o suporte da API?

Se tiver mais alguma dúvida, está convidado a juntar-se ao nosso grupo de suporte API:

Nota:

Se tiver dúvidas sobre WebSocket ou outros temas relacionados com API, clique no link do artigo e escaneie o QR code no final do artigo usando a aplicação da OKX para entrar no grupo e contactar o nosso especialista de suporte API.

Como escanear: na app, toque em Menu > no ícone de Scan e escaneie o QR code.