Skip to main content
Buildmarkets provides three machine-readable documentation resources optimized for AI coding assistants. Feed these into your AI tool of choice to get precise, hallucination-free help with your integration — from writing API calls to handling specific error codes.

​
llms.txt

The llms.txt file is an emerging industry standard that helps AI tools index documentation more efficiently — similar to how a sitemap.xml helps search engines. It provides a structured overview of all available Buildmarkets documentation pages with concise summaries. Use llms.txt when you want your AI assistant to understand the structure of the Buildmarkets docs and navigate to the right page for a given question. The llms.txt file is available on this docs site and provides a structured index of all Buildmarkets documentation pages.

​
llms-full.txt

The llms-full.txt file combines the entire documentation site into a single file. Paste it as context in your AI tool to give it comprehensive knowledge of every Buildmarkets API, workflow, and integration pattern in one shot. Use llms-full.txt when you want your AI assistant to answer questions that span multiple guides — for example, understanding the full flow from account creation through trading. The llms-full.txt file is available on this docs site and contains the full documentation content in a single file.
Both documentation files are always up to date and require zero maintenance on your part.

​
API specification

The Buildmarkets OpenAPI 3.0 specification documents every endpoint with precise request parameters, response schemas, and error messages. This is the most reliable source for exact field names, types, and constraints. Use the OpenAPI spec when you need your AI assistant to generate correct API calls, validate request bodies, or understand specific response shapes. The OpenAPI 3.0 specification is available on this docs site under the API reference section, and contains all endpoints and schemas.

​
Best practices for AI coding assistants

Follow these practices to get the most accurate help from AI tools when building on Buildmarkets:
  1. Reference llms-full.txt for comprehensive context — copy the file content as context before asking integration questions. This prevents the AI from inventing API signatures or field names.
  2. Use the OpenAPI spec for implementation details — when writing or reviewing API calls, point your assistant at the spec to ensure exact parameter names, enum values, and required fields are correct.
  3. Include specific error handling based on documented error responses — see the Error Codes reference for every BLUM-{STATUS}-{SEQ} code and its resolution.
  4. Follow authentication patterns outlined in the Authentication guide — the AI can help you implement Basic Auth correctly once it has the spec as context.