Skip to main content

Python Interface for and API

Project description


Python interface for API.

This is currently not a complete implementation of the Agoradesk API.

The following API calls are currently not supported.

  • Image uploading in chat

I offer no warranty of any kind -- use this at your own risk!

I am not associated with or


The two main requirements are httpx and arrow. I am using Poetry with this project to keep track of dependencies / requirements.


pip install agoradesk_py

How to Use

This is an example about how you can use the library

#!/usr/bin/env python3

from agoradesk_py.agoradesk import AgoraDesk

api_key = <YourAPIKey>

api = AgoraDesk(api_key)

# Get information about all released trades
api_response = api.dashboard_released()

if api_response["success"]:
    trades = api_response["response"]["data"]["contact_list"]

    for trade in trades:
        trade_data = trade["data"]
            f"Traded "
            f"{trade_data['amount_xmr']} XMR with a fee of {trade_data['fee_xmr']} XMR "
            f"for {trade_data['amount']} {trade_data['currency']} "
            f"on {trade_data['released_at']}"

     print(f"Error: {api_response['response']['error']}")

Running Tests

Please be aware of the unauthenticated API requests limit of 20 req/h

Tests are split into Unit tests and integration tests.

To prepare to run any tests:

  1. Clone this repository to your computer.
  2. Install Poetry
  3. Install all dependencies / requirements for agoradesk_py using the command poetry install in the project directory.

Unit Tests

Unit tests do not communicate with LocalMonero / AgoraDesk and are executed entirely locally.

Running all unit tests with coverage report is as easy as using the command poetry run pytest --cov-report term-missing tests/unit/ in the project directory,

Integration Tests

Integration tests communicate with the actual LocalMonero / AgoraDesk production APIs and the tests depend on the two following environment variables being set to the api_keys of two testing accounts at

  • api_key
  • api_key2

Please be aware that:

  • or are not currently providing a testing setup and all testes are running in their production environment.
  • For some tests to run successfully the account for api_key2 needs to have a balance of currently about 0.1 XMR
  • The two testing account need to be set to trust each other for all the tests to be successful.

To run the integration tests use the command poetry run pytest tests/integration/


Do you have an idea or found a bug in agoradesk_py? Please file an issue and/or submit a pull request! :)

Source code is currently on Codeberg at


If you like the API and want to support me you can do so with Monero: 88NszkQU9qsafT9obFaDZSi7RvHSM76exJ1vvgVShTwM4HjvLr7XjJ7jDkFGnxr3UsDXLgT5t569N6uB7Gn4znjAFjUuN1q

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agoradesk_py-0.3.1.tar.gz (21.6 kB view hashes)

Uploaded source

Built Distribution

agoradesk_py-0.3.1-py3-none-any.whl (19.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page