Documentation
Points de terminaison de compte

Solde

CompteAuthentification requise

Obtenez le solde actuel du compte et, si vous le souhaitez, abonnez-vous aux mises à jour du solde en temps réel. La nouvelle API renvoie uniquement le solde du compte sélectionné par votre token.

Comparaison rapide

AspectLegacy APINew APIAction
Point de terminaisonbalancebalanceAucun
Authentification requiseOuiOuiAucun
account paramètreFacultatifSuppriméRetirer des requêtes
loginid paramètreFacultatifSuppriméRetirer des requêtes
accounts dans la réponseRenvoyé lorsque account est allSuppriméDemandez chaque compte séparément
total dans la réponseRenvoyé lorsque account est allSuppriméAdditionnez vous-même les soldes

Modifications majeures

1. account paramètre supprimé

Dans l’API Legacy, account choisissez le solde à renvoyer : actuel, all ou un ID de connexion spécifique. La New API ne l’accepte pas et renvoie le solde du compte sélectionné par votre jeton.

Modification requise : Supprimez account de vos requêtes balance .

2. loginid paramètre supprimé

Dans l’API Legacy, loginid sélectionnait le compte lorsque vous autorisiez plusieurs comptes. La nouvelle API ne l’accepte pas.

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

3. accounts supprimé de la réponse

La Legacy API renvoyait un objet accounts contenant le solde, la devise, le statut et le type de chaque compte lorsque vous envoyiez account défini sur all. La New API ne le renvoie pas.

Modification requise : Demandez le solde de chaque compte à l’aide du token de ce compte.

4. total supprimé de la réponse

L’API Legacy renvoyait un objet total avec les soldes cumulés pour les comptes réels et démo Deriv et MT5. La New API ne le renvoie pas.

Modification requise : Additionnez vous-même les soldes de vos comptes si vous avez besoin d’un total.

Structure de la demande

Legacy APIexemple de demande
{
  "balance": 1,
  "account": "all",
  "loginid": "CR123456",
  "subscribe": 1,
  "req_id": 1
}
New APIexemple de demande
{
  "balance": 1,
  "subscribe": 1,
  "req_id": 1
}

Structure de réponse

Legacy APIexemple de réponse
{
  "balance": {
    "accounts": {
      "CR123456": {
        "balance": 10000.5,
        "converted_amount": 10000.5,
        "currency": "USD",
        "demo_account": 0,
        "status": 1,
        "type": "deriv"
      }
    },
    "balance": 10000.5,
    "currency": "USD",
    "id": "c84a793b-8a87-7999-ce10-9b22f7ceead3",
    "loginid": "CR123456",
    "total": {
      "deriv": {
        "amount": 10000.5,
        "currency": "USD"
      }
    }
  },
  "echo_req": {
    "balance": 1,
    "account": "all",
    "loginid": "CR123456",
    "subscribe": 1,
    "req_id": 1
  },
  "msg_type": "balance",
  "req_id": 1,
  "subscription": {
    "id": "c84a793b-8a87-7999-ce10-9b22f7ceead3"
  }
}
New APIexemple de réponse
{
  "balance": {
    "balance": 10000.5,
    "currency": "USD",
    "id": "c84a793b-8a87-7999-ce10-9b22f7ceead3",
    "loginid": "CR123456"
  },
  "echo_req": {
    "balance": 1,
    "subscribe": 1,
    "req_id": 1
  },
  "msg_type": "balance",
  "req_id": 1,
  "subscription": {
    "id": "c84a793b-8a87-7999-ce10-9b22f7ceead3"
  }
}

Exemples de code

function getBalances(loginId) {
  ws.send(JSON.stringify({ balance: 1, account: "all", loginid: loginId, subscribe: 1 }));

  ws.onmessage = (event) => {
    const response = JSON.parse(event.data);
    if (response.msg_type !== "balance" || !response.balance) return;

    console.log("Balance:", response.balance.balance, response.balance.currency);
    const accounts = response.balance.accounts ?? {};
    Object.keys(accounts).forEach((id) => {
      console.log("Account " + id + ": " + accounts[id].balance);
    });
  };
}
Click to open live chat support. Get instant help from our support team.