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

# Client API reference

The client operation reference is not yet published. It will list every **approved** client-facing operation from a versioned OpenAPI contract, with method, path, request and response schemas, authentication, error responses, and examples. This page does not substitute for that contract.

The reference will group operations by API function, rather than by portal screen:

| Reference group                 | Contract coverage to review                                                                         |
| ------------------------------- | --------------------------------------------------------------------------------------------------- |
| Authentication and sessions     | Registration, sign-in, session management, and verification operations approved for integrators.    |
| Client profile and verification | Profile and identity-verification data and submissions that are permitted for external use.         |
| Accounts and trading            | Trading accounts, quotes/history, positions, orders, and related client operations where supported. |
| Funding and transactions        | Available payment methods, deposit and withdrawal requests, transfers, and transaction status.      |
| Support and communication       | Tickets, notifications, and client messages where supported.                                        |

The live REST service's Swagger route is not available in the checked QA and production environments, and no approved client-only OpenAPI export is stored in this docs repository. A source-code route list would omit important schema and security details, so it is not published as an API reference. The API owner and security reviewer must approve the supported audience and operation set before the generated reference replaces this status page.

For the release requirements, see [Contract and compatibility](/rest-api/contract-and-compatibility.md).


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.brokvix.com/rest-api/client-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.