# REST API

## Video walkthrough

The below walkthrough provides an overview of its REST API.

{% embed url="<https://youtu.be/exXi4-5M6Z8>" %}

### Accessing the OpenAPI endpoint

To access the Swagger docs for the API, which allow you to easily query the API, head to `<your-instance-url>/api`.

Swagger also makes it straight forwards to test API queries.

<figure><img src="/files/LW8YduaEFf8QBfkGBQ15" alt=""><figcaption><p>The OpenAPI endpoint</p></figcaption></figure>

This API makes available all data you see in the user interface. This, combined with the filtering functionality and the contract registry, allows you to easily create custom reports for your blockchain applications, such as details of all transfer events associated with a specific token.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.chainlens.com/features/rest-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
