gateio/gateapi-php

欢迎使用 Gate.io API。APIv4 提供现货、杠杆和期货交易操作。有公共 API 可用于检索实时市场统计信息,还有需要认证的私有 API,用于代表用户进行交易。


README

欢迎使用 Gate.io API

APIv4 提供现货、杠杆和期货交易操作。有公共 API 可用于检索实时市场统计信息,还有需要认证的私有 API,用于代表用户进行交易。

此 PHP 包由 OpenAPI Generator 项目自动生成

版本控制

我们尽力遵循 语义版本控制,同时享受编程语言和库提供的最新功能,从 4.15.2 版本开始,将引入一个主要版本控制差异。

当您升级 SDK 时,可能需要重写额外代码,例如:

  • 取消了对某些过时编程语言版本的支持。
  • API 方法签名有破坏性更改。

主版本号将增加,但次版本号和补丁版本号仍遵循 REST API,而不是重置为 0,这样您可以识别到有破坏性更改,但仍能理解更改是从哪个 REST API 版本引入的。

例如,以前的 REST API 和 SDK 版本都是 4.14.0。但如果我们决定在 REST API 4.15.2 升级的同时在 SDK 中引入破坏性更改,那么下一个 SDK 发布版的版本号将是 5.15.2(主版本号增加以表示破坏性更改,但次版本号和补丁版本号与 REST API 相同,而不是将它们重置为 0)

如果主版本号增加,请确保您阅读了 发布说明 页面上的发布说明。

需求

PHP 7.1 及以上版本

安装与使用

Composer

要通过 Composer 安装绑定,请将以下内容添加到 composer.json 文件中:

{
    "require": {
        "gateio/gateapi-php": "@stable"
    }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

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

入门

请按照 安装过程 进行操作,然后运行以下命令:

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


$apiInstance = new GateApi\Api\DeliveryApi(
    // 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()
);
$settle = 'usdt'; // string | Settle currency

try {
    $result = $apiInstance->listDeliveryContracts($settle);
    print_r($result);
} catch (GateApi\GateApiException $e) {
    echo "Gate API Exception: label: {$e->getLabel()}, message: {$e->getMessage()}" . PHP_EOL;
} catch (Exception $e) {
    echo 'Exception when calling DeliveryApi->listDeliveryContracts: ', $e->getMessage(), PHP_EOL;
}
?>

API 端点文档

所有 URI 都相对于 https://api.gateio.ws/api/v4

模型文档

授权文档

API定义的认证方案

apiv4

  • 类型:Gate APIv4

https://www.gate.io/docs/apiv4/en/index.html#apiv4-signed-request-requirements

作者

support@mail.gate.io