> ## 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.

# API playground

> Use the interactive API playground and curl examples to inspect 0xArchive REST routes, parameters, responses, authentication, and schemas.

Run a real REST request from your browser on any [Endpoint reference](/api-reference) page, inspect the response, then copy the same call into curl, Python, JavaScript, or Go.

You need an API key to send requests. New accounts start on the Free tier with no card required: <a href="https://0xarchive.io/dashboard?utm_source=docs&utm_medium=referral&utm_campaign=growth_funnel&utm_content=create-key-cta" data-oxa-cta="create-key">create a key in the dashboard</a>.

## Run a request

<Steps>
  <Step title="Choose an endpoint">
    Start with a low-cost market-state route such as a Hyperliquid order book.
  </Step>

  <Step title="Add your API key">
    Use the `X-API-Key` auth control on the endpoint page.
  </Step>

  <Step title="Run the request">
    Inspect `success`, `data`, and `meta.request_id`.
  </Step>

  <Step title="Copy the code example">
    Move the same request into curl, Python, JavaScript, or Go. The [Quickstart](/quickstart) runs the same flow from a terminal.
  </Step>
</Steps>

## What the playground is for

Use the playground to confirm route shape, auth, parameters, and response fields before writing code. It is especially useful when you are choosing between route families: compare a Hyperliquid core example, a Spot pair, a HIP-3 namespaced symbol, a HIP-4 outcome, and a Lighter symbol before committing a route to a client.

A playground success confirms that one route answers with the key and parameters you gave it; it is not a substitute for production error handling. After you copy an example, add key management, retries, request-ID logging, pagination, limit handling, and data-quality checks wherever downstream use depends on correctness.

If a request fails in the browser but the generated curl example works, continue from curl: it shows the exact method, path, parameters, and `X-API-Key` header, and does not depend on the browser's auth or CORS environment. If both fail, keep the status, error code, route, parameters, and request ID together before you debug the client.

## Test safely

Start with low-cost market-state routes, then move to historical windows. Keep query parameters narrow while testing: one symbol, one route, one time window, and a small `limit`. Once the response is understood, move to the CLI, an SDK, REST code, or OpenAPI codegen for repeatable work.

## Next step

Pick where the request will run in production with [Choose an interface](/tooling).


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