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.2.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.2-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.3.2.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.2.tar.gz
Algorithm Hash digest
SHA256 143ccd26b6b7699d66e8f08a089d657f3c4a280aa482df7ade241491fb9d7f5c
MD5 cc35cf91c2b6c6ff3a965ce4991447bf
BLAKE2b-256 7f51ace29dad6508b557f5c47cb38b6f540b3bd4d23ebcfcc71ab83290247951

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.3.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8af4001d498e423fe0dad24ecdca85ed757d3532033194c3657b2b9dade13a7e
MD5 08584d7a9559fba521abfccdaf759600
BLAKE2b-256 19f7a2f0873a92a7b62c22e8b950ba050b3e920747557833642430d6f2c4b6f4

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