byd/api-client

PHP client for BYD vehicle API

dev-main 2026-03-09 04:18 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• psr/log: ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^10.0

MIT

• Your Name

README

PHP client library for the BYD vehicle API.

Features

• Authentication
• Vehicle listing
• Real-time data
• GPS information
• HVAC status
• Charging status
• Energy consumption
• Remote control
• Smart charging
• Push notifications
• Vehicle settings

Installation

composer require byd/api-client

Usage

<?php

require_once 'vendor/autoload.php';

use Byd\ApiClient\Client;
use Byd\ApiClient\Config\BydConfig;

// Create configuration
$config = BydConfig::fromEnv([
    'username' => '[e-mail]',
    'password' => 'your-password',
    // ... other options
]);

// Create client
$client = new Client($config);

// Login
$client->login();

// Get vehicles
$vehicles = $client->getVehicles();

foreach ($vehicles as $vehicle) {
    echo "VIN: " . $vehicle->getVin() . "\n";
    echo "Model: " . $vehicle->getModelName() . "\n";
    echo "---\n";
}

Configuration

The client can be configured in several ways:

Environment Variables

BYD_USERNAME=[e-mail]
BYD_PASSWORD=your-password
BYD_BASE_URL=https://dilinkappoversea-eu.byd.auto
BYD_COUNTRY_CODE=NL
BYD_LANGUAGE=en
BYD_TIME_ZONE=Europe/Amsterdam

Direct Configuration

$config = new BydConfig(
    '[e-mail]',
    'your-password',
    'https://dilinkappoversea-eu.byd.auto', // base URL
    'NL', // country code
    'en', // language
    'Europe/Amsterdam', // time zone
    // ... other options
);

API Documentation

Key classes and methods:

• Client - Main client class
• BydConfig - Configuration class
• Vehicle - Vehicle model
• VehicleApi - Vehicle-related API methods
• RealtimeApi - Real-time data API methods
• GpsApi - GPS information API methods
• HvacApi - HVAC status API methods
• ChargingApi - Charging status API methods
• EnergyApi - Energy consumption API methods
• ControlApi - Remote control API methods
• SmartChargingApi - Smart charging API methods
• PushNotificationsApi - Push notifications API methods
• VehicleSettingsApi - Vehicle settings API methods

Requirements

• PHP 8.1+
• ext-json
• guzzlehttp/guzzle ^7.0
• psr/log ^3.0

Development

Install dependencies

composer install

Run tests

composer test

Code style

composer cs-fix

License

This project is licensed under the MIT License - see the LICENSE file for details.