Documentação

Esquecer tudo

SubscriçãoSem Autenticação

Cancele a subscrição de todos os streams de um determinado tipo. Sete tipos de stream já não são aceites; a resposta mantém-se inalterada.

Comparação rápida

AspetoLegacy APINew APIAção
Endpointforget_allforget_allNenhum
Autenticação ObrigatóriaNãoNãoNenhum
Tipos de stream14 tipos7 tiposDeixe de enviar tipos removidos

Alterações de rutura

1. Menos tipos de stream aceites

forget_all aceita um tipo de fluxo ou uma matriz de tipos de fluxo. A New API aceita menos tipos e rejeita um pedido que inclua qualquer outro.

  • Já não são aceites: p2p_advert, p2p_advertiser, p2p_order, p2p_settings, trading_platform_asset_listing, website_status e crypto_estimations.
  • Ainda aceites: balance, candles, cashier_payments, proposal, proposal_open_contract, ticks e transaction.

Alteração necessária: Remova dos seus pedidos forget_all os tipos de stream que a New API já não aceita.

Estrutura de pedido

Legacy APIexemplo de pedido
{
  "forget_all": [
    "ticks",
    "proposal"
  ],
  "req_id": 1
}
New APIexemplo de pedido
{
  "forget_all": [
    "ticks",
    "proposal"
  ],
  "req_id": 1
}

Estrutura de resposta

Legacy APIexemplo de resposta
{
  "echo_req": {
    "forget_all": [
      "ticks",
      "proposal"
    ],
    "req_id": 1
  },
  "forget_all": [
    "c84a793b-8a87-7999-ce10-9b22f7ceead3",
    "d1f2e3a4-5b6c-7d8e-9f01-23456789abcd"
  ],
  "msg_type": "forget_all",
  "req_id": 1
}
New APIexemplo de resposta
{
  "echo_req": {
    "forget_all": [
      "ticks",
      "proposal"
    ],
    "req_id": 1
  },
  "forget_all": [
    "c84a793b-8a87-7999-ce10-9b22f7ceead3",
    "d1f2e3a4-5b6c-7d8e-9f01-23456789abcd"
  ],
  "msg_type": "forget_all",
  "req_id": 1
}

Exemplos de código

function stopStreams(types) {
  ws.send(JSON.stringify({ forget_all: types, req_id: 1 }));
}

stopStreams(["ticks", "p2p_order"]);

ws.onmessage = (event) => {
  const response = JSON.parse(event.data);
  if (response.msg_type !== "forget_all") return;
  if (response.error) {
    console.error(response.error.message);
    return;
  }
  if (response.forget_all) {
    console.log("Stopped " + response.forget_all.length + " streams");
  }
};

Alguma outra questão? Entrar em contacto

Click to open live chat support. Get instant help from our support team.