The machine-readable files describe the API; they do not grant access or bypass signing. Read requests still use
POST /info, while state-changing requests require a valid signed envelope sent to POST /exchange.Available files
llms.txt
A compact index of documentation pages with titles, descriptions, and links. Start here when an agent needs to discover the right source before loading more context.
llms-full.txt
The full published documentation rendered as one Markdown document. Use it for broad code-generation tasks, offline indexing, or retrieval pipelines.
Which file should you use?
Recommended retrieval workflow
1
Fetch the index
Load
llms.txt and identify the pages related to the user’s task, such as authentication, order placement, account state, or WebSocket subscriptions.2
Retrieve authoritative pages
Fetch the selected documentation pages and keep their URLs or paths alongside the extracted text so the agent can cite its source.
3
Generate a structured proposal
Ask the model for typed data or code rather than an unstructured instruction. For trading actions, require a JSON proposal that can be validated before signing.
4
Validate outside the model
Apply strict schemas, precision rules, risk limits, allowed-action lists, and nonce management in deterministic application code.
5
Refresh when the docs change
Re-fetch the index at application startup or on a controlled schedule, then update only the changed pages in your local cache or retrieval index.
Use with coding assistants
Claude Code or similar CLI agents
Fetch the full document when the task spans multiple sections:Cursor, Windsurf, and IDE assistants
Add one of the URLs as a documentation source in the project’s context settings. Usellms.txt for everyday lookup and llms-full.txt for repository-wide client generation or refactoring.
A useful project rule is:
Custom agents
Fetch the index withcurl:
Prompt recipes
Endpoint discovery
Code generation
Payload review
Building a retrieval index
When indexingllms-full.txt for retrieval-augmented generation:
- Split primarily at page titles and section headings rather than arbitrary character counts.
- Store each chunk with its page URL, heading path, and document version or fetch time.
- Keep code blocks with the paragraph that explains them.
- Give authentication, nonce, error handling, and action-specific pages higher retrieval priority for write operations.
- Return source links with every generated answer so developers can verify the recommendation.
- Treat retrieved documentation as context, not executable authority; validate all generated writes independently.
High-value documentation paths
Authentication
Canonical JSON, signed-message construction, keccak256, and ECDSA signature formatting.
Nonce
Uniqueness and replay-protection requirements for every signing address.
Read API
Market, account, agent, and order queries through
POST /info.Write API
State-changing actions and the shared
POST /exchange envelope.WebSocket
Real-time market and private account streams for synchronized agent state.
Agent wallets
Authorization, expiry, monitoring, rotation, and revocation for automated signers.