compass.api-client

Name	compass.api-client JSON
Version	1.0.11 JSON
	download
home_page	None
Summary	Compass API
upload_time	2025-02-04 14:29:51
maintainer	None
docs_url	None
author	Compass Labs
requires_python	<4.0,>=3.8
license	NoLicense
keywords	openapi openapi-generator compass api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # compass.api_client


#### Welcome to the DeFi API from [Compass Labs](https://www.compasslabs.ai)!

Our API allows you to interact and transact in DeFi with ease.

We help you construct your transactions via a **simple REST API**.  
You maintain custody at all times and **sign** all transactions **yourself**.

Below is the documentation of our endpoints. It's a great first step to explore.



---

**Try out our [App](https://api-app.compasslabs.ai/) built on top of the API!**

---

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 1.0.0
- Generator version: 7.12.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.compasslabs.ai/](https://www.compasslabs.ai/)

## Requirements.

Python 3.8+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import compass.api_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import compass.api_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import compass.api_client
from compass.api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.compasslabs.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = compass.api_client.Configuration(
    host = "https://api.compasslabs.ai"
)



# Enter a context with an instance of the API client
with compass.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = compass.api_client.AaveV3Api(api_client)
    chain = compass.api_client.Chain() # Chain | 
    aave_get_asset_price = compass.api_client.AaveGetAssetPrice() # AaveGetAssetPrice | 

    try:
        # Get the price of an asset in USD according to Aave
        api_response = api_instance.process_request_v0_aave_asset_price_get_chain_post(chain, aave_get_asset_price)
        print("The response of AaveV3Api->process_request_v0_aave_asset_price_get_chain_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AaveV3Api->process_request_v0_aave_asset_price_get_chain_post: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.compasslabs.ai*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AaveV3Api* | [**process_request_v0_aave_asset_price_get_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_asset_price_get_chain_post) | **POST** /v0/aave/asset_price/get/{chain} | Get the price of an asset in USD according to Aave
*AaveV3Api* | [**process_request_v0_aave_borrow_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_borrow_chain_post) | **POST** /v0/aave/borrow/{chain} | Borrow against your collateral
*AaveV3Api* | [**process_request_v0_aave_repay_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_repay_chain_post) | **POST** /v0/aave/repay/{chain} | Return some or all tokens you borrowed
*AaveV3Api* | [**process_request_v0_aave_supply_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_supply_chain_post) | **POST** /v0/aave/supply/{chain} | Supply collateral to earn interest or borrow against
*AaveV3Api* | [**process_request_v0_aave_user_position_per_token_get_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_user_position_per_token_get_chain_post) | **POST** /v0/aave/user_position_per_token/get/{chain} | Get the user's position for a specific token.
*AaveV3Api* | [**process_request_v0_aave_user_position_summary_get_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_user_position_summary_get_chain_post) | **POST** /v0/aave/user_position_summary/get/{chain} | Get a summary of the user's position on AAVE. These values will be sums or averages across all open positions.
*AaveV3Api* | [**process_request_v0_aave_withdraw_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_withdraw_chain_post) | **POST** /v0/aave/withdraw/{chain} | Withdraw some or all of your collateral
*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_add_liquidity_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_add_liquidity_chain_post) | **POST** /v0/aerodrome/liquidity_provision/add_liquidity/{chain} | Provide liquidity to a pool on Aerodrome
*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_add_liquidity_eth_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_add_liquidity_eth_chain_post) | **POST** /v0/aerodrome/liquidity_provision/add_liquidity_eth/{chain} | Provide liquidity to a pool on Aerodrome using WETH and another token
*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_remove_liquidity_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_remove_liquidity_chain_post) | **POST** /v0/aerodrome/liquidity_provision/remove_liquidity/{chain} | Remove liquidity from a pool on Aerodrome
*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_remove_liquidity_eth_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_remove_liquidity_eth_chain_post) | **POST** /v0/aerodrome/liquidity_provision/remove_liquidity_eth/{chain} | Remove liquidity from a pool on Aerodrome using WETH and another token
*AerodromeApi* | [**process_request_v0_aerodrome_swap_eth_for_token_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_swap_eth_for_token_chain_post) | **POST** /v0/aerodrome/swap/eth_for_token/{chain} | Swap ETH for some of a token on Aerodrome
*AerodromeApi* | [**process_request_v0_aerodrome_swap_token_for_eth_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_swap_token_for_eth_chain_post) | **POST** /v0/aerodrome/swap/token_for_eth/{chain} | Swap a token for ETH on Aerodrome
*AerodromeApi* | [**process_request_v0_aerodrome_swap_tokens_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_swap_tokens_chain_post) | **POST** /v0/aerodrome/swap/tokens/{chain} | Swap one token for another token on Aerodrome
*OthersApi* | [**get_tokens_v0_generic_tokens_get_chain_post**](docs/OthersApi.md#get_tokens_v0_generic_tokens_get_chain_post) | **POST** /v0/generic/tokens/get/{chain} | Get Tokens
*OthersApi* | [**process_request_v0_generic_allowance_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_allowance_get_chain_post) | **POST** /v0/generic/allowance/get/{chain} | Show the allowance of a user on a protocol
*OthersApi* | [**process_request_v0_generic_allowance_set_any_chain_post**](docs/OthersApi.md#process_request_v0_generic_allowance_set_any_chain_post) | **POST** /v0/generic/allowance/set_any/{chain} | Sets allowance for any arbitrary ERC20 token address.
*OthersApi* | [**process_request_v0_generic_allowance_set_chain_post**](docs/OthersApi.md#process_request_v0_generic_allowance_set_chain_post) | **POST** /v0/generic/allowance/set/{chain} | Change the allowance of a user on a protocol
*OthersApi* | [**process_request_v0_generic_balance_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_balance_get_chain_post) | **POST** /v0/generic/balance/get/{chain} | Get an address balance of a token
*OthersApi* | [**process_request_v0_generic_ens_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_ens_get_chain_post) | **POST** /v0/generic/ens/get/{chain} | Get the wallet address and registrant of an ENS name
*OthersApi* | [**process_request_v0_generic_portfolio_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_portfolio_get_chain_post) | **POST** /v0/generic/portfolio/get/{chain} | Get the portfolio details for a wallet address including balances and values of all tokens.
*OthersApi* | [**process_request_v0_generic_visualize_portfolio_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_visualize_portfolio_get_chain_post) | **POST** /v0/generic/visualize_portfolio/get/{chain} | Visualize the token portfolio of a wallet address as a pie chart
*OthersApi* | [**process_request_v0_generic_wrap_eth_chain_post**](docs/OthersApi.md#process_request_v0_generic_wrap_eth_chain_post) | **POST** /v0/generic/wrap_eth/{chain} | Change raw ETH into WETH
*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_increase_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_increase_chain_post) | **POST** /v0/uniswap/liquidity_provision/increase/{chain} | Increase an LP position
*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_mint_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_mint_chain_post) | **POST** /v0/uniswap/liquidity_provision/mint/{chain} | Open a new LP position
*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_positions_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_positions_get_chain_post) | **POST** /v0/uniswap/liquidity_provision/positions/get/{chain} | Get the number of LP positions for a given sender
*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_withdraw_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_withdraw_chain_post) | **POST** /v0/uniswap/liquidity_provision/withdraw/{chain} | Withdraw a LP position
*UniswapV3Api* | [**process_request_v0_uniswap_pool_price_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_pool_price_get_chain_post) | **POST** /v0/uniswap/pool_price/get/{chain} | Get the current price of a pool (how many token0 you can buy for 1 token1). This is only the instantaneous price; during any trade the price will change. Use the quote endpoint to get a more realistic idea of the ratios of the two assets you could trade.
*UniswapV3Api* | [**process_request_v0_uniswap_quote_buy_exactly_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_quote_buy_exactly_get_chain_post) | **POST** /v0/uniswap/quote/buy_exactly/get/{chain} | Get the amount of tokens you would need to provide to the pool in order to purchase a fixed quantity of tokens. Also returns what the price would be afterwards.
*UniswapV3Api* | [**process_request_v0_uniswap_quote_sell_exactly_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_quote_sell_exactly_get_chain_post) | **POST** /v0/uniswap/quote/sell_exactly/get/{chain} | Get the amount of tokens you would get from the pool if you provided a fixed quantity of tokens. Also returns what the price would be afterwards.
*UniswapV3Api* | [**process_request_v0_uniswap_swap_buy_exactly_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_swap_buy_exactly_chain_post) | **POST** /v0/uniswap/swap/buy_exactly/{chain} | Trade the amount of a token it takes to end up with a specified quantity of the other token
*UniswapV3Api* | [**process_request_v0_uniswap_swap_sell_exactly_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_swap_sell_exactly_chain_post) | **POST** /v0/uniswap/swap/sell_exactly/{chain} | Trade a specific amount of a token into another.


