Class: BrkClient

The index type

d

Date

The date to convert

Returns

number

get()

get(path): Promise<Response>

Defined in: Developer/brk/modules/brk-client/index.js:1535

Parameters

path

string

Returns

Promise<Response>

Inherited from

BrkClientBase.get

getAddress()

getAddress(address): Promise<AddrStats>

Defined in: Developer/brk/modules/brk-client/index.js:9453

Address information

Retrieve address information including balance and transaction counts. Supports all standard Bitcoin address types (P2PKH, P2SH, P2WPKH, P2WSH, P2TR).

Endpoint: GET /api/address/{address}

Parameters

address

string

Returns

Promise<AddrStats>

getAddressConfirmedTxs()

getAddressConfirmedTxs(address, after_txid?): Promise<Transaction[]>

Defined in: Developer/brk/modules/brk-client/index.js:9491

Address confirmed transactions

Get confirmed transactions for an address, 25 per page. Use ?after_txid= for pagination.

Endpoint: GET /api/address/{address}/txs/chain

Parameters

address

string

after_txid?

string

Txid to paginate from (return transactions before this one)

Returns

Promise<Transaction[]>

getAddressMempoolTxs()

getAddressMempoolTxs(address): Promise<string[]>

Defined in: Developer/brk/modules/brk-client/index.js:9511

Address mempool transactions

Get unconfirmed transaction IDs for an address from the mempool (up to 50).

Endpoint: GET /api/address/{address}/txs/mempool

Parameters

address

string

Returns

Promise<string[]>

getAddressTxs()

getAddressTxs(address, after_txid?): Promise<Transaction[]>

Defined in: Developer/brk/modules/brk-client/index.js:9470

Address transactions

Get transaction history for an address, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. Use ?after_txid= for pagination.

Endpoint: GET /api/address/{address}/txs

Parameters

address

string

after_txid?

string

Txid to paginate from (return transactions before this one)

Returns

Promise<Transaction[]>

getAddressUtxos()

getAddressUtxos(address): Promise<Utxo[]>

Defined in: Developer/brk/modules/brk-client/index.js:9527

Address UTXOs

Get unspent transaction outputs (UTXOs) for an address. Returns txid, vout, value, and confirmation status for each UTXO.

Endpoint: GET /api/address/{address}/utxo

Parameters

address

string

Returns

Promise<Utxo[]>

getApi()

getApi(): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:9437

Compact OpenAPI specification

Compact OpenAPI specification optimized for LLM consumption. Removes redundant fields while preserving essential API information. Full spec available at /openapi.json.

Endpoint: GET /api.json

Returns

Promise<any>

getBlock()

getBlock(hash): Promise<BlockInfo>

Defined in: Developer/brk/modules/brk-client/index.js:9559

Block information

Retrieve block information by block hash. Returns block metadata including height, timestamp, difficulty, size, weight, and transaction count.

Endpoint: GET /api/block/{hash}

Parameters

hash

string

Returns

Promise<BlockInfo>

getBlockByHeight()

getBlockByHeight(height): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:9543

Block hash by height

Retrieve the block hash at a given height. Returns the hash as plain text.

Endpoint: GET /api/block-height/{height}

Parameters

height

number

Returns

Promise<any>

getBlockByTimestamp()

getBlockByTimestamp(timestamp): Promise<BlockTimestamp>

Defined in: Developer/brk/modules/brk-client/index.js:10432

Block by timestamp

Find the block closest to a given UNIX timestamp.

Endpoint: GET /api/v1/mining/blocks/timestamp/{timestamp}

Parameters

timestamp

number

Returns

Promise<BlockTimestamp>

getBlockFeeRates()

getBlockFeeRates(time_period): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:10368

Block fee rates (WIP)

Work in progress. Get block fee rate percentiles (min, 10th, 25th, median, 75th, 90th, max) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/blocks/fee-rates/{time_period}

Parameters

time_period

Returns

Promise<any>

getBlockFees()

getBlockFees(time_period): Promise<BlockFeesEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10384

Block fees

Get average block fees for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/blocks/fees/{time_period}

Parameters

time_period

Returns

Promise<BlockFeesEntry[]>

getBlockHeader()

getBlockHeader(hash): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:9575

Block header

Returns the hex-encoded block header.

Endpoint: GET /api/block/{hash}/header

