Skip to content

Latest commit

 

History

History
432 lines (251 loc) · 11.5 KB

README.md

File metadata and controls

432 lines (251 loc) · 11.5 KB

PHP RoboTrade API

PHP обертка для формата обмена данными.

Содержимое

Метод Описание
Api::__construct Создает экземпляр Api
Api::getMicrotime Возвращает текущий timestamp в микросекундах
Api::generateUUID Генерирует уникальный идентификатор UUID4
Api::createOrder Создание ордера
Api::generateOrder Генерирует ордер для createOrders()
Api::createOrders Создание нескольких ордеров
Api::cancelOrder Отмена ордера
Api::cancelOrders Отмена нескольких ордеров
Api::cancelAllOrders Отмена всех открытых ордеров
Api::getOrderStatus Получить статус ордера
Api::getOrderStatuses Получить статус нескольких ордеров
Api::getBalances Информация о балансах активов
Api::error Сообщение об ошибке
Api::ping Главная метрика компонента

Api

  • Full name: \robotrade\Api

Api::__construct

Создает экземпляр Api

Api::__construct( string exchange, string algo, string node, string instance ): mixed

Параметры:

Параметр Тип Описание
exchange string Название биржи
algo string Название алгоритма
node string Нода (core или gate)
instance string Экземпляр

Пример:

$api = new \robotrade\Api("binance", "cross_3t_php", "core", "cross_3t");

Api::getMicrotime

Возвращает текущий timestamp в микросекундах

Api::getMicrotime(): int

Возвращает:: json

Api::generateUUID

Возвращает уникальный универсальный идентификатор UUID4 (36 символов)

Api::generateUUID(): string

Возвращает: json

Api::createOrder

Создание ордера

Api::createOrder( string client_order_id, string symbol, string type, string side, float amount, float price, string|null message = null ): string

Параметры:

Параметр Type Описание
client_order_id string Уникальный ID ордера
symbol string Торговая пара
type string Тип (limit или market)
side string Направление сделки
amount float Количество
price float Цена
message string|null Сообщение (необязательно)

Пример:

$client_order_id = $api->generateUUID();
$create_order = $api->createOrder($client_order_id, $symbol, $type, $side, $amount, $price);

Возвращает: json

Api::generateOrder

Генерирует ордер для createOrders()

Api::generateOrder( string client_order_id, string symbol, string type, string side, float amount, float price ): string

Параметры:

Параметр Тип Описание
client_order_id string Уникальный ID ордера
symbol string Торговая пара
type string Тип (limit или market)
side string Направление сделки
amount float Количество
price float Цена

Возвращает: json

Api::createOrders

Создание нескольких ордеров.

Api::createOrders( array orders, string|null message = null ): string

Ордера генерируются функцией generateOrder()

Параметры:

Параметр Тип Описание
orders array Массив ордеров
message string|null Сообщение (необязательно)

Пример:

$client_order_id_one = $api->generateUUID();
$client_order_id_two = $api->generateUUID();
$client_order_id_three = $api->generateUUID();

$order_one = $api->generateOrder($client_order_id_one, $symbol, $type, $side, $amount, $price);
$order_two = $api->generateOrder($client_order_id_two, $symbol, $type, $side, $amount, $price);
$order_three = $api->generateOrder($client_order_id_three, $symbol, $type, $side, $amount, $price);

$create_orders = $api->createOrders([$order_one, $order_two, $order_three]);

Возвращает: json

Api::cancelOrder

Отмена ордера

Api::cancelOrder( string client_order_id, string symbol, string|null message = null ): string

Параметры:

Параметр Тип Описание
client_order_id string Уникальный ID ордера
symbol string Торговая пара
message string|null Сообщение (необязательно)

Пример:

$cancel_order = $api->cancelOrder($client_order_id, $symbol);

Возвращает: json

Api::cancelOrders

Отмена нескольких ордеров. Структура массива ордеров:[["client_order_id1", "symbol1"], ["client_order_id2", "symbol2"], ...]

Api::cancelOrders( array orders, string|null message = null ): string

Параметры:

Параметр Тип Описание
orders array Массив ордеров
message string|null Сообщение (необязательно)

Пример:

$order_one = ["client_order_id" => "23909aa5-e511-4e45-8960-98bdec5e13e9", "symbol" => "BTC/USDT"];
$order_two = ["client_order_id" => "7a6070ec-11e5-43bb-a2de-43f7a3f910d5", "symbol" => "ETH/USDT"];
$order_three = ["client_order_id" => "95f8d694-ed89-4f59-bc48-c9945d3b0025", "symbol" => "ETH/BTC"];

$cancel_orders = $api->cancelOrders([$order_one, $order_two, $order_three]);

Возвращает: json

Api::cancelAllOrders

Отмена всех открытых ордеров

Api::cancelAllOrders( string|null message = null ): string

Параметры:

Параметр Тип Описание
message string|null Сообщение (необязательно)

Пример:

$cancel_all_orders = $api->cancelAllOrders();

Возвращает: json

Api::getOrderStatus

Получить статус ордера

Api::getOrderStatus( string id, string symbol, string|null message = null ): string

Параметры:

Параметр Тип Описание
client_order_id string Уникальный ID ордера
symbol string Торговая пара
message string|null Сообщение (необязательно)

Возвращает: json

Пример:

$get_order_status = $api->getOrderStatus($client_order_id, $symbol);

Api::getOrderStatuses

Запрос статусов нескольких ордеров. Структура массива ордеров:[["client_order_id1", "symbol1"], ["client_order_id2", "symbol2"], ...]

Api::getOrderStatuses( array orders, string|null message = null ): string

Параметры:

Параметр Тип Описание
orders array Массив ордеров
message string|null Сообщение (необязательно)

Пример:

$order_one = ["client_order_id" => "23909aa5-e511-4e45-8960-98bdec5e13e9", "symbol" => "BTC/USDT"];
$order_two = ["client_order_id" => "7a6070ec-11e5-43bb-a2de-43f7a3f910d5", "symbol" => "ETH/USDT"];
$order_three = ["client_order_id" => "95f8d694-ed89-4f59-bc48-c9945d3b0025", "symbol" => "ETH/BTC"];

$cancel_orders = $api->getOrderStatuses([$order_one, $order_two, $order_three]);

Возвращает: json

Api::getBalances

Информация о балансах активов.

Api::getBalances( array|null assets = null, string|null message = null ): string

Если массив активов пуст, возвращает информацию обо всех активах.

Параметры:

Параметр Тип Описание
assets array|null Массив активов ["BTC", "ETH", ...]
message string|null Сообщение (необязательно)

Пример:

$get_balances = $api->getBalances(["BTC", "ETH", "WAVES"]);

Возвращает: json

Api::error

Сообщениe об ошибке

Api::error( string action, mixed data = "", string|null message = null ): string

Параметры:

Параметр Тип Описание
action string Действие при котором возникла ошибка
data mixed Данные об ошибке
message string|null Сообщение об ошибке

Пример:

$error = $api->error("create_order", null, "Not enough balance");

Возвращает: json

Api::ping

Генерирует сообщение для логгера с главной метрикой компонента

Api::ping( int metric, string|null message = null ): string

Параметры:

Параметр Тип Описание
metric int Главная метрика
message string|null Сообщение (необязательно)

Пример:

$error = $api->ping(31337);

Возвращает: json