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

# API reference

This resource is designed to provide comprehensive information on how to integrate and interact with our API. Whether you're a seasoned developer or new to API usage, this guide will help you understand the endpoints, request formats, response structures, and error handling mechanisms necessary to effectively use our services.

Key features of our API include:

* **RESTful Architecture:** Adheres to REST principles for easy and intuitive interaction.
* **Authentication:** Secure access through OAuth 2.0.
* **Data Formats:** Supports JSON for streamlined data exchange.
* **Comprehensive Endpoints:** Extensive coverage of operations to manage resources and access data.
* **Error Handling:** Detailed error messages and status codes to assist in troubleshooting.

Dive into the specifics of each endpoint to start building robust and scalable applications with our API. For additional support, contact our technical support team.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.live-eo.com/tradeaware/using-the-tradeaware-api/api-reference.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 `automate deployments from our CI pipeline` 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.