← 返回 Skills 市场

Bybit OpenAPI Skill

Name: Bybit OpenAPI Skill
Author: jolestar

作者 jolestar · GitHub ↗ · v1.0.0 · MIT-0

cross-platform ✓ 安全检测通过

224

总下载

当前安装

版本数

在 OpenClaw 中安装

/install bybit-openapi-skill

功能描述

Operate Bybit V5 public market APIs through UXC with a curated OpenAPI schema, market-first discovery, and explicit private-auth boundary notes.

使用说明 (SKILL.md)

Bybit V5 Skill

Use this skill to run Bybit V5 market-data operations through uxc + OpenAPI.

Reuse the uxc skill for shared execution, auth, and error-handling guidance.

Prerequisites

uxc is installed and available in PATH.
Network access to:
- https://api.bybit.com
- optionally https://api-testnet.bybit.com
Access to the curated OpenAPI schema URL:
- https://raw.githubusercontent.com/holon-run/uxc/main/skills/bybit-openapi-skill/references/bybit-v5.openapi.json

Scope

This skill covers a curated Bybit V5 public market surface for:

server time
instruments metadata
tickers
order book snapshots
kline reads

This skill does not cover:

private account endpoints in v1
private order placement or cancellation in v1
copy trading, earn, broker, or asset management product families

Authentication

Public market endpoints in this skill do not require credentials.

Bybit private APIs use provider-specific header signing that is not yet packaged as a generic uxc signer flow. Keep this v1 skill public-data-only until a reusable Bybit signer path exists.

Region Guardrail

Bybit's official docs note region and IP restrictions. If requests fail unexpectedly, verify that the current execution environment is permitted for Bybit API access before debugging the schema or parameters.

Core Workflow

Use the fixed link command by default:
- command -v bybit-openapi-cli
- If missing, create it: uxc link bybit-openapi-cli https://api.bybit.com --schema-url https://raw.githubusercontent.com/holon-run/uxc/main/skills/bybit-openapi-skill/references/bybit-v5.openapi.json
- bybit-openapi-cli -h
Inspect operation help before execution:
- bybit-openapi-cli get:/v5/market/time -h
- bybit-openapi-cli get:/v5/market/instruments-info -h
- bybit-openapi-cli get:/v5/market/tickers -h
Prefer narrow spot reads first:
- bybit-openapi-cli get:/v5/market/tickers category=spot symbol=BTCUSDT
- bybit-openapi-cli get:/v5/market/orderbook category=spot symbol=BTCUSDT limit=20

Operations

get:/v5/market/time
get:/v5/market/instruments-info
get:/v5/market/tickers
get:/v5/market/orderbook
get:/v5/market/kline

Guardrails

Keep automation on the JSON output envelope; do not use --text.
Parse stable fields first: ok, kind, protocol, data, error.
Treat this v1 skill as read-only.
Use category=spot unless the user explicitly needs another market family and has checked the symbol format.
bybit-openapi-cli \x3Coperation> ... is equivalent to uxc https://api.bybit.com --schema-url \x3Cbybit_v5_openapi_schema> \x3Coperation> ....

References

Usage patterns: references/usage-patterns.md
Curated OpenAPI schema: references/bybit-v5.openapi.json
Official Bybit V5 docs: https://bybit-exchange.github.io/docs/v5/guide

安全使用建议

This skill appears coherent and limited to public read-only Bybit market APIs, but check a few practical things before installing/using: (1) Make sure you have the 'uxc' CLI installed and understand what 'uxc link' will create on your system (it may add a local bybit-openapi-cli wrapper). (2) The included validate.sh is optional but requires jq and ripgrep if you want to run it locally. (3) The skill intentionally avoids private/auth endpoints — do not provide Bybit API keys to this skill unless a vetted signer flow is added later. (4) Confirm you allow network access to api.bybit.com and raw.githubusercontent.com. If any of these points are unexpected, pause and review 'uxc' documentation and the local schema file before proceeding.

功能分析

Type: OpenClaw Skill Name: bybit-openapi-skill Version: 1.0.0 The Bybit V5 skill bundle is a well-structured tool for accessing public cryptocurrency market data. It includes explicit safety guardrails in SKILL.md and references/usage-patterns.md that restrict the agent to read-only public endpoints and warn against attempting private authenticated operations. The validation script (scripts/validate.sh) reinforces these security boundaries by ensuring the presence of 'read-only' and 'public-data-only' documentation before the skill is considered valid.

能力评估

ℹ Purpose & Capability

The skill's name, description, OpenAPI schema, usage examples, and SKILL.md all consistently describe read-only Bybit V5 public market access. One inconsistency: SKILL.md requires the 'uxc' CLI to be installed and on PATH, but the registry metadata lists no required binaries. The included validation script also depends on jq and rg (ripgrep) for local validation. These missing declarations look like bookkeeping omissions rather than functional mismatches, but you should ensure those tools are present before running.

✓ Instruction Scope

Runtime instructions are narrowly scoped to public GET/read operations against Bybit's market endpoints and to creating/using a local 'bybit-openapi-cli' via 'uxc link'. The SKILL.md explicitly forbids private-auth operations and urges read-only behavior. It does not instruct reading unrelated files or exfiltrating data to non-Bybit endpoints.

✓ Install Mechanism

There is no install spec (instruction-only skill), which minimizes risk. The only external URL referenced is a raw.githubusercontent.com link hosting the curated OpenAPI schema — a standard, transparent location. The included validate.sh is a local helper that requires jq and rg if you run it; it does not perform any network installs itself.

✓ Credentials

The skill declares no environment variables or credentials and the SKILL.md clearly states public market endpoints do not require auth. No unrelated credential or secret access is requested. The guidance to keep this v1 skill public-data-only is explicit.

ℹ Persistence & Privilege

The skill is not always-enabled and can be invoked by users. It does instruct using 'uxc link' to create a local 'bybit-openapi-cli' command — that will create a local CLI wrapper via the user's uxc installation (i.e., it can add a command to the environment). This is expected for a CLI-centered workflow but you should confirm what 'uxc link' does on your system before running it.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install bybit-openapi-skill
安装完成后，直接呼叫该 Skill 的名称或使用 /bybit-openapi-skill 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.0

Bybit OpenAPI Skill v1.0.0 – initial release - Enables access to Bybit V5 public market data via UXC and a curated OpenAPI schema. - Supports server time, instruments info, tickers, order book, and kline reads. - Public-data-only: private/account/order endpoints are not included in this version. - Clear guidance on setup, region restrictions, and recommended workflows provided in documentation. - Authentication not required for supported endpoints; private endpoint access is planned for future versions.

元数据

Slug bybit-openapi-skill

版本 1.0.0

许可证 MIT-0

累计安装 1

当前安装数 1

历史版本数 1

常见问题