Python bindings for Rango Exchange Basic API
Project description
Python SDK for Rango Exchange Basic API
Simple and Easy to use APIs for Rango Aggregation protocols for dApps and Wallets for single step cross-chain and on-chain swaps using the best route and all the available on-chain liquidity across all blockchain networks.
Requirements
This package supports Python 3.8 and newer.
Installation
Install it with:
python -m pip install rango-basic-sdk
Alternatively, install from the source code with this command from the project root:
python -m pip install .
For an editable installation while developing:
python -m pip install -e .
Usage
Synchronous client
Client is the synchronous API. Close it when finished, or use a with block.
from rango_basic_sdk import Client
with Client(api_key='c6381a79-2817-4602-83bf-6a641a409e32') as client:
result = client.routing.quote(from_="BSC.BNB", to="AVAX_CCHAIN.USDT.E--0xc7198437980c041c805a1edcba50c1ce5db95118", amount=10000000000000000, slippage=3.5)
Endpoints are nested under attributes (see client.py):
client.balance→BalanceOperationsclient.metadata→MetadataOperationsclient.routing→RoutingOperationsclient.transaction→TransactionOperations
Asynchronous client
AsyncClient is the asynchronous API. Use async with and await each call.
import asyncio
from rango_basic_sdk import AsyncClient
async def main() -> None:
async with AsyncClient(api_key='c6381a79-2817-4602-83bf-6a641a409e32') as client:
result = await client.routing.quote(from_="BSC.BNB", to="AVAX_CCHAIN.USDT.E--0xc7198437980c041c805a1edcba50c1ce5db95118", amount=10000000000000000, slippage=3.5)
asyncio.run(main())
Authentication
The Usage section above and the examples/ / docs/ trees show authentication via constructor keyword arguments; This package also supports environment-variable credentials (using RANGO_BASIC prefix for env vars).
apiKey — API key (query parameter)
- This sdk uses apiKey auth: the credential is sent as the query parameter
apiKey. - Use constructor option
api_key. - Pass these as keyword arguments to
Client(...)/AsyncClient(...). - Alternatively set environment variable
RANGO_BASIC_API_KEY. Explicit constructor options override env when both are set.
For private or production authentication parameters, contact Rango via hi@rango.exchange or https://t.me/rangoexchange. See the official API documentation.
API Endpoints Reference
For a complete list of all available SDK methods, including detailed parameter descriptions, return values, and code examples, see the API Reference:
Example Codes
The examples below show only the most commonly used endpoints to help you get started quickly.
For advanced usage and less common operations, consult the API Reference.
Get Balance of a Token
Fetches the balance of a specific token address for the user's wallet
Runnable source: get_token_balance.py
from rango_basic_sdk import Client, models
with Client(api_key='c6381a79-2817-4602-83bf-6a641a409e32') as client:
result = client.balance.get_token_balance(wallet_address="0x9F8cCdaFCc39F3c7D6EBf637c9151673CBc36b88", blockchain=models.Blockchain.BSC, symbol="USDT", address="0x55d398326f99059ff775485246999027b3197955")
print(result)
Get the Best Quote for swapping
Get the best route to perform a cross-chain or same-chain swap
Runnable source: quote.py
from rango_basic_sdk import Client
with Client(api_key='c6381a79-2817-4602-83bf-6a641a409e32') as client:
result = client.routing.quote(from_="BSC.BNB", to="AVAX_CCHAIN.USDT.E--0xc7198437980c041c805a1edcba50c1ce5db95118", amount=10000000000000000, slippage=3.5)
print(result)
Create the Transaction (Swap)
Creates a transaction to be signed by user's wallet and broadcasted to the network
Runnable source: swap.py
from rango_basic_sdk import Client
with Client(api_key='c6381a79-2817-4602-83bf-6a641a409e32') as client:
result = client.transaction.swap(from_="BSC.BNB", to="AVAX_CCHAIN.USDT.E--0xc7198437980c041c805a1edcba50c1ce5db95118", amount=10000000000000000, slippage=3.5, from_address="0x9F8cCdaFCc39F3c7D6EBf637c9151673CBc36b88", to_address="0x6f33bb1763eebead07cf8815a62fcd7b30311fa3", disable_estimate=False, infinite_approve=False)
print(result)
Check the Transaction Status
Checks the status of the transaction using the requestId from the swap endpoint and the broadcasted transaction hash (txId)
Runnable source: status.py
from rango_basic_sdk import Client
with Client(api_key='c6381a79-2817-4602-83bf-6a641a409e32') as client:
result = client.transaction.status(request_id="b3a12c6d-86b8-4c21-97e4-809151dd4036", tx_id="0xfa88b705a5b4049adac7caff50c887d9600ef023ef1a937f8f8b6f44e90042b5")
print(result)
Additional samples for all endpoints live under the examples/ folder.
Advanced Examples
For more advanced walkthroughs, step-by-step guides and custom samples, check the Advanced Examples folder.
HTTP debug logging
To print each HTTP request and response (method, URL, status, headers, and bodies) after the response is received, pass log_http_debug=True to Client or AsyncClient, and set the rango_basic_sdk.client logger to DEBUG so those messages are emitted.
Bodies are truncated after 16 KiB per direction. Do not use this in production or with real secrets: debug output can include credentials (e.g. Authorization, API keys, cookies).
import logging
from rango_basic_sdk import Client
logging.getLogger("rango_basic_sdk.client").setLevel(logging.DEBUG)
if not logging.root.handlers:
logging.basicConfig(level=logging.DEBUG)
with Client(log_http_debug=True) as client:
# …
pass
For AsyncClient, use the same logging setup and AsyncClient(log_http_debug=True, ...).
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rango_basic_sdk-0.0.6.tar.gz.
File metadata
- Download URL: rango_basic_sdk-0.0.6.tar.gz
- Upload date:
- Size: 28.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.5 cpython/3.12.13 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
423cec64031747712c05c39602c713ea961944ad11e18c57b0ffe6b3b7ce51e8
|
|
| MD5 |
a9e0603094701739d16528a1e29d9cf0
|
|
| BLAKE2b-256 |
e2531b2ff122e468c7d654f0118dcbe5088ed3b11a180484f95f9673af2ae899
|
File details
Details for the file rango_basic_sdk-0.0.6-py3-none-any.whl.
File metadata
- Download URL: rango_basic_sdk-0.0.6-py3-none-any.whl
- Upload date:
- Size: 29.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.5 cpython/3.12.13 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45ff3ed267c8e1d1789670bcbcd515a1eb7a272a40ee24c6f0b11d8df8b8ff39
|
|
| MD5 |
f8363cb9d50d0d5d3a7e588d78df2d46
|
|
| BLAKE2b-256 |
f14025b92f5b345b913e48138d8480a44279ed4a47865b9abaa348506a3a9e67
|