> For the complete documentation index, see [llms.txt](https://docs.iexexchanger.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iexexchanger.com/get-started/exchanger-api/api-reference/openapi-reference.md).

# Как читать API Reference

API Reference построен из файла:

```
openapi/openapi.yaml
```

Это точный контракт API: endpoints, параметры, request body, headers, responses, security и схемы данных.

## Когда открывать API Reference

Открывайте API Reference, когда нужно узнать:

* какой HTTP method использовать;
* какой path у endpoint;
* какие query parameters доступны;
* какие поля передавать в JSON body;
* какие headers нужны;
* какой scope требуется ключу;
* какие ответы может вернуть API.

## Как пользоваться вместе с руководствами

Руководства показывают порядок действий. API Reference показывает точные детали запроса.

Пример:

1. В guide [Расчет, preflight и создание заявки](/get-started/exchanger-api/obmen-i-zayavki/quotes-preflight-orders.md) описан сценарий создания заявки.
2. На странице [Exchange API Reference](/get-started/exchanger-api/api-reference/exchange.md) можно открыть точный endpoint `POST /private/exchange/orders`.
3. В [Scopes и права ключа](/get-started/exchanger-api/spravochnik/scopes.md) можно проверить, какие права нужны ключу.

## Группы API Reference

| Страница                                                                             | Что смотреть                                                               |
| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| [System](/get-started/exchanger-api/api-reference/system.md)                         | Ping, OpenAPI-файл и приватный ping.                                       |
| [Security](/get-started/exchanger-api/api-reference/security.md)                     | Список scopes, доступных API-ключу.                                        |
| [Client и Usage](/get-started/exchanger-api/api-reference/client-usage.md)           | Проверка ключа, профиль клиента, usage и квоты.                            |
| [Platform contracts и schemas](/get-started/exchanger-api/api-reference/platform.md) | Версии контрактов и JSON Schema.                                           |
| [Exchange](/get-started/exchanger-api/api-reference/exchange.md)                     | Платежные системы, направления, quote, preflight, создание заявки, статус. |
| [Orders](/get-started/exchanger-api/api-reference/orders.md)                         | Список заявок и справочник статусов.                                       |
| [Files](/get-started/exchanger-api/api-reference/files.md)                           | Upload intents и загрузка файлов.                                          |
| [Verifications](/get-started/exchanger-api/api-reference/verifications.md)           | Требования, identity/card verification и проверки по заявке.               |
| [Webhooks](/get-started/exchanger-api/api-reference/webhooks.md)                     | Webhook endpoints, события, доставки, retry.                               |
| [Partner](/get-started/exchanger-api/api-reference/partner.md)                       | Партнерская сводка, статистика, рефералы, обмены и выплаты.                |
| [Reviews](/get-started/exchanger-api/api-reference/reviews.md)                       | Чтение отзывов и создание отзыва по заявке.                                |
| [Sandbox](/get-started/exchanger-api/api-reference/sandbox.md)                       | Тестовая симуляция заявки без реального обмена.                            |

## OpenAPI-файл

Файл можно использовать в инструментах разработчика:

* импортировать в Postman;
* импортировать в Insomnia;
* открыть в Swagger UI;
* использовать для генерации собственного клиента.

Live OpenAPI на установленном обменнике:

```
https://{your-domain}/api/v3/openapi.yaml
```

Если вы работаете с конкретным обменником, используйте OpenAPI с его домена, чтобы видеть актуальный контракт именно этой установки.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.iexexchanger.com/get-started/exchanger-api/api-reference/openapi-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.