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
from web3 import Web3

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

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

price = viewer.get_price()

tick = viewer.calc_tick(price, normalize=True)
tick_data = viewer.get_tick_data(tick)
liquidity = tick_data['liquidityGross']

Async example

from uniswap_viewer import ViewerAsync
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()

tick = viewer.calc_tick(price, normalize=True)
tick_data = await viewer.get_tick_data(tick)
liquidity = tick_data['liquidityGross']

Stream example

from uniswap_viewer.viewer_async import Viewer as ViewerAsync, stream_new_blocks
from web3 import AsyncWeb3

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

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

async for block_num in stream_new_blocks(w3, timeout=3):
    price = await viewer.get_price(block_num=block_num)

    tick = viewer.calc_tick(price, normalize=True)
    tick_data = await viewer.get_tick_data(tick, block_num=block_num)
    liquidity = tick_data['liquidityGross']

    print(price, liquidity)

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.10.tar.gz (9.8 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.10-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uniswap_viewer-0.1.10.tar.gz
  • Upload date:
  • Size: 9.8 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.10.tar.gz
Algorithm Hash digest
SHA256 f34c130d268299119899842740a2b552f4998445d5f32645b09e713487c4b2f5
MD5 11e93a42b2c9f94e1b6d7ff909de1592
BLAKE2b-256 728d612c1377949216004d9d54f2ee556a06cf653ade9829efd78725f1038638

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for uniswap_viewer-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f89788ea983024cc1f6f3c92923e7016a05059e35c21cd68218a8ea96545f44b
MD5 1d37020424a46088d2a92554cc3dc5dd
BLAKE2b-256 8213e641fe934422d8cbae54bb81a05b81b3baa0f4501caa77ff7eeff92e178f

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