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
# 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.0a6.tar.gz (76.6 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.0a6-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: brk_client-0.1.0a6.tar.gz
  • Upload date:
  • Size: 76.6 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.0a6.tar.gz
Algorithm Hash digest
SHA256 3681ae3dd650b020938a9cb262836432ee81f114f64c9d397e133fac3cc22661
MD5 7f0278fd8d9e52928a0decaa1f03df88
BLAKE2b-256 73fd4068ab57a5f0770aa27e05cc9aa0e527585e1f1594c8f9829a8238e8329d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: brk_client-0.1.0a6-py3-none-any.whl
  • Upload date:
  • Size: 35.2 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.0a6-py3-none-any.whl
Algorithm Hash digest
SHA256 47e2e81199c88e4f6a3feacea46e7d54a9f6b2fdbb2f57156f600accc827d587
MD5 ab63862b42cdf3257a66026d0049b1c6
BLAKE2b-256 2bef71712ed14e63f4bcc7793478bdc4f23c016b9e113cd82fb86cc2c65c8462

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