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.1.tar.gz (185.8 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.1-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.3.1.tar.gz
  • Upload date:
  • Size: 185.8 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.1.tar.gz
Algorithm Hash digest
SHA256 7e1a489bac1099e0b872ba52912367bc9bf8751fd196855d75de478c81f93fb1
MD5 46bfe6663a37af196f3660fe187da4fb
BLAKE2b-256 389fbdc43d9fe4b1f8989570c7cef0210337a7ef52742bfa4da2c93771f8bcb8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 58.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8855a66d74b9b600b6fd2e29b60d10560ec427c61b7e33615b6024bc1319b393
MD5 eda8e2548ca2bacb08abcaf9b28bc764
BLAKE2b-256 f772b1017912af6cf1388207b59c6369734294c9eddfa7f580c9ee4571a488f2

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