llms.txt and Markdown

AI tools can read the CoinGlass API docs directly: llms.txt is an index of published docs, and adding .md to the end of any doc page URL gives you that page's Markdown source. Give them to your AI coding tool or knowledge base for more accurate answers.

Key Facts
ItemDetails
English docs indexhttps://docs.coinglass.com/llms.txt
Simplified Chinese docs indexhttps://docs.coinglass.com/v4.0-zh/llms.txt
Single-page sourceAdd .md to the end of any doc page URL; the Markdown of an endpoint page includes that endpoint's OpenAPI definition
Page actionsThe Copy Page menu to the right of each doc page title lets you copy the page, view it as Markdown, or open it in ChatGPT or Claude
API KeyNot needed to read the docs

Two Ways to Read the Docs

MethodDescription
llms.txt: docs indexLists the titles and URLs of published, non-hidden doc pages. Useful for letting AI get an overview of the docs first and then read specific pages as needed.
https://docs.coinglass.com/llms.txt
.md: single-page sourcePlain text without navigation or styling; endpoint pages also include the OpenAPI definition. Useful for pasting into a chat or storing in a knowledge base.
https://docs.coinglass.com/reference/authentication.md
# Docs index
curl https://docs.coinglass.com/llms.txt

# Single-page Markdown
curl https://docs.coinglass.com/reference/authentication.md

One-Click Copy on Doc Pages

Every doc page has a Copy Page button and drop-down menu to the right of its title, so you do not need to edit the URL by hand:

ButtonWhat It Does
Copy PageCopies this page's content so you can paste it into an AI chat
View as MarkdownOpens this page's .md source in a new tab
Open in ChatGPT / Open in ClaudeOpens this page in the corresponding AI tool so you can ask questions directly

Common Uses

ScenarioHow
AI coding toolsAdd the llms.txt URL to the tool's docs context so it writes code against the latest endpoints
AI chatCopy the Markdown of the relevant pages and send it together with your question
Enterprise knowledge baseRegularly crawl the .md pages listed in llms.txt to keep the docs in sync

Language Versions

Languagellms.txt URL
Simplified Chinesehttps://docs.coinglass.com/v4.0-zh/llms.txt
Traditional Chinesehttps://docs.coinglass.com/v4.0-zhtw/llms.txt
Englishhttps://docs.coinglass.com/llms.txt

FAQ

Do I need an API Key to read llms.txt?

No. llms.txt and the .md pages are public docs; an API Key is needed only when calling data endpoints.

Is llms.txt kept in sync when the docs are updated?

Yes. CoinGlass uses ReadMe’s automatically generated llms.txt. The index updates automatically as published docs change, with no manual maintenance required. It lists page titles and URLs, not the full page bodies; read the corresponding .md pages for endpoint details. Hidden pages and unpublished versions are not included in the public index.

What is in the .md version of an endpoint page?

Besides the page body and response examples, the Markdown of an endpoint page ends with that endpoint's OpenAPI definition (parameters, types, response structure), which is useful for having AI generate code to call it.

About llms.txt and AI Reading the Docs

What Is llms.txt?

llms.txt is a text index written specifically for large language models to read. It lists a site's important pages with short descriptions, helping AI quickly find accurate documentation.

How Do I Add the CoinGlass Docs to a RAG Knowledge Base?

First crawl llms.txt to get the list of pages, then download the .md version of each page, split them by heading and write them into a vector database; re-crawl periodically to keep them in sync.

Why Does AI-Written CoinGlass Code Have Errors?

The model's training data may contain older versions of the endpoints. Give the AI llms.txt or the Markdown of the relevant pages, and it can generate code with the latest V4 paths and parameters.

Related Docs