Parameters

hash

string

Returns

Promise<any>

getBlockRaw()

getBlockRaw(hash): Promise<number[]>

Defined in: Developer/brk/modules/brk-client/index.js:9591

Raw block

Returns the raw block data in binary format.

Endpoint: GET /api/block/{hash}/raw

Parameters

hash

string

Returns

Promise<number[]>

getBlockRewards()

getBlockRewards(time_period): Promise<BlockRewardsEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10400

Block rewards

Get average block rewards (coinbase = subsidy + fees) for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/blocks/rewards/{time_period}

Parameters

time_period

Returns

Promise<BlockRewardsEntry[]>

getBlocks()

getBlocks(): Promise<BlockInfo[]>

Defined in: Developer/brk/modules/brk-client/index.js:9687

Recent blocks

Retrieve the last 10 blocks. Returns block metadata for each block.

Endpoint: GET /api/blocks

Returns

Promise<BlockInfo[]>

getBlocksFromHeight()

getBlocksFromHeight(height): Promise<BlockInfo[]>

Defined in: Developer/brk/modules/brk-client/index.js:9731

Blocks from height

Retrieve up to 10 blocks going backwards from the given height. For example, height=100 returns blocks 100, 99, 98, ..., 91. Height=0 returns only block 0.

Endpoint: GET /api/blocks/{height}

Parameters

height

number

Returns

Promise<BlockInfo[]>

getBlockSizesWeights()

getBlockSizesWeights(time_period): Promise<BlockSizesWeights>

Defined in: Developer/brk/modules/brk-client/index.js:10416

Block sizes and weights

Get average block sizes and weights for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/blocks/sizes-weights/{time_period}

Parameters

time_period

Returns

Promise<BlockSizesWeights>

getBlockStatus()

getBlockStatus(hash): Promise<BlockStatus>

Defined in: Developer/brk/modules/brk-client/index.js:9607

Block status

Retrieve the status of a block. Returns whether the block is in the best chain and, if so, its height and the hash of the next block.

Endpoint: GET /api/block/{hash}/status

Parameters

hash

string

Returns

Promise<BlockStatus>

getBlocksV1()

getBlocksV1(): Promise<BlockInfoV1[]>

Defined in: Developer/brk/modules/brk-client/index.js:10244

Recent blocks with extras

Retrieve the last 10 blocks with extended data including pool identification and fee statistics.

Endpoint: GET /api/v1/blocks

Returns

Promise<BlockInfoV1[]>

getBlocksV1FromHeight()

getBlocksV1FromHeight(height): Promise<BlockInfoV1[]>

Defined in: Developer/brk/modules/brk-client/index.js:10260

Blocks from height with extras

Retrieve up to 10 blocks with extended data going backwards from the given height.

Endpoint: GET /api/v1/blocks/{height}

Parameters

height

number

Returns

Promise<BlockInfoV1[]>

getBlockTipHash()

getBlockTipHash(): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:9701

Block tip hash

Returns the hash of the last block.

Endpoint: GET /api/blocks/tip/hash

Returns

Promise<any>

getBlockTipHeight()

getBlockTipHeight(): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:9715

Block tip height

Returns the height of the last block.

Endpoint: GET /api/blocks/tip/height

Returns

Promise<any>

getBlockTxid()

getBlockTxid(hash, index): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:9624

Transaction ID at index

Retrieve a single transaction ID at a specific index within a block. Returns plain text txid.

Endpoint: GET /api/block/{hash}/txid/{index}

Parameters

hash

string

Bitcoin block hash

index

number

Transaction index within the block (0-based)

Returns

Promise<any>

getBlockTxids()

getBlockTxids(hash): Promise<string[]>

Defined in: Developer/brk/modules/brk-client/index.js:9640

Block transaction IDs

Retrieve all transaction IDs in a block. Returns an array of txids in block order.

Endpoint: GET /api/block/{hash}/txids

Parameters

hash

string

Returns

Promise<string[]>

getBlockTxs()

getBlockTxs(hash): Promise<Transaction[]>

Defined in: Developer/brk/modules/brk-client/index.js:9656

Block transactions

Retrieve transactions in a block by block hash. Returns up to 25 transactions starting from index 0.

Endpoint: GET /api/block/{hash}/txs

Parameters

hash

string

Returns

