README

BitMEX交易平台的REST API 查看变更日志 - #### 开始使用基本URI: https://www.bitmex.com/api/v1 ##### 获取数据以下列出了所有REST端点。您可以直接从这个界面尝试任何查询。大多数表格查询接受 count，start 和 reverse 参数。将 reverse=true 设置为以最新行开始。有关过滤器、时间戳和身份验证的更多文档，请参阅 主要API文档。 所有 表格数据都可通过 Websocket 获取。如果您希望获取最快的数据且不受速率限制的影响，我们强烈建议使用socket。##### 返回类型默认情况下，所有数据都返回为JSON。发送 ?_format=csv 以获取CSV数据或 ?_format=xml 以获取XML数据。##### 交易数据查询 这仅是可用功能的一小部分，以帮助您入门。 填写参数并单击 Try it out! 按钮以尝试以下查询之一。 - 价格数据 - 交易数据 - 订单簿数据 - 结算数据 - 交易所统计 BitMEX.com平台的所有功能都在这里公开并已文档化。还有更多功能可用。##### Swagger规范 ⇩ 下载Swagger JSON - ## 所有API端点点击展开部分。

此PHP包由Swagger Codegen项目自动生成

• API版本：1.2.0
• 构建包：io.swagger.codegen.languages.PhpClientCodegen

需求

PHP 5.5及以上

安装 & 使用

Composer

要使用Composer安装绑定，请将以下内容添加到composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含autoload.php

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

测试

要运行单元测试

composer install
./vendor/bin/phpunit

开始使用

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

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

// Configure API key authorization: apiExpires
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-expires', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-expires', 'Bearer');
// Configure API key authorization: apiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: apiSignature
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api-signature', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-signature', 'Bearer');

$apiInstance = new Swagger\Client\Api\APIKeyApi(
    // 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
);
$reverse = false; // bool | If true, will sort results newest first.

try {
    $result = $apiInstance->aPIKeyGet($reverse);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APIKeyApi->aPIKeyGet: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI相对于 https://www.bitmex.com/api/v1

模型文档

• APIKey
• AccessToken
• Affiliate
• 公告
• 聊天
• 聊天频道
• CommunicationToken
• ConnectedUsers
• Error
• ErrorError
• 执行
• 资金
• 全局通知
• IndexComposite
• InlineResponse200
• Instrument
• InstrumentInterval
• 保险
• 排行榜
• 清算
• 保证金
• 订单
• 订单簿L2
• 仓位
• 报价
• QuoteFillRatio
• 结算
• Stats
• StatsHistory
• StatsUSD
• Trade
• TradeBin
• 交易
• User
• UserCommissionsBySymbol
• UserEvent
• UserPreferences
• 钱包
• XAny

授权文档

apiExpires

• 类型: API密钥
• API密钥参数名: api-expires
• 位置: HTTP头

apiKey

• 类型: API密钥
• API密钥参数名: api-key
• 位置: HTTP头

apiSignature

• 类型: API密钥
• API密钥参数名: api-signature
• 位置: HTTP头

作者

support@bitmex.com