Documentation

Annuler

TradingAuthentification requise

Annulez un contrat actif en fournissant l’ID du contrat. Le paramètre loginid est supprimé ; la réponse reste inchangée.

Comparaison rapide

AspectLegacy APINew APIAction
Point de terminaisoncancelcancelAucun
Authentification requiseOuiOuiAucun
loginid paramètreFacultatifSuppriméRetirer des requêtes

Modifications majeures

1. loginid paramètre supprimé

Dans l’API Legacy, loginid sélectionnait le compte depuis lequel annuler le contrat lorsque vous aviez autorisé plusieurs comptes. La nouvelle API ne l’accepte pas.

Modification requise : Supprimez loginid de vos requêtes cancel . Votre token sélectionne le compte.

Structure de la demande

Legacy APIexemple de demande
{
  "cancel": 11542203588,
  "loginid": "CR123456",
  "passthrough": {
    "user_action": "manual_cancel"
  },
  "req_id": 1
}
New APIexemple de demande
{
  "cancel": 11542203588,
  "passthrough": {
    "user_action": "manual_cancel"
  },
  "req_id": 1
}

Structure de réponse

Legacy APIexemple de réponse
{
  "cancel": {
    "balance_after": 10450.5,
    "contract_id": 11542203588,
    "reference_id": 11542203587,
    "sold_for": 23.45,
    "transaction_id": 11542203589
  },
  "echo_req": {
    "cancel": 11542203588,
    "passthrough": {
      "user_action": "manual_cancel"
    },
    "req_id": 1
  },
  "msg_type": "cancel",
  "req_id": 1
}
New APIexemple de réponse
{
  "cancel": {
    "balance_after": 10450.5,
    "contract_id": 11542203588,
    "reference_id": 11542203587,
    "sold_for": 23.45,
    "transaction_id": 11542203589
  },
  "echo_req": {
    "cancel": 11542203588,
    "passthrough": {
      "user_action": "manual_cancel"
    },
    "req_id": 1
  },
  "msg_type": "cancel",
  "req_id": 1
}

Exemples de code

function cancelContract(contractId, loginId) {
  const request = { cancel: contractId, req_id: 1 };
  // Needed only when you authorised several accounts
  if (loginId) request.loginid = loginId;
  ws.send(JSON.stringify(request));

  ws.onmessage = (message) => {
    const response = JSON.parse(message.data);
    if (response.msg_type !== "cancel") return;
    if (response.error) {
      console.error(response.error.message);
      return;
    }
    if (response.cancel) {
      console.log("Sold for: " + response.cancel.sold_for);
      console.log("New balance: " + response.cancel.balance_after);
    }
  };
}
Click to open live chat support. Get instant help from our support team.