README

Laravel wrapper for the GMO Coin APIs. It provides a convenient interface for both the cryptocurrency and FX endpoints.

Features

• Facades for Crypto and FX APIs
• Automatic request signing when credentials are configured
• Compatible with PHP 8.1+ and Laravel 12

Installation

Add the package using composer:

composer require gmo-coin/gmo-coin-php-sdk

Publish the configuration file:

php artisan vendor:publish --tag=config

Set your credentials in .env:

GMO_COIN_CRYPTO_API_KEY=your_crypto_key
GMO_COIN_CRYPTO_API_SECRET=your_crypto_secret
GMO_COIN_FX_API_KEY=your_fx_key
GMO_COIN_FX_API_SECRET=your_fx_secret

Usage

Use the provided facades to call API endpoints.

use GmoCoin\Facades\GmoCoinCrypto;
use GmoCoin\Facades\GmoCoinFx;

$response = GmoCoinCrypto::getStatus();
$ticker   = GmoCoinCrypto::getTicker();
$klines   = GmoCoinCrypto::getKlines('BTC', 'ASK', '1min', '20231028');
$books    = GmoCoinCrypto::getOrderBooks('BTC');
$assets   = GmoCoinCrypto::getAssets();

The client automatically signs requests when API keys are configured.

Development

Run static analysis to keep the codebase healthy:

composer phpstan