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.9.tar.gz (128.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.9-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.1.9.tar.gz
  • Upload date:
  • Size: 128.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.9.tar.gz
Algorithm Hash digest
SHA256 9fa1dc8a449544d116f6120ac45b18ce2d43a6a55677da50844a17ddecb27b13
MD5 10e2bb9fa97be819a05ea5f80d75ad20
BLAKE2b-256 5b992d0a315df5a452be0614e5f8c1a5e53bed7ab349c0a7c8497a60c82fa9d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 40.5 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0a960ce20311ba63d0e68fa99986f3e5e7936db0eb85c7440cf6d63a1e1f785d
MD5 69cac22d1736b819defb7ac0d10fd26b
BLAKE2b-256 6e2c1fe2d4e5c94a9afe6179041ba7170eed01ff80111dea00b6b050ee61b12d

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