# Welcome to Avantis Trader SDK’s documentation!
Avantis Trader SDK is a powerful and flexible toolkit for trading on the Avantis platform. This documentation will guide you through the installation process, basic usage, and advanced features of the SDK.
## 📚 [Read the Full Documentation Here](https://sdk.avantisfi.com/)
Contents:
- [Introduction](#introduction)
- [About Avantis](#about-avantis)
- [Purpose of the Avantis Trader SDK](#purpose-of-the-avantis-trader-sdk)
- [Getting Started](#getting_started)
- [Installation](#installation)
- [Next Steps](#next-steps)
- [Examples](#examples)
# Introduction
Welcome to the Avantis Trader SDK, a powerful tool designed to interact with the Avantis decentralized exchange (DEX) and leverage its advanced features for trading and market-making in cryptocurrencies, forex, and commodities.
## About Avantis
[Avantis](https://avantisfi.com/) is at the forefront of decentralized leveraged trading platforms, offering users the ability to take long or short positions in synthetic crypto, forex, and commodities using perpetuals—a financial instrument that provides leverage without an expiration date. With synthetic leverage and a USDC stablecoin liquidity pool, Avantis achieves high capital efficiency, enabling a diverse selection of tradable assets and leverage up to 100x.
The platform also introduces fine-grained risk management for liquidity providers (LPs) through time and risk parameters. This innovation allows any LP to become a sophisticated market maker for a wide range of derivatives, starting with perpetuals.
Read more about Avantis at [https://docs.avantisfi.com/](https://docs.avantisfi.com/).
## Purpose of the Avantis Trader SDK
The Avantis Trader SDK is designed to simplify and enhance the experience of interacting with the Avantis DEX. It provides developers and traders with a set of tools to:
- Access real-time price feeds for supported trading pairs.
- Retrieve and analyze key parameters for assets, categories, and trading strategies.
- Integrate live price updates into applications or trading algorithms.
- Execute trades and manage positions on the Avantis platform.
Whether you are a developer building decentralized finance (DeFi) applications, a trader seeking to automate your strategies, or a market maker looking to optimize your operations, the Avantis Trader SDK offers the functionality you need to succeed in the rapidly evolving world of decentralized trading.
# Getting Started
## Installation
To get started with the Avantis Trader SDK, follow these steps to install the package:
1. Ensure you have Python 3.6 or later installed on your system.
2. Install the SDK using pip:
```bash
pip install avantis-trader-sdk
```
or
```bash
pip install git+https://github.com/Avantis-Labs/avantis_trader_sdk.git
```
Alternatively, if you have a local copy of the source:
```bash
git clone https://github.com/yourusername/avantis-trader-sdk.git
cd avantis-trader-sdk
pip install .
```
3. Verify the installation:
```python
import avantis_trader_sdk
print(avantis_trader_sdk.__version__)
```
If the installation was successful, this command should print the version number of the Avantis Trader SDK.
## Next Steps
Once you have installed the Avantis Trader SDK, you can start using it to interact with the Avantis platform. Here are some things you might want to do next:
- Explore the SDK’s features and capabilities.
- Access real-time price feeds for various trading pairs.
- Integrate the SDK into your trading algorithms or DeFi applications.
## Examples
You can find practical examples and sample code for using the Avantis Trader SDK in our GitHub repository. These examples are designed to help you get started quickly and explore the capabilities of the SDK.
📂 [Browse the Examples on GitHub](https://github.com/Avantis-Labs/avantis_trader_sdk/tree/main/examples)
## 📚 [Read the Full Documentation Here](https://sdk.avantisfi.com/)
Raw data
{
"_id": null,
"home_page": "https://avantisfi.com/",
"name": "avantis-trader-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "trading sdk blockchain ethereum web3 avantis",
"author": "Avantis Labs",
"author_email": "brank@avantisfi.com",
"download_url": "https://files.pythonhosted.org/packages/67/48/e6827df167f8e9728bbe26e7ef32f86e722b9792b62c5f2898f2bb20e695/avantis_trader_sdk-0.4.0.tar.gz",
"platform": null,
"description": "# Welcome to Avantis Trader SDK\u2019s documentation!\r\n\r\nAvantis Trader SDK is a powerful and flexible toolkit for trading on the Avantis platform. This documentation will guide you through the installation process, basic usage, and advanced features of the SDK.\r\n\r\n## \ud83d\udcda [Read the Full Documentation Here](https://sdk.avantisfi.com/)\r\n\r\nContents:\r\n\r\n- [Introduction](#introduction)\r\n - [About Avantis](#about-avantis)\r\n - [Purpose of the Avantis Trader SDK](#purpose-of-the-avantis-trader-sdk)\r\n- [Getting Started](#getting_started)\r\n - [Installation](#installation)\r\n - [Next Steps](#next-steps)\r\n - [Examples](#examples)\r\n\r\n# Introduction\r\n\r\nWelcome to the Avantis Trader SDK, a powerful tool designed to interact with the Avantis decentralized exchange (DEX) and leverage its advanced features for trading and market-making in cryptocurrencies, forex, and commodities.\r\n\r\n## About Avantis\r\n\r\n[Avantis](https://avantisfi.com/) is at the forefront of decentralized leveraged trading platforms, offering users the ability to take long or short positions in synthetic crypto, forex, and commodities using perpetuals\u2014a financial instrument that provides leverage without an expiration date. With synthetic leverage and a USDC stablecoin liquidity pool, Avantis achieves high capital efficiency, enabling a diverse selection of tradable assets and leverage up to 100x.\r\n\r\nThe platform also introduces fine-grained risk management for liquidity providers (LPs) through time and risk parameters. This innovation allows any LP to become a sophisticated market maker for a wide range of derivatives, starting with perpetuals.\r\n\r\nRead more about Avantis at [https://docs.avantisfi.com/](https://docs.avantisfi.com/).\r\n\r\n## Purpose of the Avantis Trader SDK\r\n\r\nThe Avantis Trader SDK is designed to simplify and enhance the experience of interacting with the Avantis DEX. It provides developers and traders with a set of tools to:\r\n\r\n- Access real-time price feeds for supported trading pairs.\r\n- Retrieve and analyze key parameters for assets, categories, and trading strategies.\r\n- Integrate live price updates into applications or trading algorithms.\r\n- Execute trades and manage positions on the Avantis platform.\r\n\r\nWhether you are a developer building decentralized finance (DeFi) applications, a trader seeking to automate your strategies, or a market maker looking to optimize your operations, the Avantis Trader SDK offers the functionality you need to succeed in the rapidly evolving world of decentralized trading.\r\n\r\n# Getting Started\r\n\r\n## Installation\r\n\r\nTo get started with the Avantis Trader SDK, follow these steps to install the package:\r\n\r\n1. Ensure you have Python 3.6 or later installed on your system.\r\n2. Install the SDK using pip:\r\n\r\n ```bash\r\n pip install avantis-trader-sdk\r\n ```\r\n\r\n or\r\n\r\n ```bash\r\n pip install git+https://github.com/Avantis-Labs/avantis_trader_sdk.git\r\n ```\r\n\r\n Alternatively, if you have a local copy of the source:\r\n\r\n ```bash\r\n git clone https://github.com/yourusername/avantis-trader-sdk.git\r\n cd avantis-trader-sdk\r\n pip install .\r\n ```\r\n\r\n3. Verify the installation:\r\n\r\n ```python\r\n import avantis_trader_sdk\r\n print(avantis_trader_sdk.__version__)\r\n ```\r\n\r\n If the installation was successful, this command should print the version number of the Avantis Trader SDK.\r\n\r\n## Next Steps\r\n\r\nOnce you have installed the Avantis Trader SDK, you can start using it to interact with the Avantis platform. Here are some things you might want to do next:\r\n\r\n- Explore the SDK\u2019s features and capabilities.\r\n- Access real-time price feeds for various trading pairs.\r\n- Integrate the SDK into your trading algorithms or DeFi applications.\r\n\r\n## Examples\r\n\r\nYou can find practical examples and sample code for using the Avantis Trader SDK in our GitHub repository. These examples are designed to help you get started quickly and explore the capabilities of the SDK.\r\n\r\n\ud83d\udcc2 [Browse the Examples on GitHub](https://github.com/Avantis-Labs/avantis_trader_sdk/tree/main/examples)\r\n\r\n## \ud83d\udcda [Read the Full Documentation Here](https://sdk.avantisfi.com/)\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SDK for interacting with Avantis trading contracts.",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://avantisfi.com/"
},
"split_keywords": [
"trading",
"sdk",
"blockchain",
"ethereum",
"web3",
"avantis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1279e96281da6fa013e15d68661f62ea79e0e649ebb5551d00bd53410fe80853",
"md5": "f7015a4c61ead1ffc91d0e3a89244a74",
"sha256": "2e0a6436aab13661d562adf62fadcc04a9b1977d20e9bfba05dd22cd279c92cc"
},
"downloads": -1,
"filename": "avantis_trader_sdk-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7015a4c61ead1ffc91d0e3a89244a74",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9353278,
"upload_time": "2024-12-02T10:51:42",
"upload_time_iso_8601": "2024-12-02T10:51:42.962447Z",
"url": "https://files.pythonhosted.org/packages/12/79/e96281da6fa013e15d68661f62ea79e0e649ebb5551d00bd53410fe80853/avantis_trader_sdk-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6748e6827df167f8e9728bbe26e7ef32f86e722b9792b62c5f2898f2bb20e695",
"md5": "1d4cbe2a132ba5c520baea3fc5c81439",
"sha256": "cdb37da4d8b06d3d5d41240d0060a9bbf2b16ec34433deb5fbd8866f174db1f7"
},
"downloads": -1,
"filename": "avantis_trader_sdk-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "1d4cbe2a132ba5c520baea3fc5c81439",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8963149,
"upload_time": "2024-12-02T10:51:47",
"upload_time_iso_8601": "2024-12-02T10:51:47.198165Z",
"url": "https://files.pythonhosted.org/packages/67/48/e6827df167f8e9728bbe26e7ef32f86e722b9792b62c5f2898f2bb20e695/avantis_trader_sdk-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 10:51:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "avantis-trader-sdk"
}
JSON