okex_websocket.md

OKEx Websocket

Introduction

See binance websocket documentation for details

Usage

1. Start the local service, server.php example:

<?php

use EasyExchange\Factory;
use EasyExchange\Okex\Socket\Handle;

class Server
{
    public function ws()
    {
        $config = [
            'okex' => [
                'response_type' => 'array',
                'base_uri' => 'https://www.okex.com',
                'app_key' => 'your app key',
                'secret' => 'your secret',
                'passphrase' => 'your passphrase',
                'x-simulated-trading' => 1,
                'websocket' => [
                    'base_uri' => [
                        [
                            'url' => 'ws://ws.okex.com:8443/ws/v5/public',
                            'type' => 'public',
                        ],
                        [
                            'url' => 'ws://ws.okex.com:8443/ws/v5/private',
                            'type' => 'private',
                        ]
                    ],
                    'listen_ip' => '127.0.0.1', // listen ip
                    'listen_port' => 2207, // listen port
                    'heartbeat_time' => 20, // Heartbeat detection time, seconds
                    'timer_time' => 3, // Scheduled task time，seconds
                    'max_size' => 100, // Data retention，1～1000，Data is stored by channel name
                    'data_time' => 1, // Time interval for getting data，seconds
                    'debug' => true,
                ],
            ],
        ];
        $app = Factory::okex($config['okex']);
        $app->websocket->server([], new Handle());
    }
}

$tc = new Server();
$tc->ws();

2. Start script:php server.php start

3. Local client use example

<?php

use EasyExchange\Factory;

class Test
{
    public function t()
    {
        $config = [
            'okex' => [
                'response_type' => 'array',
                'base_uri' => 'https://www.okex.com',
                'app_key' => 'your app key',
                'secret' => 'your secret',
                'passphrase' => 'your passphrase',
                'x-simulated-trading' => 1,
                'websocket' => [
                    'base_uri' => [
                        [
                            'url' => 'ws://ws.okex.com:8443/ws/v5/public',
                            'type' => 'public',
                        ],
                        [
                            'url' => 'ws://ws.okex.com:8443/ws/v5/private',
                            'type' => 'private',
                        ]
                    ],
                    'listen_ip' => '127.0.0.1', // listen ip
                    'listen_port' => 2207, // listen port
                    'heartbeat_time' => 20, // Heartbeat detection time, seconds
                    'timer_time' => 3, // Scheduled task time，seconds
                    'max_size' => 100, // Data retention，1～1000，Data is stored by channel name
                    'data_time' => 1, // Time interval for getting data，seconds
                    'debug' => true,
                ],
            ],
        ];
        $app = Factory::okex($config['okex']);
        $params = [
            'op' => 'subscribe',
            'args' => [
                [
                    'channel' => 'tickers',
//                    'instId' => 'BTC-USDT', // Required
                    'instId' => 'LTC-USDT', // Required
                ],
                [
                    'channel' => 'tickers',
                    'instId' => 'ETH-USDT', // Required
                ],
//                [
//                    'channel' => 'instruments',
//                    'instType' => 'SPOT', // Required
//                ],
                [
                    'channel' => 'account',
                    'ccy' => 'LTC', // Required
//                    'ccy' => 'BTC', // Required
                ],
                [
                    'channel' => 'account',
                    'ccy' => 'USDT', // Required
                ],
            ],
        ];

        // subscribe
        $app->websocket->subscribe($params);

        $params = [
            'op' => 'unsubscribe',
            'args' => [
                [
                    'channel' => 'tickers',
//                    'instId' => 'BTC-USDT', // Required
                    'instId' => 'LTC-USDT', // Required
                ],
                [
                    'channel' => 'tickers',
                    'instId' => 'ETH-USDT', // Required
                ],
//                [
//                    'channel' => 'instruments',
//                    'instType' => 'SPOT', // Required
//                ],
                [
                    'channel' => 'account',
                    'ccy' => 'LTC', // Required
//                    'ccy' => 'BTC', // Required
                ],
                [
                    'channel' => 'account',
                    'ccy' => 'USDT', // Required
                ],
            ],
        ];
        // unsubscribe
        $app->websocket->unsubscribe($params);

        // Get subscribed channels
        $channels = $app->websocket->getSubChannel();
        print_r($channels);

        // 1. Obtain data according to the channel, if the channel is not transmitted, the data of all subscribed channels is obtained by default
        $channels = ['account', 'tickers'];
        $data = $app->websocket->getChannelData($channels);
        print_r($data);

        // 2. Use functions to process data
        $app->websocket->getChannelData($channels, function ($data) {
            print_r($data);
        });

        // 3. Use daemons and functions to process data
        $app->websocket->getChannelData($channels, function ($data) {
            print_r($data);
        }, true);
    }
}

$tc = new Test();
$tc->t();