REST API

Ver como Markdown

Pontos Finais Públicos

EndpointMétodoCaminhoDescrição
Versão de serviçoGET/v1/versionObtenha informações sobre a versão do serviço
Tempo do servidorGET/v1/timeTenha tempo no servidor
Login do usuárioPOST/v1/public/user/loginUse nome de usuário e senha para obter accessToken
Token de AtualizaçãoPOST/v1/public/user/refresh-tokenAtualizar o estado de login via Cookie
Troca de ingressos para agentePOST/v1/public/agent-sso/exchange-ticketTroque um ticket de entrada de agente pelo estado de login
Troca de Token de Incorporação de AgentePOST/v1/public/agent-sso/exchange-embed-tokenTroque um token de negociação embutido de curta duração por um estado de login
Configuração de símbolosGET/v1/public/market/symbolsObtenha símbolos, regras de negociação e configuração de níveis de taxas
Configuração das taxas de financiamentoGET/v1/public/market/funding-rateConsulta à configuração da taxa de financiamento
Taxa atual de financiamentoGET/v1/public/market/funding-rate/currentPaginar as taxas atuais de financiamento
Histórico das taxas de financiamentoGET/v1/public/market/funding-rate/historyConsultar histórico de taxas de financiamento
KlinesGET/v1/public/market/klinesConsultar preço de negociação, preço de índice ou marcar preço Klines
Tabela de líderes da PnLGET/v1/public/leaderboard/pnlConsulta tabela de classificação PnL de 7 / 30 / 90 dias

Endpoints de Usuários Privados

A menos que especificado de outra forma, os seguintes endpoints podem usar JWT ou API Key assinatura.

EndpointMétodoCaminhoPermissãoDescrição
Informações do usuárioGET/v1/private/user/infoLeiaConsultar o perfil atual do usuário
Ativos do usuárioGET/v1/private/user/assetLeiaConsultar saldo da carteira e uso da margem
Crie listenKeyPOST/v1/private/user/listen-keyLeiaCriar chave de autenticação WebSocket privada
Renovar listenKeyPUT/v1/private/user/listen-keyLeiaEstenda listenKey validade
Fechar listenKeyDELETE/v1/private/user/listen-keyLeiaFechar listenKey
Registros de alteração de contaGET/v1/private/user/account-change-logLeiaConsultar registros de movimento de fundos
Estatísticas de volume em 30 diasGET/v1/private/user/volume-statsLeiaConsultar o volume e as taxas de negociação recentes de 30 dias
Histórico do balançoGET/v1/private/user/balance-historyLeiaHistórico de balanceamento de consultas
Visão geral do comércioGET/v1/private/user/trade-overviewLeiaConsultar PnL, volume e tendência de ativos
Resumo da visão geral dos ativosGET/v1/private/user/asset/overview/summaryLeiaConsultar métricas de resumo de ativos
Tendência geral dos ativosGET/v1/private/user/asset/overview/trendLeiaConsultar tendência de ativos
Salvar símbolos favoritosPOST/v1/private/user/favorite-symbolsLeiaSobrescrever símbolos favoritos
Obtenha símbolos favoritosGET/v1/private/user/favorite-symbolsLeiaConsultar símbolos favoritos
DesconectarPOST/v1/private/user/logoutJWT + CookieLimpar estado de login

API Key Endpoints de Gerenciamento

API Key endpoints de gerenciamento aceitam apenas JWT.

EndpointMétodoCaminhoDescrição
Crie API KeyPOST/v1/private/user/api-key/createCrie API Key; apiSecret é retornado apenas uma vez
API Key listaGET/v1/private/user/api-key/listConsultar as chaves de API do usuário atual
Atualização API KeyPUT/v1/private/user/api-key/updateAtualize o rotulo, permissões, IP lista branca e status
Exclua API KeyPOST/v1/private/user/api-key/deleteExclua um API Key especificado
Exclua todas as API ChavesPOST/v1/private/user/api-key/delete-allExclua todas as API Chaves do usuário atual

Ordem Extremos

Endpoints de ordens exigem permissão de troca.

EndpointMétodoCaminhoDescrição
Consulta em ordem únicaGET/v1/private/orderConsulta exata por symbol + orderId/clientOrderId
Ordem de colocaçãoPOST/v1/private/order/placeOrdem limite ou de mercado
Ordem de condição de lugarPOST/v1/private/order/place-conditionStop loss, take profit, trailing stop e outras ordens de condição
Coloque a ordem da estratégiaPOST/v1/private/order/place-strategyOTO / OCO / OTOCO ordem de estratégia
Faça pedidos em lotePOST/v1/private/order/batch-placeEnvie múltiplos pedidos normais
Cancelar pedidoPOST/v1/private/order/cancelCancelar uma ordem normal especificada
Ordem de alteraçãoPOST/v1/private/order/moveModificar o preço e a quantidade normais de ordem pendente
Ordens de retificação em lotePOST/v1/private/order/batch-moveModificação em lote de ordens normais pendentes para o mesmo símbolo
Pedidos de cancelamento por lotePOST/v1/private/order/batch-cancelCancelar pedidos normais em lote
Cancelar tudoPOST/v1/private/order/batch-cancel-allCancelamento de pedidos em lote por tipo
Ordem de cancelar condiçãoPOST/v1/private/order/cancel-conditionCancelar uma ordem de condição especificada
Ordens normais atuaisGET/v1/private/order/currentConsultar ordens normais pendentes atuais
Ordens de condição atualGET/v1/private/order/current-conditionConsultar ordens de condição não acionadas atuais
Ordens normais históricasGET/v1/private/order/historyPaginar ordens normais históricas
Ordens de condição históricaGET/v1/private/order/history-conditionPaginar ordens de condição histórica
Recordes de trocasGET/v1/private/order/tradesPaginar registros de troca
Detalhe da ordem da estratégiaGET/v1/private/order/strategyOrdem da estratégia de consulta e subordens

Pontos de Ponta de Posição

Os endpoints de posição exigem permissão de troca.

EndpointMétodoCaminhoDescrição
Definir modo margemPOST/v1/private/position/margin-modeInterruptor isolado / margem cruzada
Alavancagem de conjuntoPOST/v1/private/position/leverageAlavancagem de símbolo de conjunto
Configurações de posiçãoGET/v1/private/position/settingsAlavancagem de consulta e modo margem para um símbolo
Cargos atuaisGET/v1/private/position/positionsConsultar posições atuais
Histórico da posiçãoGET/v1/private/position/historyConsultar posições históricas e fechar registros

Grupos de pontos finais