README-bisq.md

mempoolJS - Bisq API

Interface to access Bisq API.

Back to home

---

Features

• Addresses
  • Get Address
• Blocks
  • Get Block
  • Get Blocks
  • Get Block Tip Height
• Statistics
• Transactions
  • Get Transaction
  • Get Transactions

---

Get Address

Returns statistics about all Bisq transactions.

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { addresses },
} = mempoolJS();

const address = 'B1DgwRN92rdQ9xpEVCdXRfgeqGw9X4YtrZz';

const myAddress = await addresses.getAddress({ address });
console.log(myAddress);

Get Block

Returns all Bisq transactions that exist in a Bitcoin block.

Parameters:

• {string} hash

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { blocks },
} = mempoolJS();

const hash = '000000000000000000079aa6bfa46eb8fc20474e8673d6e8a123b211236bf82d';

const block = await blocks.getBlock({ hash });
console.log(block);

Get Blocks

Returns :length Bitcoin blocks that contain Bisq transactions, starting from :index.

Parameters:

• {number} index
• {number} length

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { blocks },
} = mempoolJS();

const hash = '000000000000000000079aa6bfa46eb8fc20474e8673d6e8a123b211236bf82d';

const myBlocks = await blocks.getBlocks({ index: 0, length: 1 });
console.log(myBlocks);

Get Blocks Tip Height

Returns the most recently processed Bitcoin block height processed by Bisq.

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { blocks },
} = mempoolJS();

const myBlocksHeight = await blocks.getBlocksTipHeight({
  index: 0,
  length: 1,
});
console.log(myBlocksHeight);

Get Stats

Returns statistics about all Bisq transactions.

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { statistics },
} = mempoolJS();

const stats = await statistics.getStats();
console.log(stats);

Get Transaction

Returns details about a Bisq transaction.

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { transactions },
} = mempoolJS();

const txid = '4b5417ec5ab6112bedf539c3b4f5a806ed539542d8b717e1c4470aa3180edce5';

const tx = await transactions.getTx({ txid });
console.log(tx);

Get Transactions

Returns details about a Bisq transactions.

[ NodeJS Example ] [ HTML Example ] [ Top ]

const {
  bisq: { transactions },
} = mempoolJS();

const txs = await transactions.getTxs({ index: 0, length: 1 });
console.log(txs);