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>"))

token0 = get_token_address("usdt")
token1 = get_token_address("weth")

viewer = ViewerSync(w3, token0, token1, 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>"))

token0 = get_token_address("usdt")
token1 = get_token_address("weth")

viewer = ViewerAsync(w3, token0, token1, 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.1.tar.gz (9.1 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.1-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uniswap_viewer-0.1.1.tar.gz
  • Upload date:
  • Size: 9.1 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.1.tar.gz
Algorithm Hash digest
SHA256 58d2e170d55ae269644d5a0d96ef4708d11f2013d335d539c8d40afa4631d4a4
MD5 7668fdbda89a5e005599969051ae4c67
BLAKE2b-256 519ae70b6e711f04821d11dfca394bb57282035960ca6c080e0408eaa469db1c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uniswap_viewer-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 30f3a0a3f80d148eec195629edcd8e4475294347987867786936fac847f5ceaa
MD5 18f26d1d77d9dd41a7e77180aab2525c
BLAKE2b-256 a990f6e034e623f2411ddc47b48e7142b271b8bc64695d8d515f40ef28fbffa7

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