upbit-openapi-skill

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Upbit Open API Skill

Use this skill to run Upbit public market-data operations through

uxc

+ OpenAPI.

Reuse the

uxc

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

使用此skill通过

uxc

+ OpenAPI执行Upbit公开市场数据操作。

复用

uxc

skill以获取共享的执行、认证和错误处理指引。

Prerequisites

前提条件

```
uxc
```
is installed and available in
```
PATH
```
.
Network access to the chosen Upbit regional API host.

Access to the curated OpenAPI schema URL:

https://raw.githubusercontent.com/holon-run/uxc/main/skills/upbit-openapi-skill/references/upbit-public.openapi.json

```
uxc
```
已安装且可在
```
PATH
```
中访问。
能够访问所选Upbit区域API主机的网络权限。

能够访问精心整理的OpenAPI schema URL：

https://raw.githubusercontent.com/holon-run/uxc/main/skills/upbit-openapi-skill/references/upbit-public.openapi.json

Scope

适用范围

This skill covers a curated Upbit public surface for:

market discovery
ticker reads
minute candles
order book snapshots

This skill does not cover:

private account or order endpoints in v1
region-specific account/trade auth flows

此skill涵盖Upbit公开接口的以下精选内容：

市场发现
行情数据读取
分钟K线
订单簿快照

此skill 不涵盖：

v1版本中的私有账户或订单端点
特定区域的账户/交易认证流程

Endpoint

端点

Upbit uses regional hosts. Pick the right one for the market you need before linking.

Examples:

```
https://sg-api.upbit.com
```
```
https://id-api.upbit.com
```
```
https://th-api.upbit.com
```

Upbit使用区域主机。在关联前请选择适合你所需市场的正确主机。

示例：

```
https://sg-api.upbit.com
```
```
https://id-api.upbit.com
```
```
https://th-api.upbit.com
```

Authentication

认证

Public market endpoints in this skill do not require credentials.

Upbit private APIs use provider-specific bearer JWT generation with request-specific claims. Keep this v1 skill public-data-only until a reusable Upbit signer flow exists in

uxc

此skill中的公开市场端点无需凭证。

Upbit私有API使用特定于提供商的Bearer JWT生成，并带有请求特定声明。在

uxc

中存在可复用的Upbit签名流程之前，此v1版本skill仅支持公开数据操作。

Core Workflow

核心工作流程

Choose the correct regional host for the market you need.

Use a fixed link command by default:

```
command -v upbit-openapi-cli
```

If missing, create it:

uxc link upbit-openapi-cli https://sg-api.upbit.com --schema-url https://raw.githubusercontent.com/holon-run/uxc/main/skills/upbit-openapi-skill/references/upbit-public.openapi.json

```
upbit-openapi-cli -h
```

Inspect operation help before execution:

```
upbit-openapi-cli get:/v1/market/all -h
```
```
upbit-openapi-cli get:/v1/ticker -h
```

Prefer narrow market reads first:

upbit-openapi-cli get:/v1/ticker markets=SGD-BTC

upbit-openapi-cli get:/v1/orderbook markets=SGD-BTC

为你所需的市场选择正确的区域主机。

默认使用固定的关联命令：

```
command -v upbit-openapi-cli
```

如果不存在，创建它：

uxc link upbit-openapi-cli https://sg-api.upbit.com --schema-url https://raw.githubusercontent.com/holon-run/uxc/main/skills/upbit-openapi-skill/references/upbit-public.openapi.json

```
upbit-openapi-cli -h
```

执行前查看操作帮助：

```
upbit-openapi-cli get:/v1/market/all -h
```
```
upbit-openapi-cli get:/v1/ticker -h
```

优先选择窄范围的市场读取操作：

upbit-openapi-cli get:/v1/ticker markets=SGD-BTC

upbit-openapi-cli get:/v1/orderbook markets=SGD-BTC

Operations

操作

```
get:/v1/market/all
```
```
get:/v1/ticker
```
```
get:/v1/candles/minutes/{unit}
```
```
get:/v1/orderbook
```

```
get:/v1/market/all
```
```
get:/v1/ticker
```
```
get:/v1/candles/minutes/{unit}
```
```
get:/v1/orderbook
```

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.
Confirm the correct regional host and quote market before execution.
On regional Upbit hosts, live market codes are quote-first, for example
```
SGD-BTC
```
and
```
USDT-BTC
```
.

upbit-openapi-cli <operation> ...

is equivalent to

uxc <upbit_region_host> --schema-url <upbit_public_openapi_schema> <operation> ...

仅对JSON输出包进行自动化处理；请勿使用
```
--text
```
参数。
优先解析稳定字段：
```
ok
```
、
```
kind
```
、
```
protocol
```
、
```
data
```
、
```
error
```
。
将此v1版本skill视为只读。
执行前确认正确的区域主机和报价市场。
在Upbit区域主机上，实时市场代码以报价货币为先，例如
```
SGD-BTC
```
和
```
USDT-BTC
```
。

upbit-openapi-cli <operation> ...

等同于

uxc <upbit_region_host> --schema-url <upbit_public_openapi_schema> <operation> ...

。

References

参考资料

Usage patterns:
```
references/usage-patterns.md
```
Curated OpenAPI schema:
```
references/upbit-public.openapi.json
```
Official Upbit Open API overview: https://global-docs.upbit.com/reference/api-overview

使用模式：
```
references/usage-patterns.md
```
精心整理的OpenAPI schema：
```
references/upbit-public.openapi.json
```
Upbit官方Open API概述：https://global-docs.upbit.com/reference/api-overview