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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 eae7f31586d76b7ca3992b4bf0354a51883d8212344e8c0e30dc225ca1a18f96
MD5 75e5ec4c82ec23bfbc8307dfa20df699
BLAKE2b-256 6a7e9494109f2018ae35e1a892ce46fcdd52ef01834e7483fd8120ae22c9d420

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ec396a656cffefff0ed52cf079cd6d5deb7c46e74b64a44c809da03a312c8935
MD5 386a12f2cc39fe1aff2caf17e026edb5
BLAKE2b-256 63f6beedd6070fa7243ef32bcfa942b9cc345229ae2372dcdb56518c1061632d

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