API documentation (FR)

Documentation de l'API - Traderush.co (beta-0.2-api)

Table des Matières

• Introduction

• Authentification

• Endpoints

  • Récupérer un signal spécifique

  • Récupérer le dernier signal

  • Récupérer une liste de signaux

• Codes de réponse HTTP

• Exemples de Requêtes

---

Introduction

L'API Traderush.co fournit un accès en temps réel aux signaux de trading pour divers marchés financiers. Cette documentation explique comment les développeurs peuvent interagir avec l’API pour intégrer des fonctionnalités de trading dans leurs applications. Note : toutes les réponses et l'interface de l'API sont en anglais.

---

Authentification

Toutes les requêtes nécessitent un token d'authentification valide pour accéder à l'API.

Paramètres d'authentification

• token (obligatoire) : Token de session unique requis pour authentifier chaque requête à l'API.

---

Endpoints

Récupérer un signal spécifique

Permet d’obtenir les détails d’un signal de trading en fonction de son identifiant unique.

• URL : /api.php

• Méthode : GET

• Paramètres :

  • token : Token d'authentification (obligatoire)

  • signal_token : Token unique du signal à récupérer (optionnel)

Exemple de requête :

curl -X GET "https://manager.traderush.co/api.php?token=YOUR_TOKEN&signal_token=SIGNAL_TOKEN"

Réponse attendue :

{
    "id": 123,
    "action": "Buy",
    "currency": "CAD/JPY",
    "price": 109.4180,
    "signalType": "Long term",
    "created_at": "2024-11-04 14:44:09"
}

---

Récupérer le dernier signal

Accède au dernier signal émis par le système de Traderush.co.

• URL : /api.php

• Méthode : GET

• Paramètres :

  • token : Token d'authentification (obligatoire)

  • latest : Indicateur pour récupérer le dernier signal (optionnel)

Exemple de requête :

curl -X GET "https://manager.traderush.co/api.php?token=YOUR_TOKEN&latest=true"

Réponse attendue :

{
    "id": 124,
    "action": "Sell",
    "currency": "EUR/USD"
}

---

Récupérer une liste de signaux

Permet de lister plusieurs signaux avec des options de filtrage et de pagination.

• URL : /api.php

• Méthode : GET

• Paramètres :

  • token : Token d'authentification (obligatoire)

  • limit : Nombre de signaux par page (par défaut 50, optionnel)

  • page : Numéro de la page pour la pagination (par défaut 1, optionnel)

  • order_by : Critère de tri (par défaut created_at, optionnel)

  • order_dir : Direction du tri (asc ou desc, par défaut asc, optionnel)

  • start_date : Date de début pour filtrer les signaux (optionnel)

  • end_date : Date de fin pour filtrer les signaux (optionnel)

Exemple de requête :

curl -X GET "https://manager.traderush.co/api.php?token=YOUR_TOKEN&limit=10&page=2&order_by=price&order_dir=desc&start_date=2023-01-01&end_date=2023-12-31"

Réponse attendue :

[
    {
        "id": 125,
        "action": "Buy",
        "currency": "USD/JPY"
    },
    ...
]

---

Codes de réponse HTTP

• 200 OK : La requête a été traitée avec succès.

• 400 Bad Request : Paramètres de requête incorrects.

• 401 Unauthorized : Token d'authentification manquant ou invalide.

• 404 Not Found : Signal demandé non trouvé.

• 500 Internal Server Error : Erreur interne au serveur.

---

Exemples de Requêtes

Voici quelques exemples de requêtes pour illustrer l’utilisation de l'API.

Obtenir tous les signaux :

curl -X GET "https://manager.traderush.co/api.php?token=YOUR_TOKEN"

Requête avec pagination et tri :

curl -X GET "https://manager.traderush.co/api.php?token=YOUR_TOKEN&limit=10&page=2&order_by=created_at&order_dir=asc"

Filtrage par dates :

curl -X GET "https://manager.traderush.co/api.php?token=YOUR_TOKEN&start_date=2023-01-01&end_date=2023-12-31"