Skip to main content

Bitcoin on-chain analytics client — thousands of metrics, block explorer, and address index

Project description

brk-client

Python client for the Bitcoin Research Kit API.

Requires Python 3.9+. Zero dependencies.

PyPI | API Reference

Installation

pip install brk-client
# or
uv add brk-client

Or just copy brk_client/__init__.py into your project - it's a single file with no dependencies.

Quick Start

from brk_client import BrkClient

# Use the free public API or your own instance
# Has optional `, timeout=60.0` argument
client = BrkClient("https://bitview.space")

# Blockchain data (mempool.space compatible)
block = client.get_block_by_height(800000)
tx = client.get_tx("abc123...")
address = client.get_address("bc1q...")

# Metrics API - typed, chainable
prices = client.metrics.price.usd.split.close \
    .by.dateindex() \
    .tail(30) \
    .fetch()  # Last 30 items

# Generic metric fetching
data = client.get_metric("price_close", "dateindex", -30)

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

brk_client-0.3.0.tar.gz (185.2 kB view details)

Uploaded Source

Built Distribution

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

brk_client-0.3.0-py3-none-any.whl (57.7 kB view details)

Uploaded Python 3

File details

Details for the file brk_client-0.3.0.tar.gz.

File metadata

  • Download URL: brk_client-0.3.0.tar.gz
  • Upload date:
  • Size: 185.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for brk_client-0.3.0.tar.gz
Algorithm Hash digest
SHA256 58019662cdbbbe5c899e29c17deb94f629df0b592e87c7af88aae75e729dd143
MD5 a9f0767c603a8118f795e3b0c56d0a0d
BLAKE2b-256 9a47fbb2b32ac466dda8a9968be16a41d05069f6ea8ac242465a8f0e20a56dc3

See more details on using hashes here.

File details

Details for the file brk_client-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: brk_client-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 57.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for brk_client-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7815731cb62c0b0312ec24f91c8f66b952654458f2a5ec852659909da044a61
MD5 68913f7afcda8bb74d722d82953f8952
BLAKE2b-256 7a55fa9314fbc3387a50645f89b20482ee51bbfac4e1ef0711d7081fede54c01

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