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

Class	Method	HTTP request	Description
AccountApi	accountLoginGet	GET /account/{login}	Get account by user login
BasicApi	initGet	GET /init/	Init manager
BasicApi	pingGet	GET /ping/	Ping API
GroupApi	groupGroupNameGet	GET /group/{group_name}	Get group by name
GroupApi	groupsGet	GET /groups/	Get list of groups
OrderApi	positionsUserLoginGet	GET /positions/{user_login}	Get list of user positions
OrderApi	tradesUserLoginGet	GET /trades/{user_login}	Get list of user trades
SymbolApi	symbolsGet	GET /symbols/	Get list of market symbols
UserApi	updateUser	POST /user/update	Update user
UserApi	userAddPost	POST /user/add	Create user
UserApi	userDepositPost	POST /user/deposit	Deposit account
UserApi	userResetPwdPost	POST /user/reset_pwd	Reset password
UserApi	userUserLoginDelete	DELETE /user/{user_login}	Delete user
UserApi	userUserLoginGet	GET /user/{user_login}	Get user by user login
UserApi	userWithdrawPost	POST /user/withdraw	Withdraw account
UserApi	usersGroupGet	GET /users/{group}	Get list of users

Documentation For Models

Documentation For Authorization

bearerAuth

Type: HTTP bearer authentication

Author

mikha.dev@gmail.com

ibf / mt5-manager-api

Maintainers

Details