Promise<Transaction[]>

getBlockTxsFromIndex()

getBlockTxsFromIndex(hash, start_index): Promise<Transaction[]>

Defined in: Developer/brk/modules/brk-client/index.js:9673

Block transactions (paginated)

Retrieve transactions in a block by block hash, starting from the specified index. Returns up to 25 transactions at a time.

Endpoint: GET /api/block/{hash}/txs/{start_index}

Parameters

hash

string

Bitcoin block hash

start_index

number

Starting transaction index within the block (0-based)

Returns

Promise<Transaction[]>

getBlockV1()

getBlockV1(hash): Promise<BlockInfoV1>

Defined in: Developer/brk/modules/brk-client/index.js:10230

Block (v1)

Returns block details with extras by hash.

Endpoint: GET /api/v1/block/{hash}

Parameters

hash

string

Returns

Promise<BlockInfoV1>

getCostBasis()

getCostBasis(cohort, date, bucket?, value?): Promise<Object>

Defined in: Developer/brk/modules/brk-client/index.js:9875

Cost basis distribution

Get the cost basis distribution for a cohort on a specific date.

Query params:

bucket: raw (default), lin200, lin500, lin1000, log10, log50, log100
value: supply (default, in BTC), realized (USD), unrealized (USD)

Endpoint: GET /api/series/cost-basis/{cohort}/{date}

Parameters

cohort

string

date

string

bucket?

CostBasisBucket

Bucket type for aggregation. Default: raw (no aggregation).

value?

CostBasisValue

Value type to return. Default: supply.

Returns

Promise<Object>

getCostBasisCohorts()

getCostBasisCohorts(): Promise<string[]>

Defined in: Developer/brk/modules/brk-client/index.js:9840

Available cost basis cohorts

List available cohorts for cost basis distribution.

Endpoint: GET /api/series/cost-basis

Returns

Promise<string[]>

getCostBasisDates()

getCostBasisDates(cohort): Promise<number[]>

Defined in: Developer/brk/modules/brk-client/index.js:9854

Available cost basis dates

List available dates for a cohort's cost basis distribution.

Endpoint: GET /api/series/cost-basis/{cohort}/dates

Parameters

cohort

string

Returns

Promise<number[]>

getCpfp()

getCpfp(txid): Promise<CpfpInfo>

Defined in: Developer/brk/modules/brk-client/index.js:10276

CPFP info

Returns ancestors and descendants for a CPFP transaction.

Endpoint: GET /api/v1/cpfp/{txid}

Parameters

txid

string

Returns

Promise<CpfpInfo>

getDifficultyAdjustment()

getDifficultyAdjustment(): Promise<DifficultyAdjustment>

Defined in: Developer/brk/modules/brk-client/index.js:10290

Difficulty adjustment

Get current difficulty adjustment progress and estimates.

Endpoint: GET /api/v1/difficulty-adjustment

Returns

Promise<DifficultyAdjustment>

getDifficultyAdjustments()

getDifficultyAdjustments(): Promise<DifficultyAdjustmentEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10446

Difficulty adjustments (all time)

Get historical difficulty adjustments including timestamp, block height, difficulty value, and percentage change.

Endpoint: GET /api/v1/mining/difficulty-adjustments

Returns

Promise<DifficultyAdjustmentEntry[]>

getDifficultyAdjustmentsByPeriod()

getDifficultyAdjustmentsByPeriod(time_period): Promise<DifficultyAdjustmentEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10462

Difficulty adjustments

Get historical difficulty adjustments for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y.

Endpoint: GET /api/v1/mining/difficulty-adjustments/{time_period}

Parameters

time_period

Returns

Promise<DifficultyAdjustmentEntry[]>

getDiskUsage()

getDiskUsage(): Promise<DiskUsage>

Defined in: Developer/brk/modules/brk-client/index.js:10073

Disk usage

Returns the disk space used by BRK and Bitcoin data.

Endpoint: GET /api/server/disk

Returns

Promise<DiskUsage>

getHashrate()

getHashrate(): Promise<HashrateSummary>

Defined in: Developer/brk/modules/brk-client/index.js:10476

Network hashrate (all time)

Get network hashrate and difficulty data for all time.

Endpoint: GET /api/v1/mining/hashrate

Returns

Promise<HashrateSummary>

getHashrateByPeriod()

