Skip to content

v1.0.0

Latest
Compare
Choose a tag to compare
@asolonytskyi asolonytskyi released this 20 Jul 14:57
· 1 commit to main since this release

Release Notes for asolonytkyi/laravel-taapi v1.0.0


Release Date: 2024-07-20

Overview

The asolonytkyi/laravel-taapi package provides seamless integration with TAAPI.io, allowing Laravel applications to fetch and analyze financial market data using a variety of technical indicators. This initial release includes a comprehensive set of features to interact with TAAPI.io and perform technical analysis.

Features

  • TAAPI Service Integration:

    • Core service to interact with TAAPI.io API.
    • Methods for fetching single and multiple technical indicators.
  • Facades and Service Providers:

    • Facades for easy access to TAAPI services.
    • Service provider for Laravel integration.
  • Technical Indicators:

    • Support for a wide range of technical indicators including RSI, CMO, EMA, and more.
  • Validation:

    • Validation for technical indicators to ensure correct usage.
  • Error Handling:

    • Centralized error handling for API requests.
  • Configuration:

    • Easily configurable API key through Laravel's configuration system.

Added

  • TAAPIService: Core service class for interacting with TAAPI.io.
  • GetIndicatorAction: Action class for fetching a single indicator.
  • GetIndicatorsAction: Action class for fetching multiple indicators.
  • IndicatorValidator: Validator class for validating indicator parameters.
  • ApiResponse: Class for standardizing API responses.
  • ErrorHandler: Class for handling and formatting errors.
  • Facades/Taapi: Facade for accessing TAAPI services in a Laravel-esque way.
  • TaapiServiceProvider: Service provider for registering TAAPI services with Laravel.
  • Configuration File: config/taapi.php for setting the API key.
  • Unit Tests: Comprehensive unit tests for all core components.

Installation

To install the package, use Composer:

composer require asolonytkyi/laravel-taapi

Usage

Configure your TAAPI_API_KEY in the .env file:

TAAPI_API_KEY=your-api-key

Use the provided facades to interact with TAAPI services:

use ASolonytkyi\Taapi\Facades\Taapi;

// Fetch a single indicator
$data = Taapi::getIndicator('rsi', [
    'exchange' => 'binance',
    'symbol' => 'BTC/USDT',
    'interval' => '1m',
    'period' => 14,
]);

// Fetch multiple indicators
$data = Taapi::getIndicators([
    'exchange' => Exchanges::BINANCE,
    'symbol' => 'BTC/USDT',
    'interval' => Intervals::ONE_MINUTE,
    'indicators' => [
        [
            'indicator' => Indicators::RSI,
            'period' => 14,
        ],
        [
            'indicator' => Indicators::CMO,
            'period' => 20,
        ],
    ],
]);

Documentation

For more detailed usage and examples, please refer to the GitHub repository.