ibf/mt5-manager-api

dev-main 2024-01-17 09:15 UTC

Requires

• php: ^7.4 || ^8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

proprietary

• Swagger and contributors

• php
• rest
• api
• sdk
• swagger

README

MetaTrader5 Rest Api. Call /init/ to get token, which is required in other methods.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.0.3-oas3
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/dev4traders/mt5-manager-api.git"
    }
  ],
  "require": {
    "dev4traders/mt5-manager-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new D4T\MT5Sdk\MT5Manager\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$login = "login_example"; // string | Login

try {
    $result = $apiInstance->accountLoginGet($login);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountLoginGet: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to http://localhost:6503/v1

Documentation For Models

• Account
• ArrayOfCachedLogins
• ArrayOfGroups
• ArrayOfPositions
• ArrayOfPositionsInner
• ArrayOfSymbols
• ArrayOfSymbolsInner
• ArrayOfTrades
• ArrayOfTradesInner
• ArrayOfUserResponses
• ArrayOfUserResponsesInner
• BalanceType
• Group
• InitReturnType
• PingReturnType
• ResetPwdType
• ReturnType
• TradesFilterType
• User
• UserReturnType
• UserReturnTypeUser
• Users
• UsersInner

Documentation For Authorization

bearerAuth

• Type: HTTP bearer authentication

Author

[e-mail]