getHashrateByPeriod(time_period): Promise<HashrateSummary>

Defined in: Developer/brk/modules/brk-client/index.js:10522

Network hashrate

Get network hashrate and difficulty data for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/hashrate/{time_period}

Parameters

time_period

Returns

Promise<HashrateSummary>

getHealth()

getHealth(): Promise<Health>

Defined in: Developer/brk/modules/brk-client/index.js:10689

Health check

Returns the health status of the API server, including uptime information.

Endpoint: GET /health

Returns

Promise<Health>

getHistoricalPrice()

getHistoricalPrice(timestamp?): Promise<HistoricalPrice>

Defined in: Developer/brk/modules/brk-client/index.js:10348

Historical price

Get historical BTC/USD price. Optionally specify a UNIX timestamp to get the price at that time.

Endpoint: GET /api/v1/historical-price

Parameters

timestamp?

number

Returns

Promise<HistoricalPrice>

getIndexes()

getIndexes(): Promise<IndexInfo[]>

Defined in: Developer/brk/modules/brk-client/index.js:9904

List available indexes

Returns all available indexes with their accepted query aliases. Use any alias when querying series.

Endpoint: GET /api/series/indexes

Returns

Promise<IndexInfo[]>

getJson()

getJson<T>(path, onUpdate?): Promise<T>

Defined in: Developer/brk/modules/brk-client/index.js:1549

Make a GET request - races cache vs network, first to resolve calls onUpdate

Type Parameters

T

T

Parameters

path

string

onUpdate?

(value) => void

Called when data is available (may be called twice: cache then network)

Returns

Promise<T>

Inherited from

BrkClientBase.getJson

getLivePrice()

getLivePrice(): Promise<number>

Defined in: Developer/brk/modules/brk-client/index.js:9757

Live BTC/USD price

Returns the current BTC/USD price in dollars, derived from on-chain round-dollar output patterns in the last 12 blocks plus mempool.

Endpoint: GET /api/mempool/price

Returns

Promise<number>

getMempool()

getMempool(): Promise<MempoolInfo>

Defined in: Developer/brk/modules/brk-client/index.js:9745

Mempool statistics

Get current mempool statistics including transaction count, total vsize, total fees, and fee histogram.

Endpoint: GET /api/mempool

Returns

Promise<MempoolInfo>

getMempoolBlocks()

getMempoolBlocks(): Promise<MempoolBlock[]>

Defined in: Developer/brk/modules/brk-client/index.js:10304

Projected mempool blocks

Get projected blocks from the mempool for fee estimation.

Endpoint: GET /api/v1/fees/mempool-blocks

Returns

Promise<MempoolBlock[]>

getMempoolRecent()

getMempoolRecent(): Promise<MempoolRecentTx[]>

Defined in: Developer/brk/modules/brk-client/index.js:9771

Recent mempool transactions

Get the last 10 transactions to enter the mempool.

Endpoint: GET /api/mempool/recent

Returns

Promise<MempoolRecentTx[]>

getMempoolTxids()

getMempoolTxids(): Promise<string[]>

Defined in: Developer/brk/modules/brk-client/index.js:9785

Mempool transaction IDs

Get all transaction IDs currently in the mempool.

Endpoint: GET /api/mempool/txids

Returns

Promise<string[]>

getOpenapi()

getOpenapi(): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:10701

OpenAPI specification

Full OpenAPI 3.1 specification for this API.

Endpoint: GET /openapi.json

Returns

Promise<any>

getPool()

getPool(slug): Promise<PoolDetail>

Defined in: Developer/brk/modules/brk-client/index.js:10538

Mining pool details

Get detailed information about a specific mining pool including block counts and shares for different time periods.

Endpoint: GET /api/v1/mining/pool/{slug}

Parameters

slug

Returns

Promise<PoolDetail>

getPoolBlocks()

getPoolBlocks(slug): Promise<BlockInfoV1[]>

Defined in: Developer/brk/modules/brk-client/index.js:10554

Mining pool blocks

Get the 10 most recent blocks mined by a specific pool.

Endpoint: GET /api/v1/mining/pool/{slug}/blocks

Parameters

slug

Returns

Promise<BlockInfoV1[]>

getPoolBlocksFrom()

getPoolBlocksFrom(slug, height): Promise<BlockInfoV1[]>

