Skip to main content

Python client for the Bitcoin Research Kit

Project description

brk-client

Python client for the Bitcoin Research Kit API.

PyPI | API Reference

Installation

pip install brk-client
# or
uv add brk-client

Quick Start

from brk_client import BrkClient

# Use the free public API or your own instance
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)

API

# Range methods
.head(n)   # First n items
.tail(n)   # Last n items
.fetch()   # Execute the request

Configuration

client = BrkClient("https://bitview.space", timeout=60.0)

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.1.0a3.tar.gz
  • Upload date:
  • Size: 77.0 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.0a3.tar.gz
Algorithm Hash digest
SHA256 5c04bd9d63c2bf0a33c97dcb62b138d3e5c5fee7f6fec9b3a5cab2671b395a20
MD5 d29889f619797453c95a556b963dc582
BLAKE2b-256 8d7fc8a256039b415305a99e6f2961e2f3ef001f68e8a72c51920a375727fd04

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.1.0a3-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.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 edd39f4fb88d7a7f317758893b2242a84f86987483a150da38aee95e247ef1d0
MD5 b7578f0c7132206985f67fed31a655a7
BLAKE2b-256 64acee33ad19e702a813e6fc9317bd2371449a6a8b6a87b4b338c6a6d1ac2508

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