Skip to main content

Lightweight Python library for reading Uniswap V3 prices and tick data via Web3.

Project description

uniswap-viewer

A lightweight Python library for accessing Uniswap V3 on-chain data.

uniswap-viewer provides a clean and efficient interface for reading price and tick information directly from Uniswap V3 smart contracts using web3.py. It supports both synchronous and asynchronous workflows and is ideal for developers, analysts, and algorithmic traders.

Features

  • Supports both sync and async Web3 clients
  • Fetches token prices using sqrtPriceX96 and token decimals
  • Retrieves detailed tick data via ABI-decoded contract calls
  • Computes tick index, tick spacing, and tick slot
  • Includes block streaming generator to track new blocks in real time
  • Built-in utilities for loading ABIs and checking Ethereum addresses

Modules

  • viewer_sync.py – synchronous Uniswap V3 viewer using web3.Web3
  • viewer_async.py – asynchronous Uniswap V3 viewer using web3.AsyncWeb3
  • utils.py – helper functions (ABI loading, tick keys, address filters)

Usage

Sync example

from uniswap_viewer import ViewerSync, get_token_address
from web3 import Web3

w3 = Web3(Web3.HTTPProvider("<your_provider_url>"))

viewer = ViewerSync(w3, "usdt", "weth", fee=3000)
viewer.init()
price = viewer.get_price()

Async example

from uniswap_viewer import ViewerAsync, get_token_address
from web3 import AsyncWeb3

w3 = AsyncWeb3(AsyncWeb3.AsyncHTTPProvider("<your_provider_url>"))

viewer = ViewerAsync(w3, "usdt", "weth", fee=3000)
await viewer.init()
price = await viewer.get_price()

Requirements

  • Python 3.8+
  • web3 library (sync or async)

Motivation

This library is designed for:

  • Developers integrating Uniswap data directly from the blockchain
  • Quants and analysts building custom tooling
  • Avoiding reliance on third-party APIs like The Graph

License

MIT

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

uniswap_viewer-0.1.2.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uniswap_viewer-0.1.2-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file uniswap_viewer-0.1.2.tar.gz.

File metadata

  • Download URL: uniswap_viewer-0.1.2.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for uniswap_viewer-0.1.2.tar.gz
Algorithm Hash digest
SHA256 0725dafa46205a75e6242ece071647e73fa3aa2e485337089ad7eff40ca940a3
MD5 1b2fac320710962cc5a8a1df01087c33
BLAKE2b-256 fed3a26a94993d526507e0264e1246a510f484a3ff1d69908fe8e85500354a2d

See more details on using hashes here.

File details

Details for the file uniswap_viewer-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: uniswap_viewer-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for uniswap_viewer-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 67d261e08de85541cbb0ec7bc997f2e069d39ca067878499bc81729cb9e12c8b
MD5 133a22dbefbf80efe9868316f26373c1
BLAKE2b-256 5332a481c07d4b2119372a9fee13efd68ea69e7eae70b4dcf1ea69df42128505

See more details on using hashes here.

Supported by

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