historical_data_example.php

<?php

require_once __DIR__ . '/../../vendor/autoload.php';

use Oyi77\MetaapiCloudPhpSdk\AccountApi;

/**
 * Historical Market Data Example
 *
 * Demonstrates how to:
 * - Retrieve historical candles
 * - Retrieve historical ticks
 * 
 * Note: Historical market data is only available on G1 and MT4 G2 instances.
 */

$token = getenv('TOKEN') ?: '<put your token here>';
$accountId = getenv('ACCOUNT_ID') ?: '<put your account ID here>';
$symbol = getenv('SYMBOL') ?: 'EURUSD';

try {
    // Create AccountApi instance
    $accountApi = new AccountApi($token);

    // Get historical candles
    echo "Fetching historical candles for {$symbol}...\n";
    $candles = $accountApi->getHistoricalCandles(
        $accountId,
        $symbol,
        '1h', // 1-hour timeframe
        '2024-01-01 00:00:00.000', // Start time
        100 // Limit to 100 candles
    );

    if (is_array($candles)) {
        echo "Retrieved " . count($candles) . " candles\n";
        if (count($candles) > 0) {
            echo "First candle: " . json_encode($candles[0]) . "\n";
            echo "Last candle: " . json_encode($candles[count($candles) - 1]) . "\n";
        }
    } else {
        echo "Candles response: {$candles}\n";
    }
    echo "\n";

    // Get recent candles without start time (returns latest)
    echo "Fetching latest candles for {$symbol}...\n";
    $recentCandles = $accountApi->getHistoricalCandles(
        $accountId,
        $symbol,
        '15m', // 15-minute timeframe
        null, // No start time - get latest
        10 // Limit to 10 candles
    );

    if (is_array($recentCandles)) {
        echo "Retrieved " . count($recentCandles) . " recent candles\n";
    }
    echo "\n";

    // Get historical ticks
    echo "Fetching historical ticks for {$symbol}...\n";
    $ticks = $accountApi->getHistoricalTicks(
        $accountId,
        $symbol,
        '2024-01-01 00:00:00.000', // Start time
        0, // Offset
        50 // Limit to 50 ticks
    );

    if (is_array($ticks)) {
        echo "Retrieved " . count($ticks) . " ticks\n";
        if (count($ticks) > 0) {
            echo "First tick: " . json_encode($ticks[0]) . "\n";
            echo "Last tick: " . json_encode($ticks[count($ticks) - 1]) . "\n";
        }
    } else {
        echo "Ticks response: {$ticks}\n";
    }
    echo "\n";

    // Get recent ticks without start time (returns latest)
    echo "Fetching latest ticks for {$symbol}...\n";
    $recentTicks = $accountApi->getHistoricalTicks(
        $accountId,
        $symbol,
        null, // No start time - get latest
        null, // No offset
        20 // Limit to 20 ticks
    );

    if (is_array($recentTicks)) {
        echo "Retrieved " . count($recentTicks) . " recent ticks\n";
    }
    echo "\n";

    echo "Historical data retrieval complete!\n";

} catch (Exception $e) {
    echo "Error: " . $e->getMessage() . "\n";
    echo $e->getTraceAsString() . "\n";
}