# API

The Komunitin Accounting API defines a protocol to make transfers and transfer requests between members of exchange communities. It is a HTTP REST JSON api following the [JSON:API](https://jsonapi.org) specification.

It can be used for simple transfers between members of the same exchange community but can also be used to make external transfers between members of different exchange communities automatically following a path of one or more currency exchange steps. The api has methods for creating and managing currencies, accounts, etc.

There is an OpenAPI spec file automatically generated from the test suite [here](https://github.com/community-exchange-network/komunitin/blob/master/accounting/openapi/openapi_v3.json). You can browse it using Swagger:

{% embed url="<https://petstore.swagger.io/?url=https://raw.githubusercontent.com/komunitin/komunitin/refs/heads/master/accounting/openapi/openapi_v3.json>" %}
Komunition accounting API auto-generated specs
{% endembed %}


---

# 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.komunitin.org/technology/accounting/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.