MempoolApi
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:239
Mempool.space REST API client for Bitcoin blockchain data
Constructors
Constructor
new MempoolApi(network, timeout?): MempoolApi;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:377
Parameters
| Parameter | Type |
|---|---|
network | BitcoinNetwork |
timeout? | number |
Returns
MempoolApi
Constructor
new MempoolApi(url, timeout?): MempoolApi;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:378
Parameters
| Parameter | Type |
|---|---|
url | string | string[] |
timeout? | number |
Returns
MempoolApi
Properties
backends
backends: object[];
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:241
operational
operational: boolean;
url
url: string;
timeout
timeout: number;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:245
Methods
getAddressBalances()
getAddressBalances(address): Promise<{
confirmedBalance: bigint;
unconfirmedBalance: bigint;
}>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:440
Returns confirmed & unconfirmed balance of the specific bitcoin address
Parameters
| Parameter | Type | Description |
|---|---|---|
address | string |
Returns
Promise<{
confirmedBalance: bigint;
unconfirmedBalance: bigint;
}>
getAddressTransactions()
getAddressTransactions(address): Promise<BitcoinTransaction[]>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:504
Returns all transactions for a given address
Parameters
| Parameter | Type | Description |
|---|---|---|
address | string |
Returns
Promise<BitcoinTransaction[]>
getAddressUTXOs()
getAddressUTXOs(address): Promise<object[]>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:473
Returns UTXOs (unspent transaction outputs) for a given address
Parameters
| Parameter | Type | Description |
|---|---|---|
address | string |
Returns
Promise<object[]>
getBlockHash()
getBlockHash(height): Promise<string>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:571
Returns blockhash of a block at a specific blockheight
Parameters
| Parameter | Type | Description |
|---|---|---|
height | number |
Returns
Promise<string>
getBlockHeader()
getBlockHeader(blockhash): Promise<BitcoinBlockHeader>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:531
Returns the bitcoin blockheader as identified by its blockhash
Parameters
| Parameter | Type | Description |
|---|---|---|
blockhash | string |
Returns
Promise<BitcoinBlockHeader>
getBlockStatus()
getBlockStatus(blockhash): Promise<BlockStatus>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:541
Returns the block status
Parameters
| Parameter | Type | Description |
|---|---|---|
blockhash | string |
Returns
Promise<BlockStatus>
getCPFPData()
getCPFPData(txId): Promise<TransactionCPFPData>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:463
Returns CPFP (children pays for parent) data for a given transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
txId | string |
Returns
Promise<TransactionCPFPData>
getFees()
getFees(): Promise<BitcoinFees>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:494
Returns current on-chain bitcoin fees
Returns
Promise<BitcoinFees>
getLNNodeInfo()
getLNNodeInfo(pubkey): Promise<LNNodeInfo>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:400
Returns information about a specific lightning network node as identified by the public key (in hex encoding)
Parameters
| Parameter | Type | Description |
|---|---|---|
pubkey | string |
Returns
Promise<LNNodeInfo>
getOutspends()
getOutspends(txId): Promise<TransactionOutspend[]>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:561
Returns the transaction's proof (merkle proof)
Parameters
| Parameter | Type | Description |
|---|---|---|
txId | string |
Returns
Promise<TransactionOutspend[]>
getPast15BlockHeaders()
getPast15BlockHeaders(endHeight): Promise<BlockData[]>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:581
Returns past 15 blockheaders before (and including) the specified height
Parameters
| Parameter | Type | Description |
|---|---|---|
endHeight | number |
Returns
Promise<BlockData[]>
getPendingBlocks()
getPendingBlocks(): Promise<BitcoinPendingBlock[]>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:512
Returns expected pending (mempool) blocks
Returns
Promise<BitcoinPendingBlock[]>
getRawTransaction()
getRawTransaction(txId): Promise<Buffer<ArrayBufferLike>>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:426
Returns raw binary encoded bitcoin transaction, also strips the witness data from the transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
txId | string |
Returns
Promise<Buffer<ArrayBufferLike>>
getTipBlockHeight()
getTipBlockHeight(): Promise<number>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:520
Returns the blockheight of the current bitcoin blockchain's tip
Returns
Promise<number>
getTransaction()
getTransaction(txId): Promise<BitcoinTransaction>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:413
Returns on-chain transaction as identified by its txId
Parameters
| Parameter | Type | Description |
|---|---|---|
txId | string |
Returns
Promise<BitcoinTransaction>
getTransactionProof()
getTransactionProof(txId): Promise<TransactionProof>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:551
Returns the transaction's proof (merkle proof)
Parameters
| Parameter | Type | Description |
|---|---|---|
txId | string |
Returns
Promise<TransactionProof>
sendTransaction()
sendTransaction(transactionHex): Promise<string>;
Defined in: atomiq-btc-mempool/src/mempool/MempoolApi.ts:591
Sends raw hex encoded bitcoin transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
transactionHex | string |
Returns
Promise<string>