Yellow BoxTrading APIv1 · pre-release

Use with AI agents

This documentation is also published for AI coding agents: Markdown pages, an llms.txt index, and an Agent Skill. The skill teaches an agent the parts of this API that are easy to get wrong — signing, the mandatory login, idempotent retries, the user data stream.

Markdown pages

Every page is available as Markdown at the same address with .md appended:

Page Markdown
https://<docs-site>/trade/new-order/ https://<docs-site>/trade/new-order.md
https://<docs-site>/ https://<docs-site>/index.md

The Markdown is generated from the same source as the page you are reading, keeps the same sections (API Description, HTTP Request, Request Parameters, Response Example…), and links to the Markdown version of every other page. Paste a page's URL plus .md into a chat, or let an agent fetch it.

Copy page

The Copy page button next to every page title copies that page's Markdown to the clipboard, ready to paste into a conversation. Its menu also has View as Markdown, and links to the two files below.

llms.txt and llms-full.txt

File Contents
/llms.txt The index, in the llmstxt.org format: every page, grouped like the sidebar, with a link to its Markdown and a one-line description. Give an agent this URL and it can find the page it needs.
/llms-full.txt Every page's Markdown in one file, in sidebar order. Use it when an agent should hold the whole API at once.

Agent Skill

The ybx-trading-api skill packages the essentials of this API as an Agent Skill: a short SKILL.md that the agent loads when a task involves this API, plus reference files generated from this documentation (an endpoint index, General Info, the order lifecycle, the user data stream, error codes, enums, known limitations and the full docs), which it reads only when needed.

The zip contains one folder, ybx-trading-api/. The reference files are rebuilt with every release of this site, so they always match these pages.

Install for Claude Code

For yourself, in every project:

cURL / shell
mkdir -p ~/.claude/skills
curl -fsSL -o /tmp/ybx-trading-api-skill.zip https://<docs-site>/ybx-trading-api-skill.zip
unzip -o /tmp/ybx-trading-api-skill.zip -d ~/.claude/skills/

For one repository — commit it and everyone working in the repository gets it:

cURL / shell
mkdir -p .claude/skills
curl -fsSL -o /tmp/ybx-trading-api-skill.zip https://<docs-site>/ybx-trading-api-skill.zip
unzip -o /tmp/ybx-trading-api-skill.zip -d .claude/skills/

Either way the result is skills/ybx-trading-api/SKILL.md. Claude Code discovers the skill on its next start and uses it whenever a task involves this API. To update, download and unzip again.

Other agents

Any agent that supports the Agent Skills format can use the same folder — for example, upload the zip as a custom skill in Claude apps. Agents without skill support can be given /llms.txt or the contents of SKILL.md as instructions.