Skip to content

AI Integration ​

VALR API documentation is available in machine-readable formats designed for use with AI coding assistants, agents, and automated tooling. These follow the llms.txt standard — a convention for providing LLM-friendly content alongside traditional web documentation.

Available Endpoints ​

URLDescription
/llms.txtIndex of all documentation pages with titles and links
/llms-full.txtComplete documentation as a single markdown file

llms.txt ​

A lightweight index listing every documentation page — guides, API endpoints, and WebSocket operations — with titles and URLs. Use this when you need to find specific topics or endpoints without loading the full documentation.

llms-full.txt ​

The entire documentation site rendered as a single markdown file, including all guide content and every REST API endpoint with request/response schemas. Use this when you need comprehensive context about the VALR API — for example, when building an integration from scratch or answering broad questions about available functionality.

Usage with AI Tools ​

Cursor, Windsurf, and Similar IDEs ​

Most AI-powered IDEs support adding documentation URLs as context. Add the full documentation URL to give your AI assistant complete knowledge of the VALR API:

https://your-docs-site/llms-full.txt

Refer to your IDE's documentation for the specific method — typically this is done through a project-level documentation or context configuration.

Claude Code ​

Reference the documentation URL directly in your prompt or add it as project context:

claude "Using the VALR API docs at https://your-docs-site/llms-full.txt, help me implement order placement"

ChatGPT, Claude, and Other Chat Interfaces ​

Paste the contents of /llms-full.txt into your conversation, or provide the URL if the tool supports fetching web content.

Custom Agents and Automation ​

Fetch the documentation programmatically for use in agent pipelines or RAG systems:

curl -s https://your-docs-site/llms-full.txt

The content is plain markdown, so no parsing is required — it can be passed directly into an LLM context window.

What's Included ​

Both files are generated automatically from the same sources that power this documentation site:

  • Guides — authentication, rate limiting, error codes, caching, performance, and WebSocket usage
  • REST API endpoints — every operation from the OpenAPI specification, including request parameters, response schemas, and example values
  • WebSocket operations — real-time streaming API documentation

The content is regenerated on every deployment, so it stays in sync with the latest API specification.

The llms.txt Standard ​

The /llms.txt convention is an emerging standard for making website content accessible to large language models. Rather than requiring AI tools to parse HTML pages, sites provide pre-formatted markdown at well-known URLs. For more detail on the standard, see llmstxt.org.