Defined in: Developer/brk/modules/brk-client/index.js:10571

Mining pool blocks from height

Get 10 blocks mined by a specific pool before (and including) the given height.

Endpoint: GET /api/v1/mining/pool/{slug}/blocks/{height}

Parameters

slug

height

number

Returns

Promise<BlockInfoV1[]>

getPoolHashrate()

getPoolHashrate(slug): Promise<PoolHashrateEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10587

Mining pool hashrate

Get hashrate history for a specific mining pool.

Endpoint: GET /api/v1/mining/pool/{slug}/hashrate

Parameters

slug

Returns

Promise<PoolHashrateEntry[]>

getPools()

getPools(): Promise<PoolInfo[]>

Defined in: Developer/brk/modules/brk-client/index.js:10601

List all mining pools

Get list of all known mining pools with their identifiers.

Endpoint: GET /api/v1/mining/pools

Returns

Promise<PoolInfo[]>

getPoolsHashrate()

getPoolsHashrate(): Promise<PoolHashrateEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10490

All pools hashrate (all time)

Get hashrate data for all mining pools.

Endpoint: GET /api/v1/mining/hashrate/pools

Returns

Promise<PoolHashrateEntry[]>

getPoolsHashrateByPeriod()

getPoolsHashrateByPeriod(time_period): Promise<PoolHashrateEntry[]>

Defined in: Developer/brk/modules/brk-client/index.js:10506

All pools hashrate

Get hashrate data for all mining pools for a time period. Valid periods: 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/hashrate/pools/{time_period}

Parameters

time_period

Returns

Promise<PoolHashrateEntry[]>

getPoolStats()

getPoolStats(time_period): Promise<PoolsSummary>

Defined in: Developer/brk/modules/brk-client/index.js:10617

Mining pool statistics

Get mining pool statistics for a time period. Valid periods: 24h, 3d, 1w, 1m, 3m, 6m, 1y, 2y, 3y

Endpoint: GET /api/v1/mining/pools/{time_period}

Parameters

time_period

Returns

Promise<PoolsSummary>

getPreciseFees()

getPreciseFees(): Promise<RecommendedFees>

Defined in: Developer/brk/modules/brk-client/index.js:10318

Precise recommended fees

Get recommended fee rates with up to 3 decimal places.

Endpoint: GET /api/v1/fees/precise

Returns

Promise<RecommendedFees>

getPrices()

getPrices(): Promise<Prices>

Defined in: Developer/brk/modules/brk-client/index.js:10647

Current BTC price

Returns bitcoin latest price (on-chain derived, USD only).

Endpoint: GET /api/v1/prices

Returns

Promise<Prices>

getRecommendedFees()

getRecommendedFees(): Promise<RecommendedFees>

Defined in: Developer/brk/modules/brk-client/index.js:10332

Recommended fees

Get recommended fee rates for different confirmation targets.

Endpoint: GET /api/v1/fees/recommended

Returns

Promise<RecommendedFees>

getRewardStats()

getRewardStats(block_count): Promise<RewardStats>

Defined in: Developer/brk/modules/brk-client/index.js:10633

Mining reward statistics

Get mining reward statistics for the last N blocks including total rewards, fees, and transaction count.

Endpoint: GET /api/v1/mining/reward-stats/{block_count}

Parameters

block_count

number

Number of recent blocks to include

Returns

Promise<RewardStats>

getSeries()

getSeries(series, index, start?, end?, limit?, format?): Promise<string | AnySeriesData>

Defined in: Developer/brk/modules/brk-client/index.js:9977

Get series data

Fetch data for a specific series at the given index. Use query parameters to filter by date range and format (json/csv).

Endpoint: GET /api/series/{series}/{index}

Parameters

series

string

Series name

index

Aggregation index

start?

number

Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: from, f, s

end?

number

Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: to, t, e

limit?

number

Maximum number of values to return (ignored if end is set). Aliases: count, c, l

format?

Format

Format of the output

Returns

Promise<string | AnySeriesData>

getSeriesBulk()

getSeriesBulk(series?, index?, start?, end?, limit?, format?): Promise<string | AnySeriesData[]>

Defined in: Developer/brk/modules/brk-client/index.js:9816

Bulk series data

Fetch multiple series in a single request. Supports filtering by index and date range. Returns an array of SeriesData objects. For a single series, use get_series instead.

