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.5.tar.gz (187.1 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.5-py3-none-any.whl (59.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.3.5.tar.gz
  • Upload date:
  • Size: 187.1 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.5.tar.gz
Algorithm Hash digest
SHA256 3ec7cf5a8eb1bce6e93bc4b70419f9777d19542a700ad08b5a295a0bc152318c
MD5 6a5a17ae0141f11353fcc26125c4b947
BLAKE2b-256 488e0cdf0b7f5b30ddb282b4bc2043533edbaffb981361d1c9f29d8f80a4b029

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 59.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 eae8cac28e16f004bc9db7ea8cdcbd6aae2b0dad4850d32ee603f9cd2e140d3e
MD5 2c89f1ab495879cebd8631673898efbb
BLAKE2b-256 ade420fab64a434dc1566625f572359673cc20b73312bf52c935c5c98910a334

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