Skip to main content

Python client for the Bitcoin Research Kit

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.1.5.tar.gz (127.4 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.1.5-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.1.5.tar.gz
  • Upload date:
  • Size: 127.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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.1.5.tar.gz
Algorithm Hash digest
SHA256 1f3e36f71a0035c84c8e023fe038fc08204a0cb2bbe2b1d4fb98be9e743f89bf
MD5 6f474f78e5dcf8a89c44a59630670eb3
BLAKE2b-256 2772029753fecf7e0650a91fcac74512a90074d95faf34b45a36899c1f8c58e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","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.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c48f51abf98ad408275425e448be23d58d9cf776ec53c4d2fabe2079f831bc4f
MD5 85c5a72fbd128dca99584f3b900b56f5
BLAKE2b-256 ce9f1f3c4dbb8c1a97b47bca0ff1a857a49a8c7102d86d6aeddcfcca2b8c93f2

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