Metadata-Version: 2.1
Name: absurdia
Version: 0.0.6
Summary: Python bindings for the Absurdia API
Home-page: https://github.com/absurdia/absurdia-py
Author: Absurdia
Author-email: support@absurdia.markets
License: MIT
Project-URL: Bug Tracker, https://github.com/absurdia/absurdia-py/issues
Project-URL: Changes, https://github.com/absurdia/absurdia-py/blob/master/CHANGELOG.md
Project-URL: Source Code, https://github.com/absurdia/absurdia-py
Keywords: absurdia api trading
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.4, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Description-Content-Type: text/markdown
License-File: LICENSE

# Official Absurdia Bindings for Python
![PyPI](https://img.shields.io/pypi/v/absurdia?style=flat-square)

A Python library for Absurdia's API.

## Install

You can install this package by using the pip tool and installing:

    $ pip install absurdia


## Signing up to Absurdia backtesting

Sign up for Absurdia at https://app.absurdia.markets/signup.

## Using the the package

Create a new agent in (your dashboard)[https://app.absurdia.markets/agents] and 
download the credential file. Use the agent token with the client as in the example blow.

```python
from absurdia import Client

# Create client
client = Client('<Your Agent Token>')

# Get your account
account = client.accounts.current()
```

Alternatively, use the environment variable `ABSURDIA_TOKEN`, or put the credential file in the same directory as your Python script.

## Import a Freqtrade backtest

Freqtrade backtests are run using its CLI. This Python library also comes with a CLI that can work together with Freqtrade's commands. First, add a token to authenticate your agent:

```shell
$ absurdia login --token '<Your Agent Token>'
```

Once authenicated, simply append `absurdia backtest --` to your Freqtrade backtesting command. For example:

```shell
$ absurdia backtest --freqtrade backtesting --strategy AwesomeStrategy --timeframe 1m
```

## License

Licensed under the BSD 3 license, see [LICENSE](LICENSE).
