> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.

# AI assistants and agents

> Point an AI assistant or agent at the right 0xArchive source and interface, get answers that name the correct route, and know what to check before answering.

Give an AI assistant the 0xArchive context it needs to answer questions, plan a request, or write code that calls the right route. The assistant reads the same contract a developer does: OpenAPI for route shapes, the docs for concepts, and venue coverage for what exists where. When the assistant will run requests itself, follow [Coding agents](/coding-agents) instead.

## Give the assistant context

| Source | What it gives the assistant |
| - | - |
| `https://docs.0xarchive.io/llms.txt` | An index of the docs with a one-line summary per page, so the assistant can pick the page that matches a question |
| `https://docs.0xarchive.io/llms-full.txt` | The full docs in one file, for assistants with a large context window |
| Any page as Markdown | Add `.md` to a page address, such as `https://docs.0xarchive.io/coding-agents.md`, or use the **Copy page** menu, which copies the page or opens it in ChatGPT, Claude, Perplexity, Cursor, and other assistants |
| [OpenAPI](/openapi) | Exact paths, parameters, and response schemas for generated code |
| [MCP server](/mcp-server) | Live market data inside a chat assistant through typed tools. It signs in with OAuth and needs no 0xArchive API key |

Point the assistant at the narrowest source that answers the question. A page's Markdown is better context for one task than the whole docs file, and OpenAPI beats prose whenever the answer is a request.

## Where answers should come from

| Question | Where to look |
| - | - |
| Which route should I call? | [Endpoint reference](/api-reference) or [OpenAPI](/openapi), then [Venue coverage](/venue-coverage) for Hyperliquid core, Spot, HIP-3, HIP-4, or Lighter |
| Which symbol family is this? | [Venues and market types](/core-concepts/venue-taxonomy): `prefix:NAME` for HIP-3, outcome sides such as `#0` for HIP-4, dashed pairs for Spot |
| How do I authenticate? | [REST authentication](/rest-api/authentication): `X-API-Key` for REST and API-key workflows; the hosted MCP server uses OAuth instead |
| What does a response look like? | [Examples](/examples) and [Example responses](/response-examples), then the endpoint's own schema in OpenAPI |
| Is the data window usable? | [Data quality](/data-quality): coverage, incidents, latency, or SLA before a backtest, alert, export, dashboard, or model relies on it |
| Which tool fits my setup? | [Choose an interface](/tooling): REST, WebSocket, an SDK, the CLI, the MCP server, or the Agent skill |

Ask the assistant to cite the page or OpenAPI path it used, so you can check the route yourself.

## What a good answer includes

* **The venue family and the route,** so HIP-3, HIP-4, Spot, Lighter, and Hyperliquid core calls never collapse into one namespace.
* **The auth header or environment variable,** never a pasted key.
* **The time window, limit, and cursor behavior,** so a historical pull can be repeated.
* **The request ID to log:** `meta.request_id` on success, and the top-level `request_id` on an error.
* **A data-quality step** whenever the output feeds a decision.
* **The endpoint's own response contract.** Data-quality coverage routes return their own body rather than the `success`, `data`, and `meta` envelope.
* **A link to the exact docs page or OpenAPI path.**

## Check before answering

<AccordionGroup>
  <Accordion title="The venue family is missing">
    Ask whether the user means Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, or Lighter before naming a route.
  </Accordion>

  <Accordion title="The route is not in OpenAPI">
    Say the request is outside the public API rather than inventing a path.
  </Accordion>

  <Accordion title="Plan limits or prices are needed">
    Point to [Rate limits](/rate-limits) and the pricing page instead of quoting numbers from memory.
  </Accordion>

  <Accordion title="The setup cannot run the suggested tool">
    Do not give MCP setup to a client that cannot call MCP tools, or Agent skill setup to one that cannot load `SKILL.md` files.
  </Accordion>

  <Accordion title="The output feeds decisions">
    Add a data-quality check before writing a backtest, alert, export, dashboard, or model job.
  </Accordion>
</AccordionGroup>

## Prompt patterns

<Prompt description="Use 0xArchive to pull Hyperliquid BTC trades for the hour that ended one hour ago. Include the exact REST route, auth header, Unix-millisecond query values, pagination behavior, and the fields I should log.">Use 0xArchive to pull Hyperliquid BTC trades for the hour that ended one hour ago. Include the exact REST route, auth header, Unix-millisecond query values, pagination behavior, and the fields I should log.</Prompt>

<Prompt description="I have a HIP-3 symbol shaped like xyz:XYZ100. Pick the correct 0xArchive route family, show one request, and explain how to check freshness first.">I have a HIP-3 symbol shaped like xyz:XYZ100. Pick the correct 0xArchive route family, show one request, and explain how to check freshness first.</Prompt>

<Prompt description="Write a Python script that checks coverage and incidents for one closed Lighter BTC order-book window, then pulls that window only if it is covered and no incident overlaps it.">Write a Python script that checks coverage and incidents for one closed Lighter BTC order-book window, then pulls that window only if it is covered and no incident overlaps it.</Prompt>

Good prompts name the venue family, the symbol, the data, the window, and what the output is for.

## Next step

When the assistant should run requests itself, set it up with [Coding agents](/coding-agents).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.