Perguntas frequentes da API OKX
A que se refere a frase-passe?
Esta é a palavra-passe que preencheste ao solicitar a chave de API. Precisas de a memorizar. Se a esqueceres, não poderás recuperá-la e terás de criar uma nova chave de API.
Como crio uma chave de API?
Na app:
1. Inicia sessão na tua Conta OKX > Seleciona Menu (⋮⋮⋮) > Desce e seleciona chave de API > Criar chave de API
2. Preenche o nome da API > Seleciona a conta e o propósito > Introduz a lista de permissões de endereços IP > Seleciona as permissões > Introduz a frase de segurança
Na web:
1. Inicia sessão na tua Conta OKX > Vai ao teu Perfil e seleciona API e ligações > Criar chave de API
2. Preenche o nome da chave de API > Seleciona conta e utilizado para
3. Introduz a lista de permissões de endereços IP > Seleciona Permissões > Introduz a Frase de segurança
Nota:
Os endereços IP ajudam a proteger a tua chave de API. Podes associar até 20 endereços por chave, separando-os por vírgula ou espaço.
É necessário veres as informações da API e aceder à sua interface. Por favor, mantém a tua palavra-passe segura. Podes criar uma nova API se perderes a palavra-passe, pois não conseguimos recuperar APIs.
Como é que geres ou editas a chave de API?
Para gerir ou editar a tua chave de API na OKX:
Inicia sessão na tua Conta OKX e vai a Perfil > API.
Verás uma lista das tuas chaves API existentes. Clica na que queres gerir.
A partir daqui podes:
Consulta o nome da chave de API, permissões e lista branca de IPs associada.
Edita o nome da chave, permissões (Ler, Trading, Levantar) ou endereços IP associados.
Elimina a chave se já não for necessária.
Nota: Não podes ver a frase-passe após a criação inicial. Se a perderes, terás de eliminar a chave existente e criar uma nova. Guarda sempre as tuas credenciais de forma segura.
Como é que diferencio entre trading à vista ou trading com margem se faço transações usando API?
A forma como o trading à vista e o trading com margem são diferenciados via API pode variar consoante o tipo de conta e as definições. Recomendamos consultar a documentação da API OKX para obter os parâmetros mais precisos e atualizados aplicáveis à configuração da tua conta.
Se precisares de mais esclarecimentos, contacta o OKX Assistant para obteres orientação personalizada.
Como crio uma chave de API para disco de demonstração?
Para fazer transações na demo disk API, precisas de criar uma chave de API na demo disk. Segue os passos abaixo:
Inicia sessão na tua 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 vai expirar?
As chaves API que não estão vinculadas a IP e que têm 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 consultar o saldo da conta, dados de faturação ou colocar ordens.
Só as chaves API de leitura apenas, vinculadas a um IP ou permissões específicas, não expirarão.
O que são as permissões de Empréstimo, Ganhar e transferir?
Transferir: Permite à chave transferir fundos entre as tuas contas. Disponível para todas as contas.
Empréstimo: Permite que a chave peça empréstimos, amortize e gere empréstimos. Só visível se a tua conta tiver a elegibilidade necessária para esta funcionalidade.
Ganhar: Permite que a chave subscreva e resgate produtos Ganhar. Visível apenas se a tua conta tiver a elegibilidade necessária para esta funcionalidade.
Se a tua API Key tinha anteriormente as 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 colocar ordens em unidades de moeda ao fazer ordens através da interface?
Não; para ordens de contrato, a interface apresenta por defeito as ordens em número de contratos. Se precisares de calcular a conversão entre o número de contratos e moedas, podes 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 calculado 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 K-line há 24 horas/100% do preço de abertura da K-line 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?
Precisas de verificar primeiro o modo de conta; modo de compra e venda/modo de abertura e fecho, que podes consultar 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 fecho, 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?
Podes 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?
Podes usar diretamente a interface para obteres a informação básica dos produtos de trading aqui.
Como definir stop loss e take profit?
Se a ordem estiver associada a take profit stop loss, podes consultar a interface de ordens aqui: parâmetros do array attachAlgoOrds.
No entanto, se for um stop loss de ordem separada, podes 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; 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. Precisas de chamar a interface de tempo do sistema aqui para sincronizar a tua 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 da 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 da 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 teu modo de conta. Se quiseres colocar alavancagem numa única moeda ou contrato, precisas de ajustar para um dos outros três modos, exceto o modo à vista! Podes configurá-lo através das definições da interface aqui, ou podes configurá-lo na web ou na app.
Nota: a primeira configuração deve ser feita na página ou app; 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últiplas 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"; porque é que a verificação da lista de permissões ainda apresenta um erro quando está fechada 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 por 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 esgotado na solicitação do ponto final da API" (não significa que a solicitação foi bem-sucedida ou falhou, por favor verifica o resultado da solicitação)?
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 o erro 50004 ocorrer noutros momentos, pode ser tentado novamente mais tarde. Se uma ordem for colocada com o erro 50004, isso não representa o resultado real do pedido da interface. O pedido pode ter sucesso ou falhar. Por favor, consulta o resultado real.
O que significa o erro "50119 API key não existe"?
Este erro ocorre normalmente quando o domínio da tua conta não corresponde à tua região.
Para utilizadores do EEE, por favor altera o nome de domínio do teu pedido API para eea.okx.com em vez de www.okx.com.
Para utilizadores dos EUA, por favor altera o nome de domínio do teu pedido API para us.okx.com em vez de www.okx.com.
Se estiveres a usar um software de terceiros para te ligares à OKX e vires este erro, verifica 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 a software de terceiros. Tenta solicitar o tipo de transação da chave de API, sem associar uma lista de IP, e depois reconectar o software de terceiros.
Como obtenho o preço da transação mais recente de um determinado par de moedas?
Usa os detalhes aqui para os Ticker e para o Ticker individual, usa aqui. A interface de Ticker é usada para obter o preço da última transação de pares de moedas em lotes, e o Ticker é usado para obter o preço da última transação de pares de moedas individuais.
Exemplo do parâmetro de resposta do último preço transacionado na secção de 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 principais 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 desligar-se?
Confirma que estás a usar o URL WebSocket correto para o teu site e serviço API. Verifica a tua rede, proxy, definições TLS, parâmetros de subscrição, heartbeat Ping/Pong e lógica de reconexão. Se o problema continuar, fornece o canal, hora da ocorrência, mensagem de erro completa e registos anonimizados.
Como devo resolver um código de erro de API ou um parâmetro de pedido inválido?
Consulta o código de erro na documentação oficial da API do teu site, depois verifica o ponto final, o método HTTP, os parâmetros do pedido, o modo de conta e as restrições do produto. Se a causa continuar pouco clara, fornece o código de erro completo, sCode/sMsg, hora da ocorrência e o pedido e resposta com dados confidenciais ocultados.
Por que é que a colocação, alteração ou cancelamento da minha ordem via API falhou?
Por favor, utiliza a mensagem de erro e o código de erro devolvidos pela API para determinar a causa específica. Se não tiveres a certeza do que significa o erro, fornece os parâmetros completos do pedido e os detalhes do erro para que possamos investigar mais a fundo.
O que devo fazer se os dados de mercado, os gráficos de velas ou os dados do livro de ordens parecerem incorretos?
Confirma o nome do canal, instId, parâmetros de subscrição e frequência do pedido, e distingue os dados de snapshot das atualizações incrementais. Para livros de ordens, verifica também os IDs de sequência e os carimbos de data/hora. Se parecer que faltam dados, regista o canal, o intervalo de tempo e a resposta bruta censurada.
Por que é que os saldos, posições ou valores de margem da API diferem do website ou da app?
Primeiro distingue entre a conta de trading e a conta de financiamento, depois verifica o modo de conta, a dimensão da moeda, o ponto final e a hora de atualização dos dados. Para os cálculos de saldo, posição e margem, usa 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?
Verifica as permissões da API, a moeda, a rede, a conta de destino e quaisquer requisitos de lista de endereços ou lista branca, depois resolve o problema usando o código de erro retornado. Restrições de segurança da conta, conformidade ou risco podem exigir uma análise adicional pelo suporte do site aplicável.
Como crio e uso uma chave de API para uma subconta?
Cria a chave de API na subconta pretendida e usa as permissões, a Passphrase e o domínio do site dessa subconta. Não mistures 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?
Reduz a taxa de pedidos de acordo com o limite para o ponto final específico e utiliza filas de pedidos, recuo 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 assumes que todos os pontos finais partilham a mesma autorização.
Onde posso encontrar documentação da API, SDKs e exemplos de código?
Podes 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”?
Fornece o ponto final, método HTTP, operação pretendida, código ou mensagem de erro completa, hora da ocorrência, site da conta, ambiente da rede e pedido e resposta anonimizados. Nunca envies 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 tiveres mais alguma dúvida, estás convidado a juntar-te ao nosso grupo de suporte API:
O que devo fazer se a Demo Trading API devolver o código de erro 50123?
O código de erro 50123 significa que a chave de API não tem permissão para fazer transações de cripto. Para o trading de demonstração, usa uma chave de API criada para trading de demonstração, certifica-te de que a chave tem permissão de transação, usa o domínio de API correto para o teu site e inclui x-simulated-trading: 1 em cada pedido de trading simulado. Uma chave com apenas permissão de leitura pode obter dados da conta, mas não pode colocar ordens.
O que devo fazer se uma ordem Demo à vista retornar HTTP 503 e o código de erro OKX 50001?
O código de erro 50001 com HTTP 503 significa que o serviço está temporariamente indisponível. Por favor, tenta novamente mais tarde. Se o erro persistir, junta-te ao nosso grupo de suporte API para contactares o API CS.
Nota:
Se tens dúvidas sobre WebSocket ou outros temas relacionados com API, clica no link do artigo e digitaliza o QR code no final do artigo usando a aplicação da OKX para entrares no grupo e contactares o nosso especialista de suporte API.
Como escanear: na app, clica em Menu > no ícone de Scan e escaneia o QR code.