API documentation (EN)

API Documentation - Traderush.co (beta-0.2-api)

Table of Contents

  • Introduction

  • Authentication

  • Endpoints

    • Retrieve a Specific Signal

    • Retrieve the Latest Signal

    • Retrieve a List of Signals

  • HTTP Response Codes

  • Request Examples

Introduction

The Traderush.co API provides real-time access to trading signals for various financial markets. This documentation explains how developers can interact with the API to integrate trading features into their applications. Note: All API responses and interface elements are in English.

Authentication

All requests require a valid authentication token to access the API.

Authentication Parameters

  • token (required): A unique session token required to authenticate each request to the API.

Endpoints

Retrieve a Specific Signal

Retrieve the details of a specific trading signal by its unique identifier.

  • URL: /api.php

  • Method: GET

  • Parameters:

    • token: Authentication token (required)

    • signal_token: Unique token of the signal to retrieve (optional)

Request Example:

Expected Response:

Retrieve the Latest Signal

Retrieve the latest signal issued by the Traderush.co system.

  • URL: /api.php

  • Method: GET

  • Parameters:

    • token: Authentication token (required)

    • latest: Indicator to retrieve the latest signal (optional)

Request Example:

Expected Response:

Retrieve a List of Signals

Retrieve multiple signals with filtering and pagination options.

  • URL: /api.php

  • Method: GET

  • Parameters:

    • token: Authentication token (required)

    • limit: Number of signals per page (default 50, optional)

    • page: Page number for pagination (default 1, optional)

    • order_by: Sort field (default created_at, optional)

    • order_dir: Sort direction (asc or desc, default asc, optional)

    • start_date: Start date to filter signals (optional)

    • end_date: End date to filter signals (optional)

Request Example:

Expected Response:

HTTP Response Codes

  • 200 OK: The request was successful.

  • 400 Bad Request: Incorrect request parameters.

  • 401 Unauthorized: Missing or invalid authentication token.

  • 404 Not Found: Requested signal not found.

  • 500 Internal Server Error: Internal server error.

Request Examples

Here are some request examples to illustrate API usage.

Retrieve all signals:

Request with pagination and sorting:

Filter by dates:

PreviousAPI documentation (FR)NextAPI Changelog (EN)

Last updated