## Documentation For Models

 - [AaveAssetPriceInfo](docs/AaveAssetPriceInfo.md)
 - [AaveBorrowCallData](docs/AaveBorrowCallData.md)
 - [AaveGetAssetPrice](docs/AaveGetAssetPrice.md)
 - [AaveGetUserPositionPerToken](docs/AaveGetUserPositionPerToken.md)
 - [AaveGetUserPositionSummary](docs/AaveGetUserPositionSummary.md)
 - [AaveRepayCallData](docs/AaveRepayCallData.md)
 - [AaveSupplyCallData](docs/AaveSupplyCallData.md)
 - [AaveUserPositionPerTokenInfo](docs/AaveUserPositionPerTokenInfo.md)
 - [AaveUserPositionSummaryInfo](docs/AaveUserPositionSummaryInfo.md)
 - [AaveWithdrawCallData](docs/AaveWithdrawCallData.md)
 - [AeroLiquidityProvisionCallData](docs/AeroLiquidityProvisionCallData.md)
 - [AeroLiquidityProvisionEthCallData](docs/AeroLiquidityProvisionEthCallData.md)
 - [AeroRemoveLiquidityCallData](docs/AeroRemoveLiquidityCallData.md)
 - [AeroRemoveLiquidityEthCallData](docs/AeroRemoveLiquidityEthCallData.md)
 - [AeroSwapEthForTokenCallData](docs/AeroSwapEthForTokenCallData.md)
 - [AeroSwapTokenForEthCallData](docs/AeroSwapTokenForEthCallData.md)
 - [AeroSwapTokensCallData](docs/AeroSwapTokensCallData.md)
 - [AllowanceInfo](docs/AllowanceInfo.md)
 - [Amount](docs/Amount.md)
 - [Amount0Desired](docs/Amount0Desired.md)
 - [Amount0Min](docs/Amount0Min.md)
 - [Amount1](docs/Amount1.md)
 - [Amount1Desired](docs/Amount1Desired.md)
 - [Amount1Min](docs/Amount1Min.md)
 - [Amount2](docs/Amount2.md)
 - [Amount3](docs/Amount3.md)
 - [Amount4](docs/Amount4.md)
 - [AmountADesired](docs/AmountADesired.md)
 - [AmountAMin](docs/AmountAMin.md)
 - [AmountAMin1](docs/AmountAMin1.md)
 - [AmountBDesired](docs/AmountBDesired.md)
 - [AmountBMin](docs/AmountBMin.md)
 - [AmountBMin1](docs/AmountBMin1.md)
 - [AmountEthDesired](docs/AmountEthDesired.md)
 - [AmountEthMin](docs/AmountEthMin.md)
 - [AmountEthMin1](docs/AmountEthMin1.md)
 - [AmountIn](docs/AmountIn.md)
 - [AmountIn1](docs/AmountIn1.md)
 - [AmountIn2](docs/AmountIn2.md)
 - [AmountInMaximum](docs/AmountInMaximum.md)
 - [AmountOut](docs/AmountOut.md)
 - [AmountOutMin](docs/AmountOutMin.md)
 - [AmountOutMin1](docs/AmountOutMin1.md)
 - [AmountOutMinimum](docs/AmountOutMinimum.md)
 - [AmountTokenDesired](docs/AmountTokenDesired.md)
 - [AmountTokenMin](docs/AmountTokenMin.md)
 - [AmountTokenMin1](docs/AmountTokenMin1.md)
 - [BalanceInfo](docs/BalanceInfo.md)
 - [BaseTransactionRequestAaveBorrowCallData](docs/BaseTransactionRequestAaveBorrowCallData.md)
 - [BaseTransactionRequestAaveRepayCallData](docs/BaseTransactionRequestAaveRepayCallData.md)
 - [BaseTransactionRequestAaveSupplyCallData](docs/BaseTransactionRequestAaveSupplyCallData.md)
 - [BaseTransactionRequestAaveWithdrawCallData](docs/BaseTransactionRequestAaveWithdrawCallData.md)
 - [BaseTransactionRequestAeroLiquidityProvisionCallData](docs/BaseTransactionRequestAeroLiquidityProvisionCallData.md)
 - [BaseTransactionRequestAeroLiquidityProvisionEthCallData](docs/BaseTransactionRequestAeroLiquidityProvisionEthCallData.md)
 - [BaseTransactionRequestAeroRemoveLiquidityCallData](docs/BaseTransactionRequestAeroRemoveLiquidityCallData.md)
 - [BaseTransactionRequestAeroRemoveLiquidityEthCallData](docs/BaseTransactionRequestAeroRemoveLiquidityEthCallData.md)
 - [BaseTransactionRequestAeroSwapEthForTokenCallData](docs/BaseTransactionRequestAeroSwapEthForTokenCallData.md)
 - [BaseTransactionRequestAeroSwapTokenForEthCallData](docs/BaseTransactionRequestAeroSwapTokenForEthCallData.md)
 - [BaseTransactionRequestAeroSwapTokensCallData](docs/BaseTransactionRequestAeroSwapTokensCallData.md)
 - [BaseTransactionRequestBuyExactlyCallData](docs/BaseTransactionRequestBuyExactlyCallData.md)
 - [BaseTransactionRequestIncreaseErc20AllowanceAnyCallData](docs/BaseTransactionRequestIncreaseErc20AllowanceAnyCallData.md)
 - [BaseTransactionRequestIncreaseErc20AllowanceCallData](docs/BaseTransactionRequestIncreaseErc20AllowanceCallData.md)
 - [BaseTransactionRequestSellExactlyCallData](docs/BaseTransactionRequestSellExactlyCallData.md)
 - [BaseTransactionRequestUniswapIncreaseLiquidityProvisionCallData](docs/BaseTransactionRequestUniswapIncreaseLiquidityProvisionCallData.md)
 - [BaseTransactionRequestUniswapMintLiquidityProvisionCallData](docs/BaseTransactionRequestUniswapMintLiquidityProvisionCallData.md)
 - [BaseTransactionRequestUniswapWithdrawLiquidityProvisionCallData](docs/BaseTransactionRequestUniswapWithdrawLiquidityProvisionCallData.md)
 - [BaseTransactionRequestWrapEthRequestCallData](docs/BaseTransactionRequestWrapEthRequestCallData.md)
 - [BuyExactlyCallData](docs/BuyExactlyCallData.md)
 - [Chain](docs/Chain.md)
 - [ContractName](docs/ContractName.md)
 - [EnsNameInfo](docs/EnsNameInfo.md)
 - [FeeEnum](docs/FeeEnum.md)
 - [GetErc20Allowance](docs/GetErc20Allowance.md)
 - [GetErc20Balance](docs/GetErc20Balance.md)
 - [GetLiquidityProvisionPositions](docs/GetLiquidityProvisionPositions.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [Image](docs/Image.md)
 - [IncreaseErc20AllowanceAnyCallData](docs/IncreaseErc20AllowanceAnyCallData.md)
 - [IncreaseErc20AllowanceCallData](docs/IncreaseErc20AllowanceCallData.md)
 - [InterestRateMode](docs/InterestRateMode.md)
 - [LPPositionsInfo](docs/LPPositionsInfo.md)
 - [Liquidity](docs/Liquidity.md)
 - [PercentageForWithdrawal](docs/PercentageForWithdrawal.md)
 - [Portfolio](docs/Portfolio.md)
 - [Position](docs/Position.md)
 - [RequestEnsDetails](docs/RequestEnsDetails.md)
 - [RequestUserAddress](docs/RequestUserAddress.md)
 - [SellExactlyCallData](docs/SellExactlyCallData.md)
 - [Token](docs/Token.md)
 - [TokenBalance](docs/TokenBalance.md)
 - [TokenInfo](docs/TokenInfo.md)
 - [UniswapBuyQuoteInfo](docs/UniswapBuyQuoteInfo.md)
 - [UniswapGetBuyQuote](docs/UniswapGetBuyQuote.md)
 - [UniswapGetPoolPrice](docs/UniswapGetPoolPrice.md)
 - [UniswapGetSellQuote](docs/UniswapGetSellQuote.md)
 - [UniswapIncreaseLiquidityProvisionCallData](docs/UniswapIncreaseLiquidityProvisionCallData.md)
 - [UniswapMintLiquidityProvisionCallData](docs/UniswapMintLiquidityProvisionCallData.md)
 - [UniswapPoolPrice](docs/UniswapPoolPrice.md)
 - [UniswapSellQuoteInfo](docs/UniswapSellQuoteInfo.md)
 - [UniswapWithdrawLiquidityProvisionCallData](docs/UniswapWithdrawLiquidityProvisionCallData.md)
 - [UnsignedTransaction](docs/UnsignedTransaction.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
 - [WrapEthRequestCallData](docs/WrapEthRequestCallData.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author

contact@compasslabs.ai




            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "compass.api-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, Compass API",
    "author": "Compass Labs",
    "author_email": "contact@compasslabs.ai",
    "download_url": "https://files.pythonhosted.org/packages/df/34/51b99de412775325f035b5232d5c769c17c86ffaaba2c17a65afe75463db/compass_api_client-1.0.11.tar.gz",
    "platform": null,
    "description": "# compass.api_client\n\n\n#### Welcome to the DeFi API from [Compass Labs](https://www.compasslabs.ai)!\n\nOur API allows you to interact and transact in DeFi with ease.\n\nWe help you construct your transactions via a **simple REST API**.  \nYou maintain custody at all times and **sign** all transactions **yourself**.\n\nBelow is the documentation of our endpoints. It's a great first step to explore.\n\n\n\n---\n\n**Try out our [App](https://api-app.compasslabs.ai/) built on top of the API!**\n\n---\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.0.1\n- Package version: 1.0.0\n- Generator version: 7.12.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://www.compasslabs.ai/](https://www.compasslabs.ai/)\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport compass.api_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport compass.api_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport compass.api_client\nfrom compass.api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.compasslabs.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = compass.api_client.Configuration(\n    host = \"https://api.compasslabs.ai\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith compass.api_client.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = compass.api_client.AaveV3Api(api_client)\n    chain = compass.api_client.Chain() # Chain | \n    aave_get_asset_price = compass.api_client.AaveGetAssetPrice() # AaveGetAssetPrice | \n\n    try:\n        # Get the price of an asset in USD according to Aave\n        api_response = api_instance.process_request_v0_aave_asset_price_get_chain_post(chain, aave_get_asset_price)\n        print(\"The response of AaveV3Api->process_request_v0_aave_asset_price_get_chain_post:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling AaveV3Api->process_request_v0_aave_asset_price_get_chain_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.compasslabs.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AaveV3Api* | [**process_request_v0_aave_asset_price_get_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_asset_price_get_chain_post) | **POST** /v0/aave/asset_price/get/{chain} | Get the price of an asset in USD according to Aave\n*AaveV3Api* | [**process_request_v0_aave_borrow_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_borrow_chain_post) | **POST** /v0/aave/borrow/{chain} | Borrow against your collateral\n*AaveV3Api* | [**process_request_v0_aave_repay_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_repay_chain_post) | **POST** /v0/aave/repay/{chain} | Return some or all tokens you borrowed\n*AaveV3Api* | [**process_request_v0_aave_supply_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_supply_chain_post) | **POST** /v0/aave/supply/{chain} | Supply collateral to earn interest or borrow against\n*AaveV3Api* | [**process_request_v0_aave_user_position_per_token_get_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_user_position_per_token_get_chain_post) | **POST** /v0/aave/user_position_per_token/get/{chain} | Get the user&#39;s position for a specific token.\n*AaveV3Api* | [**process_request_v0_aave_user_position_summary_get_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_user_position_summary_get_chain_post) | **POST** /v0/aave/user_position_summary/get/{chain} | Get a summary of the user&#39;s position on AAVE. These values will be sums or averages across all open positions.\n*AaveV3Api* | [**process_request_v0_aave_withdraw_chain_post**](docs/AaveV3Api.md#process_request_v0_aave_withdraw_chain_post) | **POST** /v0/aave/withdraw/{chain} | Withdraw some or all of your collateral\n*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_add_liquidity_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_add_liquidity_chain_post) | **POST** /v0/aerodrome/liquidity_provision/add_liquidity/{chain} | Provide liquidity to a pool on Aerodrome\n*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_add_liquidity_eth_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_add_liquidity_eth_chain_post) | **POST** /v0/aerodrome/liquidity_provision/add_liquidity_eth/{chain} | Provide liquidity to a pool on Aerodrome using WETH and another token\n*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_remove_liquidity_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_remove_liquidity_chain_post) | **POST** /v0/aerodrome/liquidity_provision/remove_liquidity/{chain} | Remove liquidity from a pool on Aerodrome\n*AerodromeApi* | [**process_request_v0_aerodrome_liquidity_provision_remove_liquidity_eth_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_liquidity_provision_remove_liquidity_eth_chain_post) | **POST** /v0/aerodrome/liquidity_provision/remove_liquidity_eth/{chain} | Remove liquidity from a pool on Aerodrome using WETH and another token\n*AerodromeApi* | [**process_request_v0_aerodrome_swap_eth_for_token_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_swap_eth_for_token_chain_post) | **POST** /v0/aerodrome/swap/eth_for_token/{chain} | Swap ETH for some of a token on Aerodrome\n*AerodromeApi* | [**process_request_v0_aerodrome_swap_token_for_eth_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_swap_token_for_eth_chain_post) | **POST** /v0/aerodrome/swap/token_for_eth/{chain} | Swap a token for ETH on Aerodrome\n*AerodromeApi* | [**process_request_v0_aerodrome_swap_tokens_chain_post**](docs/AerodromeApi.md#process_request_v0_aerodrome_swap_tokens_chain_post) | **POST** /v0/aerodrome/swap/tokens/{chain} | Swap one token for another token on Aerodrome\n*OthersApi* | [**get_tokens_v0_generic_tokens_get_chain_post**](docs/OthersApi.md#get_tokens_v0_generic_tokens_get_chain_post) | **POST** /v0/generic/tokens/get/{chain} | Get Tokens\n*OthersApi* | [**process_request_v0_generic_allowance_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_allowance_get_chain_post) | **POST** /v0/generic/allowance/get/{chain} | Show the allowance of a user on a protocol\n*OthersApi* | [**process_request_v0_generic_allowance_set_any_chain_post**](docs/OthersApi.md#process_request_v0_generic_allowance_set_any_chain_post) | **POST** /v0/generic/allowance/set_any/{chain} | Sets allowance for any arbitrary ERC20 token address.\n*OthersApi* | [**process_request_v0_generic_allowance_set_chain_post**](docs/OthersApi.md#process_request_v0_generic_allowance_set_chain_post) | **POST** /v0/generic/allowance/set/{chain} | Change the allowance of a user on a protocol\n*OthersApi* | [**process_request_v0_generic_balance_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_balance_get_chain_post) | **POST** /v0/generic/balance/get/{chain} | Get an address balance of a token\n*OthersApi* | [**process_request_v0_generic_ens_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_ens_get_chain_post) | **POST** /v0/generic/ens/get/{chain} | Get the wallet address and registrant of an ENS name\n*OthersApi* | [**process_request_v0_generic_portfolio_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_portfolio_get_chain_post) | **POST** /v0/generic/portfolio/get/{chain} | Get the portfolio details for a wallet address including balances and values of all tokens.\n*OthersApi* | [**process_request_v0_generic_visualize_portfolio_get_chain_post**](docs/OthersApi.md#process_request_v0_generic_visualize_portfolio_get_chain_post) | **POST** /v0/generic/visualize_portfolio/get/{chain} | Visualize the token portfolio of a wallet address as a pie chart\n*OthersApi* | [**process_request_v0_generic_wrap_eth_chain_post**](docs/OthersApi.md#process_request_v0_generic_wrap_eth_chain_post) | **POST** /v0/generic/wrap_eth/{chain} | Change raw ETH into WETH\n*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_increase_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_increase_chain_post) | **POST** /v0/uniswap/liquidity_provision/increase/{chain} | Increase an LP position\n*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_mint_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_mint_chain_post) | **POST** /v0/uniswap/liquidity_provision/mint/{chain} | Open a new LP position\n*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_positions_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_positions_get_chain_post) | **POST** /v0/uniswap/liquidity_provision/positions/get/{chain} | Get the number of LP positions for a given sender\n*UniswapV3Api* | [**process_request_v0_uniswap_liquidity_provision_withdraw_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_liquidity_provision_withdraw_chain_post) | **POST** /v0/uniswap/liquidity_provision/withdraw/{chain} | Withdraw a LP position\n*UniswapV3Api* | [**process_request_v0_uniswap_pool_price_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_pool_price_get_chain_post) | **POST** /v0/uniswap/pool_price/get/{chain} | Get the current price of a pool (how many token0 you can buy for 1 token1). This is only the instantaneous price; during any trade the price will change. Use the quote endpoint to get a more realistic idea of the ratios of the two assets you could trade.\n*UniswapV3Api* | [**process_request_v0_uniswap_quote_buy_exactly_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_quote_buy_exactly_get_chain_post) | **POST** /v0/uniswap/quote/buy_exactly/get/{chain} | Get the amount of tokens you would need to provide to the pool in order to purchase a fixed quantity of tokens. Also returns what the price would be afterwards.\n*UniswapV3Api* | [**process_request_v0_uniswap_quote_sell_exactly_get_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_quote_sell_exactly_get_chain_post) | **POST** /v0/uniswap/quote/sell_exactly/get/{chain} | Get the amount of tokens you would get from the pool if you provided a fixed quantity of tokens. Also returns what the price would be afterwards.\n*UniswapV3Api* | [**process_request_v0_uniswap_swap_buy_exactly_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_swap_buy_exactly_chain_post) | **POST** /v0/uniswap/swap/buy_exactly/{chain} | Trade the amount of a token it takes to end up with a specified quantity of the other token\n*UniswapV3Api* | [**process_request_v0_uniswap_swap_sell_exactly_chain_post**](docs/UniswapV3Api.md#process_request_v0_uniswap_swap_sell_exactly_chain_post) | **POST** /v0/uniswap/swap/sell_exactly/{chain} | Trade a specific amount of a token into another.\n\n\n## Documentation For Models\n\n - [AaveAssetPriceInfo](docs/AaveAssetPriceInfo.md)\n - [AaveBorrowCallData](docs/AaveBorrowCallData.md)\n - [AaveGetAssetPrice](docs/AaveGetAssetPrice.md)\n - [AaveGetUserPositionPerToken](docs/AaveGetUserPositionPerToken.md)\n - [AaveGetUserPositionSummary](docs/AaveGetUserPositionSummary.md)\n - [AaveRepayCallData](docs/AaveRepayCallData.md)\n - [AaveSupplyCallData](docs/AaveSupplyCallData.md)\n - [AaveUserPositionPerTokenInfo](docs/AaveUserPositionPerTokenInfo.md)\n - [AaveUserPositionSummaryInfo](docs/AaveUserPositionSummaryInfo.md)\n - [AaveWithdrawCallData](docs/AaveWithdrawCallData.md)\n - [AeroLiquidityProvisionCallData](docs/AeroLiquidityProvisionCallData.md)\n - [AeroLiquidityProvisionEthCallData](docs/AeroLiquidityProvisionEthCallData.md)\n - [AeroRemoveLiquidityCallData](docs/AeroRemoveLiquidityCallData.md)\n - [AeroRemoveLiquidityEthCallData](docs/AeroRemoveLiquidityEthCallData.md)\n - [AeroSwapEthForTokenCallData](docs/AeroSwapEthForTokenCallData.md)\n - [AeroSwapTokenForEthCallData](docs/AeroSwapTokenForEthCallData.md)\n - [AeroSwapTokensCallData](docs/AeroSwapTokensCallData.md)\n - [AllowanceInfo](docs/AllowanceInfo.md)\n - [Amount](docs/Amount.md)\n - [Amount0Desired](docs/Amount0Desired.md)\n - [Amount0Min](docs/Amount0Min.md)\n - [Amount1](docs/Amount1.md)\n - [Amount1Desired](docs/Amount1Desired.md)\n - [Amount1Min](docs/Amount1Min.md)\n - [Amount2](docs/Amount2.md)\n - [Amount3](docs/Amount3.md)\n - [Amount4](docs/Amount4.md)\n - [AmountADesired](docs/AmountADesired.md)\n - [AmountAMin](docs/AmountAMin.md)\n - [AmountAMin1](docs/AmountAMin1.md)\n - [AmountBDesired](docs/AmountBDesired.md)\n - [AmountBMin](docs/AmountBMin.md)\n - [AmountBMin1](docs/AmountBMin1.md)\n - [AmountEthDesired](docs/AmountEthDesired.md)\n - [AmountEthMin](docs/AmountEthMin.md)\n - [AmountEthMin1](docs/AmountEthMin1.md)\n - [AmountIn](docs/AmountIn.md)\n - [AmountIn1](docs/AmountIn1.md)\n - [AmountIn2](docs/AmountIn2.md)\n - [AmountInMaximum](docs/AmountInMaximum.md)\n - [AmountOut](docs/AmountOut.md)\n - [AmountOutMin](docs/AmountOutMin.md)\n - [AmountOutMin1](docs/AmountOutMin1.md)\n - [AmountOutMinimum](docs/AmountOutMinimum.md)\n - [AmountTokenDesired](docs/AmountTokenDesired.md)\n - [AmountTokenMin](docs/AmountTokenMin.md)\n - [AmountTokenMin1](docs/AmountTokenMin1.md)\n - [BalanceInfo](docs/BalanceInfo.md)\n - [BaseTransactionRequestAaveBorrowCallData](docs/BaseTransactionRequestAaveBorrowCallData.md)\n - [BaseTransactionRequestAaveRepayCallData](docs/BaseTransactionRequestAaveRepayCallData.md)\n - [BaseTransactionRequestAaveSupplyCallData](docs/BaseTransactionRequestAaveSupplyCallData.md)\n - [BaseTransactionRequestAaveWithdrawCallData](docs/BaseTransactionRequestAaveWithdrawCallData.md)\n - [BaseTransactionRequestAeroLiquidityProvisionCallData](docs/BaseTransactionRequestAeroLiquidityProvisionCallData.md)\n - [BaseTransactionRequestAeroLiquidityProvisionEthCallData](docs/BaseTransactionRequestAeroLiquidityProvisionEthCallData.md)\n - [BaseTransactionRequestAeroRemoveLiquidityCallData](docs/BaseTransactionRequestAeroRemoveLiquidityCallData.md)\n - [BaseTransactionRequestAeroRemoveLiquidityEthCallData](docs/BaseTransactionRequestAeroRemoveLiquidityEthCallData.md)\n - [BaseTransactionRequestAeroSwapEthForTokenCallData](docs/BaseTransactionRequestAeroSwapEthForTokenCallData.md)\n - [BaseTransactionRequestAeroSwapTokenForEthCallData](docs/BaseTransactionRequestAeroSwapTokenForEthCallData.md)\n - [BaseTransactionRequestAeroSwapTokensCallData](docs/BaseTransactionRequestAeroSwapTokensCallData.md)\n - [BaseTransactionRequestBuyExactlyCallData](docs/BaseTransactionRequestBuyExactlyCallData.md)\n - [BaseTransactionRequestIncreaseErc20AllowanceAnyCallData](docs/BaseTransactionRequestIncreaseErc20AllowanceAnyCallData.md)\n - [BaseTransactionRequestIncreaseErc20AllowanceCallData](docs/BaseTransactionRequestIncreaseErc20AllowanceCallData.md)\n - [BaseTransactionRequestSellExactlyCallData](docs/BaseTransactionRequestSellExactlyCallData.md)\n - [BaseTransactionRequestUniswapIncreaseLiquidityProvisionCallData](docs/BaseTransactionRequestUniswapIncreaseLiquidityProvisionCallData.md)\n - [BaseTransactionRequestUniswapMintLiquidityProvisionCallData](docs/BaseTransactionRequestUniswapMintLiquidityProvisionCallData.md)\n - [BaseTransactionRequestUniswapWithdrawLiquidityProvisionCallData](docs/BaseTransactionRequestUniswapWithdrawLiquidityProvisionCallData.md)\n - [BaseTransactionRequestWrapEthRequestCallData](docs/BaseTransactionRequestWrapEthRequestCallData.md)\n - [BuyExactlyCallData](docs/BuyExactlyCallData.md)\n - [Chain](docs/Chain.md)\n - [ContractName](docs/ContractName.md)\n - [EnsNameInfo](docs/EnsNameInfo.md)\n - [FeeEnum](docs/FeeEnum.md)\n - [GetErc20Allowance](docs/GetErc20Allowance.md)\n - [GetErc20Balance](docs/GetErc20Balance.md)\n - [GetLiquidityProvisionPositions](docs/GetLiquidityProvisionPositions.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [Image](docs/Image.md)\n - [IncreaseErc20AllowanceAnyCallData](docs/IncreaseErc20AllowanceAnyCallData.md)\n - [IncreaseErc20AllowanceCallData](docs/IncreaseErc20AllowanceCallData.md)\n - [InterestRateMode](docs/InterestRateMode.md)\n - [LPPositionsInfo](docs/LPPositionsInfo.md)\n - [Liquidity](docs/Liquidity.md)\n - [PercentageForWithdrawal](docs/PercentageForWithdrawal.md)\n - [Portfolio](docs/Portfolio.md)\n - [Position](docs/Position.md)\n - [RequestEnsDetails](docs/RequestEnsDetails.md)\n - [RequestUserAddress](docs/RequestUserAddress.md)\n - [SellExactlyCallData](docs/SellExactlyCallData.md)\n - [Token](docs/Token.md)\n - [TokenBalance](docs/TokenBalance.md)\n - [TokenInfo](docs/TokenInfo.md)\n - [UniswapBuyQuoteInfo](docs/UniswapBuyQuoteInfo.md)\n - [UniswapGetBuyQuote](docs/UniswapGetBuyQuote.md)\n - [UniswapGetPoolPrice](docs/UniswapGetPoolPrice.md)\n - [UniswapGetSellQuote](docs/UniswapGetSellQuote.md)\n - [UniswapIncreaseLiquidityProvisionCallData](docs/UniswapIncreaseLiquidityProvisionCallData.md)\n - [UniswapMintLiquidityProvisionCallData](docs/UniswapMintLiquidityProvisionCallData.md)\n - [UniswapPoolPrice](docs/UniswapPoolPrice.md)\n - [UniswapSellQuoteInfo](docs/UniswapSellQuoteInfo.md)\n - [UniswapWithdrawLiquidityProvisionCallData](docs/UniswapWithdrawLiquidityProvisionCallData.md)\n - [UnsignedTransaction](docs/UnsignedTransaction.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n - [WrapEthRequestCallData](docs/WrapEthRequestCallData.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\ncontact@compasslabs.ai\n\n\n\n",
    "bugtrack_url": null,
    "license": "NoLicense",
    "summary": "Compass API",
    "version": "1.0.11",
    "project_urls": {
        "Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " compass api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff07f1057b9143252c34e4c912675243d2a9de50056ac5bd064cc4adb1722e27",
                "md5": "7347f0aeb0ba284f7da46c882e491fed",
                "sha256": "f447aad4b030ea0b5c0e72aa66a06c0dbab6be6c894257624ae18fd99f30d387"
            },
            "downloads": -1,
            "filename": "compass_api_client-1.0.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7347f0aeb0ba284f7da46c882e491fed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 227774,
            "upload_time": "2025-02-04T14:29:49",
            "upload_time_iso_8601": "2025-02-04T14:29:49.397070Z",
            "url": "https://files.pythonhosted.org/packages/ff/07/f1057b9143252c34e4c912675243d2a9de50056ac5bd064cc4adb1722e27/compass_api_client-1.0.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "df3451b99de412775325f035b5232d5c769c17c86ffaaba2c17a65afe75463db",
                "md5": "c6108debe264e3e2018e4c071b7cd1ef",
                "sha256": "6a27a9621ae3cf6307580234671132c2cff3b23988d3da376a0f59c9f71cfa1c"
            },
            "downloads": -1,
            "filename": "compass_api_client-1.0.11.tar.gz",
            "has_sig": false,
            "md5_digest": "c6108debe264e3e2018e4c071b7cd1ef",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 59081,
            "upload_time": "2025-02-04T14:29:51",
            "upload_time_iso_8601": "2025-02-04T14:29:51.635140Z",
            "url": "https://files.pythonhosted.org/packages/df/34/51b99de412775325f035b5232d5c769c17c86ffaaba2c17a65afe75463db/compass_api_client-1.0.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-04 14:29:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GIT_USER_ID",
    "github_project": "GIT_REPO_ID",
    "github_not_found": true,
    "lcname": "compass.api-client"
}