Endpoint: GET /api/series/bulk

Parameters

series?

string

Requested series

index?

Index to query

start?

number

Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: from, f, s

end?

number

Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: to, t, e

limit?

number

Maximum number of values to return (ignored if end is set). Aliases: count, c, l

format?

Format

Format of the output

Returns

Promise<string | AnySeriesData[]>

getSeriesCount()

getSeriesCount(): Promise<SeriesCount[]>

Defined in: Developer/brk/modules/brk-client/index.js:9892

Series count

Returns the number of series available per index type.

Endpoint: GET /api/series/count

Returns

Promise<SeriesCount[]>

getSeriesData()

getSeriesData(series, index, start?, end?, limit?, format?): Promise<string | boolean[]>

Defined in: Developer/brk/modules/brk-client/index.js:10006

Get raw series data

Returns just the data array without the SeriesData wrapper. Supports the same range and format parameters as the standard endpoint.

Endpoint: GET /api/series/{series}/{index}/data

Parameters

series

string

Series name

index

Aggregation index

start?

number

Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: from, f, s

end?

number

Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: to, t, e

limit?

number

Maximum number of values to return (ignored if end is set). Aliases: count, c, l

format?

Format

Format of the output

Returns

Promise<string | boolean[]>

getSeriesInfo()

getSeriesInfo(series): Promise<SeriesInfo>

Defined in: Developer/brk/modules/brk-client/index.js:9958

Get series info

Returns the supported indexes and value type for the specified series.

Endpoint: GET /api/series/{series}

Parameters

series

string

Returns

Promise<SeriesInfo>

getSeriesLatest()

getSeriesLatest(series, index): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:10031

Get latest series value

Returns the single most recent value for a series, unwrapped (not inside a SeriesData object).

Endpoint: GET /api/series/{series}/{index}/latest

Parameters

series

string

Series name

index

Aggregation index

Returns

Promise<any>

getSeriesLen()

getSeriesLen(series, index): Promise<number>

Defined in: Developer/brk/modules/brk-client/index.js:10046

Get series data length

Returns the total number of data points for a series at the given index.

Endpoint: GET /api/series/{series}/{index}/len

Parameters

series

string

Series name

index

Aggregation index

Returns

Promise<number>

getSeriesTree()

getSeriesTree(): Promise<TreeNode>

Defined in: Developer/brk/modules/brk-client/index.js:9797

Series catalog

Returns the complete hierarchical catalog of available series organized as a tree structure. Series are grouped by categories and subcategories.

Endpoint: GET /api/series

Returns

Promise<TreeNode>

getSeriesVersion()

getSeriesVersion(series, index): Promise<number>

Defined in: Developer/brk/modules/brk-client/index.js:10061

Get series version

Returns the current version of a series. Changes when the series data is updated.

Endpoint: GET /api/series/{series}/{index}/version

Parameters

series

string

Series name

index

Aggregation index

Returns

Promise<number>

getSyncStatus()

getSyncStatus(): Promise<SyncStatus>

Defined in: Developer/brk/modules/brk-client/index.js:10085

Sync status

Returns the sync status of the indexer, including indexed height, tip height, blocks behind, and last indexed timestamp.

Endpoint: GET /api/server/sync

Returns

Promise<SyncStatus>

getText()

getText(path): Promise<string>

Defined in: Developer/brk/modules/brk-client/index.js:1603

Make a GET request and return raw text (for CSV responses)

Parameters

path

string

Returns

Promise<string>

Inherited from

BrkClientBase.getText

getTransactionTimes()

getTransactionTimes(): Promise<number[]>

Defined in: Developer/brk/modules/brk-client/index.js:10661

Transaction first-seen times

Returns timestamps when transactions were first seen in the mempool. Returns 0 for mined or unknown transactions.

Endpoint: GET /api/v1/transaction-times

Returns

Promise<number[]>

getTx()

getTx(txid): Promise<Transaction>

Defined in: Developer/brk/modules/brk-client/index.js:10101

Transaction information

Retrieve complete transaction data by transaction ID (txid). Returns inputs, outputs, fee, size, and confirmation status.

Endpoint: GET /api/tx/{txid}

Parameters

txid

string

Returns

Promise<Transaction>

getTxHex()

getTxHex(txid): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:10117

Transaction hex

