# Python Client

A python package is available to ease integration into python-based projects. To install locally:

## Setup Guide

#### Prerequisites

* Git
* Rust 1.84.0 or later
* Python 3.9 or above

#### Install the package

```bash
pip install git+https://github.com/propeller-heads/tycho-indexer.git#subdirectory=tycho-client-py
```

## Understanding and using the Python Client

The Python client is a Python wrapper around our [Rust Client](/tycho/for-solvers/indexer/tycho-client/rust-client.md) that enables interaction with the Tycho Indexer. It provides two main functionalities:

* **Streaming Client**: Python wrapper around [Rust Client](/tycho/for-solvers/indexer/tycho-client/rust-client.md) for real-time data streaming
* **RPC Client**: Pure Python implementation for querying [Tycho RPC](/tycho/for-solvers/indexer/tycho-rpc.md) data

### Streaming Implementation

The `TychoStream` class:

1. Locates the Rust binary (`tycho-client-cli`)
2. Spawns the binary as a subprocess
3. Configures it with parameters like URL, authentication, exchanges, and filters
4. Implements an async iterator pattern that:
   * Reads JSON output from the binary's stdout
   * Parses messages into Pydantic models
   * Handles errors and process termination

Here's one example on how to use it:

```python
import asyncio
from tycho_indexer_client import Chain, TychoStream
from decimal import Decimal

async def main():
    stream = TychoStream(
        tycho_url="localhost:8888",
        auth_token="secret_token",
        exchanges=["uniswap_v2"],
        min_tvl=Decimal(100),
        blockchain=Chain.ethereum,
    )

    await stream.start()

    async for message in stream:
        print(message)

asyncio.run(main())
```

### RPC Client Implementation

The `TychoRPCClient` class:

* Makes HTTP requests to the Tycho RPC server
* Serializes Python objects to JSON
* Deserializes JSON responses to typed Pydantic models
* Handles blockchain-specific data types like `HexBytes`

Here's one example on how to use it to fetch tokens information (available at [Tycho RPC](/tycho/for-solvers/indexer/tycho-rpc.md#v1-tokens) endpoint):

```python
from tycho_indexer_client import (
    TychoRPCClient,
    TokensParams,
    Chain,
    PaginationParams
)

client = TychoRPCClient("http://0.0.0.0:4242", chain=Chain.ethereum)

all_tokens = []
page = 0

while True:
    tokens = client.get_tokens(
        TokensParams(
            min_quality=51,
            traded_n_days_ago=30,
            pagination=PaginationParams(page=page, page_size=1000),
        )
    )
    
    if not tokens:
        break
    
    all_tokens.extend(tokens)
    page += 1
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.propellerheads.xyz/tycho/for-solvers/indexer/tycho-client/python-client.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.