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

# API Reference

> Overview of Intention's planned REST, WebSocket, and integration APIs for traders and builders.

This is the landing page for Intention's developer API surface. The protocol is being designed to expose three integration tracks — a REST API, a WebSocket API, and a set of integration endpoints (bridge, builder codes, listing hooks) — alongside direct node-level access to the Verifiable Execution Stream.

<Note>
  Status: not yet published. Intention has not released a stable OpenAPI specification or finalized endpoint URLs. The pages in this section are placeholders that describe what each track will eventually contain. Endpoint paths, request/response schemas, authentication details, and rate limits will be confirmed at launch.
</Note>

## Tracks

<CardGroup cols={2}>
  <Card title="REST" href="/api-reference/rest/info">
    Read endpoints (markets, account state, positions, fills, order book) and write endpoints (place, modify, cancel, batch).
  </Card>

  <Card title="WebSocket" href="/api-reference/websocket/subscriptions">
    Streaming subscriptions for market data and account events, with heartbeats and a post channel for low-latency order flow.
  </Card>

  <Card title="Integration" href="/api-reference/integration/bridge">
    Bridge deposits and withdrawals, builder codes for affiliate flows, and listing hooks for new-market lifecycle events.
  </Card>

  <Card title="Nodes" href="/api-reference/nodes/foundation-node">
    Run a foundation node, consume the Verifiable Execution Stream, and use the published data schemas.
  </Card>
</CardGroup>

## Conventions

Before consuming any endpoint, read the [conventions](/api-reference/conventions/notation) section, which covers field notation, asset identifiers, tick and lot rules, nonces, signing, rate limits, and error codes. These rules are shared across REST, WebSocket, and integration endpoints.

## Contact

Integrators with early-access requirements — market makers, aggregators, wallet developers, data providers — should contact `contact@intention.xyz` to coordinate.