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.0b0.tar.gz (91.2 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.0b0-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

Details for the file brk_client-0.1.0b0.tar.gz.

File metadata

  • Download URL: brk_client-0.1.0b0.tar.gz
  • Upload date:
  • Size: 91.2 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.0b0.tar.gz
Algorithm Hash digest
SHA256 ea83e0c8739646a2cf15fa6ce57f90432004d09ad837b217031a5bfa05824497
MD5 905b86199e4be4c8b20a05ac3d357195
BLAKE2b-256 3be9def00de1aa8a883eb05dafd9eda35efea57293dd2f403cad897e4b208127

See more details on using hashes here.

File details

Details for the file brk_client-0.1.0b0-py3-none-any.whl.

File metadata

  • Download URL: brk_client-0.1.0b0-py3-none-any.whl
  • Upload date:
  • Size: 35.7 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.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 2bb268cd317936c51f794b83ad126501cc71a9d0b71490214f0030aa2ec3a770
MD5 6393d2a6cfbd52701bb4ad11b6ac8fdf
BLAKE2b-256 ad403948c6f8e76e39f919188ed7d87cf8e59afb386c8ed7259d9a9cc2c1743a

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