bigcrunch/gateapi-php

欢迎来到 Gate.io API APIv4 提供现货、保证金和期货交易操作。存在用于检索实时市场统计信息的公共 API,以及需要认证以代表用户进行交易的秘密 API。

v0.0.1 2023-11-27 15:18 UTC

This package is auto-updated.

Last update: 2024-09-27 17:14:01 UTC


README

欢迎来到 Gate.io API

APIv4 提供现货、保证金和期货交易操作。存在用于检索实时市场统计信息的公共 API,以及需要认证以代表用户进行交易的秘密 API。

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

版本控制

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

如果升级 SDK 时需要额外的代码重写,例如

  • 一些过时的编程语言版本支持被删除
  • API 方法签名有破坏性更改。

MAJOR 版本将增加,但 MINOR 和 PATCH 版本仍然遵循 REST API,而不是重置为 0,这样您可以识别出有一些破坏性更改,但仍然可以了解更改是从哪个 REST API 版本引入的。

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

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

要求

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