janprikryl / revolutx

1.1.0 2026-10-12 11:51 UTC

Requires

• php: ^8.0
• ext-curl: *
• ext-json: *
• ext-sodium: *

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• Jan Přikryl

Published on Packagist.org on 2026-10-12 11:52 UTC

README

PHP client library for interacting with the Revolut X Crypto Exchange REST API (v1.0).

📖 Documentation: janprikryl1.github.io/revolut-x-php
🐍 Looking for Python? See revolut-x-python or Python Documentation.

Features

• Revolut X API v1.0 — Complete coverage of market data, order execution, account balances, and ledger transaction history.
• Ed25519 Authentication — Asymmetric request signing using PHP's native ext-sodium extension.
• Zero External Runtime Dependencies — Pure PHP utilizing built-in extensions (ext-curl, ext-sodium, ext-json).
• PHP 8.0+ Compatible — Tested across PHP 8.0, 8.1, 8.2, 8.3, 8.4, and 8.5 with strict types.
• Smart Maker Strategy (0.00% fee) — Automatic offset pricing and post_only execution to prevent unintentional taker fees (0.09%).
• Automated Rate Limiting — Proactive request throttling adhering to Revolut X limits (1 req/s) with exponential retry backoff on HTTP 429 (Retry-After).
• Structured Exceptions — Clean exception hierarchy (AuthenticationException, RateLimitException, ApiException, OrderValidationException).

Requirements

• PHP ^8.0 (8.0.30+, 8.1, 8.2, 8.3, 8.4, 8.5)
• Extensions: ext-curl, ext-json, ext-sodium

Installation

composer require janprikryl/revolutx

Or clone and install dependencies:

git clone https://github.com/janprikryl1/revolut-x-php.git
cd revolut-x-php
composer install

Quickstart

1. Public Market Data (No API Key Required)

use RevolutX\Client;
use RevolutX\Types\Interval;

$client = new Client();

// 1. Get current BTC-EUR ticker
$ticker = $client->getTicker('BTC-EUR');
echo "BTC Price: " . $ticker['last_price'] . " EUR\n";

// 2. Fetch order book (top 5 bids and asks)
$orderBook = $client->getOrderBook('BTC-EUR', depth: 5);

// 3. Fetch 1-hour OHLCV candles
$candles = $client->getCandles('BTC-EUR', Interval::HOUR_1);

2. Authenticated Trading & Balances

use RevolutX\Client;
use RevolutX\Types\OrderSide;

$client = new Client(
    apiKey: 'your-api-key',
    privateKeyPath: 'path/to/private.pem'
);

// Check account balance
$eur = $client->getBalance('EUR');
echo "EUR Available: " . $eur['available'] . "\n";

// Place a market buy order for 50 EUR
$order = $client->placeMarketOrder(
    symbol: 'BTC-EUR',
    side: OrderSide::BUY,
    quoteSize: '50.00'
);
echo "Order ID: " . $order['venue_order_id'] . "\n";

3. Smart Maker Orders (0.00% Fee)

use RevolutX\Client;
use RevolutX\Types\OrderSide;

// Automatically queries the live order book, applies offset, and submits post_only=true
$order = $client->placeMakerOrder(
    symbol: 'BTC-EUR',
    side: OrderSide::BUY,
    quoteSize: '50.00',
    offset: '0.10'
);

Running Tests

./vendor/bin/phpunit

Releasing a New Version

Releasing new package versions is automated using the GitHub Actions workflow (Release New Version):

1. Go to the Actions tab in the GitHub repository.
2. In the left sidebar, select Release New Version.
3. Click the Run workflow button:
   • Version bump type (bump_type):
     • patch (default) — e.g. v1.1.0 $\rightarrow$ v1.1.1 (bug fixes, maintenance)
     • minor — e.g. v1.1.0 $\rightarrow$ v1.2.0 (new features, backward-compatible)
     • major — e.g. v1.1.0 $\rightarrow$ v2.0.0 (breaking changes)
     • custom — enter a specific tag in the custom_tag field (e.g. v1.1.1-beta)
   • Dry run (dry_run): check this option to preview version calculation without creating a git tag or release.
4. Click the green Run workflow button.

The workflow automatically:

• Determines the next version based on previous tags and creates the corresponding Git tag (e.g. v1.1.1).
• Publishes a GitHub Release with auto-generated release notes from commits.
• Triggers Packagist to publish the updated version via webhook.

Academic Reference

This library was developed as part of a Master's thesis at VŠB – Technical University of Ostrava (Faculty of Electrical Engineering and Computer Science).

• Author: Bc. Jan Přikryl
• University: VŠB – Technical University of Ostrava
• Faculty: Faculty of Electrical Engineering and Computer Science (FEI)

License

MIT License - see LICENSE for details.