Retrieve the raw transaction as a hex-encoded string. Returns the serialized transaction in hexadecimal format.

Endpoint: GET /api/tx/{txid}/hex

Parameters

txid

string

Returns

Promise<any>

getTxMerkleblockProof()

getTxMerkleblockProof(txid): Promise<any>

Defined in: Developer/brk/modules/brk-client/index.js:10149

Transaction merkleblock proof

Get the merkleblock proof for a transaction (BIP37 format, hex encoded).

Endpoint: GET /api/tx/{txid}/merkleblock-proof

Parameters

txid

string

Returns

Promise<any>

getTxMerkleProof()

getTxMerkleProof(txid): Promise<MerkleProof>

Defined in: Developer/brk/modules/brk-client/index.js:10133

Transaction merkle proof

Get the merkle inclusion proof for a transaction.

Endpoint: GET /api/tx/{txid}/merkle-proof

Parameters

txid

string

Returns

Promise<MerkleProof>

getTxOutspend()

getTxOutspend(txid, vout): Promise<TxOutspend>

Defined in: Developer/brk/modules/brk-client/index.js:10166

Output spend status

Get the spending status of a transaction output. Returns whether the output has been spent and, if so, the spending transaction details.

Endpoint: GET /api/tx/{txid}/outspend/{vout}

Parameters

txid

string

Transaction ID

vout

number

Output index

Returns

Promise<TxOutspend>

getTxOutspends()

getTxOutspends(txid): Promise<TxOutspend[]>

Defined in: Developer/brk/modules/brk-client/index.js:10182

All output spend statuses

Get the spending status of all outputs in a transaction. Returns an array with the spend status for each output.

Endpoint: GET /api/tx/{txid}/outspends

Parameters

txid

string

Returns

Promise<TxOutspend[]>

getTxRaw()

getTxRaw(txid): Promise<number[]>

Defined in: Developer/brk/modules/brk-client/index.js:10198

Transaction raw

Returns a transaction as binary data.

Endpoint: GET /api/tx/{txid}/raw

Parameters

txid

string

Returns

Promise<number[]>

getTxStatus()

getTxStatus(txid): Promise<TxStatus>

Defined in: Developer/brk/modules/brk-client/index.js:10214

Transaction status

Retrieve the confirmation status of a transaction. Returns whether the transaction is confirmed and, if so, the block height, hash, and timestamp.

Endpoint: GET /api/tx/{txid}/status

Parameters

txid

string

Returns

Promise<TxStatus>

getVersion()

getVersion(): Promise<string>

Defined in: Developer/brk/modules/brk-client/index.js:10713

API version

Returns the current version of the API server

Endpoint: GET /version

Returns

Promise<string>

indexToDate()

indexToDate(index, i): Date

Defined in: Developer/brk/modules/brk-client/index.js:7727

Convert an index value to a Date for date-based indexes.

Parameters

index

The index type

i

number

The index value

Returns

Date

listSeries()

listSeries(page?, per_page?): Promise<PaginatedSeries>

Defined in: Developer/brk/modules/brk-client/index.js:9919

Series list

Paginated flat list of all available series names. Use page query param for pagination.

Endpoint: GET /api/series/list

Parameters

page?

number

Pagination index

per_page?

number

Results per page (default: 1000, max: 1000)

Returns

Promise<PaginatedSeries>

searchSeries()

searchSeries(q?, limit?): Promise<string[]>

Defined in: Developer/brk/modules/brk-client/index.js:9939

Search series

Fuzzy search for series by name. Supports partial matches and typos.

Endpoint: GET /api/series/search

Parameters

q?

string

Search query string

limit?

number

Maximum number of results

Returns

Promise<string[]>

seriesEndpoint()

seriesEndpoint(series, index): SeriesEndpoint<unknown>

Defined in: Developer/brk/modules/brk-client/index.js:9425

Create a dynamic series endpoint builder for any series/index combination.

Use this for programmatic access when the series name is determined at runtime. For type-safe access, use the series tree instead.

Parameters

series

string

The series name

index

The index name

Returns

SeriesEndpoint<unknown>

validateAddress()

validateAddress(address): Promise<AddrValidation>

Defined in: Developer/brk/modules/brk-client/index.js:10677

Validate address

Validate a Bitcoin address and get information about its type and scriptPubKey.