From 010381aac460b8947cb048b163f27874c39e7733 Mon Sep 17 00:00:00 2001 From: hunicus <93150691+hunicus@users.noreply.github.com> Date: Thu, 16 Dec 2021 08:46:51 -0500 Subject: [PATCH] Convert accordions to plain html --- .../components/docs/api-docs.component.html | 1322 +++++++---------- 1 file changed, 564 insertions(+), 758 deletions(-) diff --git a/frontend/src/app/components/docs/api-docs.component.html b/frontend/src/app/components/docs/api-docs.component.html index 40aed1cd9..5f7d725e8 100644 --- a/frontend/src/app/components/docs/api-docs.component.html +++ b/frontend/src/app/components/docs/api-docs.component.html @@ -76,849 +76,655 @@

Reference for the {{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API service.

-

General

- + +

General

- - - GET Difficulty Adjustment - - -
-
-
Endpoint
- GET {{ baseNetworkUrl }}/api/v1/difficulty-adjustment -
-
-
Description
-
Returns details about difficulty adjustment.
-
- -
- - +
+ GET Difficulty Adjustment +
+
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/v1/difficulty-adjustment +
+
+
Description
+
Returns details about difficulty adjustment.
+
+ +
+
-
+

Markets

- - - - GET Market Currencies - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/currencies -
-
-
Description
-
Provides list of available currencies for a given base currency.
-
- - - +
+ GET Market Currencies +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/currencies +
+
+
Description
+
Provides list of available currencies for a given base currency.
+
+ +
- - - GET Market Depth - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/depth?market=[:market] -
-
-
Description
-
Provides list of open offer prices for a single market.
-
- - - +
+ GET Market Depth +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/depth?market=[:market] +
+
+
Description
+
Provides list of open offer prices for a single market.
+
+ +
- - - GET Market HLOC - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/hloc?market=[:market] -
-
-
Description
-
Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.
-
- - - +
+ GET Market HLOC +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/hloc?market=[:market] +
+
+
Description
+
Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.
+
+ +
- - - GET Markets - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/markets -
-
-
Description
-
Provides list of available markets.
-
- - - +
+ GET Markets +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/markets +
+
+
Description
+
Provides list of available markets.
+
+ +
- - - GET Market Offers - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/offers?market=[:market] -
-
-
Description
-
Provides list of open offer details for a single market.
-
- - - +
+ GET Market Offers +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/offers?market=[:market] +
+
+
Description
+
Provides list of open offer details for a single market.
+
+ +
- - - GET Market Ticker - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/ticker?market=[:market] -
-
-
Description
-
Provides 24 hour price ticker for single market or all markets
-
- - - +
+ GET Market Ticker +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/ticker?market=[:market] +
+
+
Description
+
Provides 24 hour price ticker for single market or all markets
+
+ +
- - - GET Market Trades - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/trades?market=[:market]&limit=[:limit] -
-
-
Description
-
Provides list of completed trades for a single market.
-
- - - +
+ GET Market Trades +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/trades?market=[:market]&limit=[:limit] +
+
+
Description
+
Provides list of completed trades for a single market.
+
+ +
- - - GET Market Volumes - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/volumes?basecurrency=[:basecurrency] -
-
-
Description
-
Provides periodic volume data in terms of base currency for one or all markets.
-
- - - +
+ GET Market Volumes +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/volumes?basecurrency=[:basecurrency] +
+
+
Description
+
Provides periodic volume data in terms of base currency for one or all markets.
+
+ +
-
-

General

- + +

General

- - - GET Stats - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/stats -
-
-
Description
-
Returns statistics about all Bisq transactions.
-
- - - +
+ GET Stats +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/stats +
+
+
Description
+
Returns statistics about all Bisq transactions.
+
+ +
-
+

Addresses

- - - - GET Address - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/address/:address -
-
-
Description
-
Returns details about an address. Available fields: address, chain_stats, and mempool_stats. {{ '{' }}chain,mempool{{ '}' }}_stats each contain an object with tx_count, funded_txo_count, funded_txo_sum, spent_txo_count, and spent_txo_sum.
-
- - - +
+ GET Address +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/address/:address +
+
+
Description
+
Returns details about an address. Available fields: address, chain_stats, and mempool_stats. {{ '{' }}chain,mempool{{ '}' }}_stats each contain an object with tx_count, funded_txo_count, funded_txo_sum, spent_txo_count, and spent_txo_sum.
+
+ +
- - - GET Address Transactions - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/address/:address/txs -
-
-
Description
-
Get transaction history for the specified address/scripthash, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. You can request more confirmed transactions using :last_seen_txid (see below).
-
- - - +
+ GET Address Transactions +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/address/:address/txs +
+
+
Description
+
Get transaction history for the specified address/scripthash, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. You can request more confirmed transactions using :last_seen_txid (see below).
+
+ +
- - - GET Address Transactions Chain - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/address/:address/txs/chain -
-
-
Description
-
Get confirmed transaction history for the specified address/scripthash, sorted with newest first. Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.
-
- - - +
+ GET Address Transactions Chain +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/address/:address/txs/chain +
+
+
Description
+
Get confirmed transaction history for the specified address/scripthash, sorted with newest first. Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.
+
+ +
- - - GET Address Transactions Mempool - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/address/:address/txs/mempool -
-
-
Description
-
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
-
- - - +
+ GET Address Transactions Mempool +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/address/:address/txs/mempool +
+
+
Description
+
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
+
+ +
- - - GET Address UTXO - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/address/:address/utxo -
-
-
Description
-
Get the list of unspent transaction outputs associated with the address/scripthash. Available fields: txid, vout, value, and status (with the status of the funding tx).There is also a valuecommitment field that may appear in place of value, plus the following additional fields: asset/assetcommitment, nonce/noncecommitment, surjection_proof, and range_proof.
-
- - - +
+ GET Address UTXO +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/address/:address/utxo +
+
+
Description
+
Get the list of unspent transaction outputs associated with the address/scripthash. Available fields: txid, vout, value, and status (with the status of the funding tx).There is also a valuecommitment field that may appear in place of value, plus the following additional fields: asset/assetcommitment, nonce/noncecommitment, surjection_proof, and range_proof.
+
+ +
-
+

Assets

- - - - GET Assets - - -
-
Endpoint
- GET /liquid/api/asset/:asset_id -
-
-
Description
-
Returns information about a Liquid asset.
-
- - - +
+ GET Assets +
+
Endpoint
+ GET /liquid/api/asset/:asset_id +
+
+
Description
+
Returns information about a Liquid asset.
+
+ +
- - - GET Asset Transactions - - -
- GET /liquid/api/asset/:asset_id/txs[/mempool|/chain] -
-
-
Description
-
Returns transactions associated with the specified Liquid asset. For the network's native asset, returns a list of peg in, peg out, and burn transactions. For user-issued assets, returns a list of issuance, reissuance, and burn transactions. Does not include regular transactions transferring this asset.
-
- - - +
+ GET Asset Transactions +
+ GET /liquid/api/asset/:asset_id/txs[/mempool|/chain] +
+
+
Description
+
Returns transactions associated with the specified Liquid asset. For the network's native asset, returns a list of peg in, peg out, and burn transactions. For user-issued assets, returns a list of issuance, reissuance, and burn transactions. Does not include regular transactions transferring this asset.
+
+ +
- - - GET Asset Supply - - -
-
Endpoint
- GET /liquid/api/asset/:asset_id/supply[/decimal] -
-
-
Description
-
Get the current total supply of the specified asset. For the native asset (L-BTC), this is calculated as [chain,mempool]_stats.peg_in_amount - [chain,mempool]_stats.peg_out_amount - [chain,mempool]_stats.burned_amount. For issued assets, this is calculated as [chain,mempool]_stats.issued_amount - [chain,mempool]_stats.burned_amount. Not available for assets with blinded issuances. If /decimal is specified, returns the supply as a decimal according to the asset's divisibility. Otherwise, returned in base units.
-
- - - +
+ GET Asset Supply +
+
Endpoint
+ GET /liquid/api/asset/:asset_id/supply[/decimal] +
+
+
Description
+
Get the current total supply of the specified asset. For the native asset (L-BTC), this is calculated as [chain,mempool]_stats.peg_in_amount - [chain,mempool]_stats.peg_out_amount - [chain,mempool]_stats.burned_amount. For issued assets, this is calculated as [chain,mempool]_stats.issued_amount - [chain,mempool]_stats.burned_amount. Not available for assets with blinded issuances. If /decimal is specified, returns the supply as a decimal according to the asset's divisibility. Otherwise, returned in base units.
+
+ +
-
+

Blocks

- - - - GET Block - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block/:hash -
-
-
Description
-
Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, proof, and previousblockhash.
-
- - - +
+ GET Block +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block/:hash +
+
+
Description
+
Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, proof, and previousblockhash.
+
+ +
- - - GET Block Header - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block/:hash/header -
-
-
Description
-
Returns the hex-encoded block header.
-
- - - +
+ GET Block Header +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block/:hash/header +
+
+
Description
+
Returns the hex-encoded block header.
+
+ +
- - - GET Block Height - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block-height/:height -
-
-
Description
-
Returns the hash of the block currently at :height.
-
- - - +
+ GET Block Height +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block-height/:height +
+
+
Description
+
Returns the hash of the block currently at :height.
+
+ +
- - - GET Block Raw - - -
- GET {{ baseNetworkUrl }}/api/block/:hash/raw -
-
-
Description
-
Returns the raw block representation in binary.
-
- - - +
+ GET Block Raw +
+ GET {{ baseNetworkUrl }}/api/block/:hash/raw +
+
+
Description
+
Returns the raw block representation in binary.
+
+ +
- - - GET Block Status - - -
Get Block Status
-
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block/:hash/status -
-
-
Description
-
Returns the confirmation status of a block. Available fields: in_best_chain (boolean, false for orphaned blocks), next_best (the hash of the next block, only available for blocks in the best chain).
-
- - - +
+ GET Block Status +
Get Block Status
+
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block/:hash/status +
+
+
Description
+
Returns the confirmation status of a block. Available fields: in_best_chain (boolean, false for orphaned blocks), next_best (the hash of the next block, only available for blocks in the best chain).
+
+ +
- - - GET Block Tip Height - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/blocks/tip/height -
-
-
Description
-
Returns the height of the last block.
-
- - - +
+ GET Block Tip Height +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/blocks/tip/height +
+
+
Description
+
Returns the height of the last block.
+
+ +
- - - GET Block Tip Hash - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/blocks/tip/hash -
-
-
Description
-
Returns the hash of the last block.
-
- - - +
+ GET Block Tip Hash +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/blocks/tip/hash +
+
+
Description
+
Returns the hash of the last block.
+
+ +
- - - GET Block Transaction ID - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block/:hash/txid/:index -
-
-
Description
-
Returns the transaction at index :index within the specified block.
-
- - - +
+ GET Block Transaction ID +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block/:hash/txid/:index +
+
+
Description
+
Returns the transaction at index :index within the specified block.
+
+ +
- - - GET Block Transaction IDs - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block/:hash/txids -
-
-
Description
-
Returns a list of all txids in the block.
-
- - - +
+ GET Block Transaction IDs +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block/:hash/txids +
+
+
Description
+
Returns a list of all txids in the block.
+
+ +
- - - GET Block Transactions - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/block/:hash/txs[/:start_index] -
-
-
Description
-
Returns a list of transactions in the block (up to 25 transactions beginning at start_index). Transactions returned here do not have the status field, since all the transactions share the same block and confirmation status.
-
- - - +
+ GET Block Transactions +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/block/:hash/txs[/:start_index] +
+
+
Description
+
Returns a list of transactions in the block (up to 25 transactions beginning at start_index). Transactions returned here do not have the status field, since all the transactions share the same block and confirmation status.
+
+ +
- - - GET Blocks - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/blocks[/:start_height] -
-
-
Description
-
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
-
- - - +
+ GET Blocks +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/blocks[/:start_height] +
+
+
Description
+
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
+
+ +
- - - GET Blocks - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/blocks/:index/:length -
-
-
Description
-
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
-
- - - +
+ GET Blocks +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/blocks/:index/:length +
+
+
Description
+
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
+
+ +
-
+

Fees

- - - - GET Mempool Blocks Fees - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/v1/fees/mempool-blocks -
-
-
Description
-
Returns current mempool as projected blocks.
-
- - - +
+ GET Mempool Blocks Fees +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/v1/fees/mempool-blocks +
+
+
Description
+
Returns current mempool as projected blocks.
+
+ +
- - - GET Recommended Fees - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/v1/fees/recommended -
-
-
Description
-
Returns our currently suggested fees for new transactions.
-
- - - +
+ GET Recommended Fees +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/v1/fees/recommended +
+
+
Description
+
Returns our currently suggested fees for new transactions.
+
+ +
-
+

Mempool

- - - - GET Mempool - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/mempool -
-
-
Description
-
Returns current mempool backlog statistics.
-
- - - +
+ GET Mempool +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/mempool +
+
+
Description
+
Returns current mempool backlog statistics.
+
+ +
- - - GET Mempool Transactions IDs - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/mempool/txids -
-
-
Description
-
Get the full list of txids in the mempool as an array. The order of the txids is arbitrary and does not match bitcoind.
-
- - - +
+ GET Mempool Transactions IDs +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/mempool/txids +
+
+
Description
+
Get the full list of txids in the mempool as an array. The order of the txids is arbitrary and does not match bitcoind.
+
+ +
- - - GET Mempool Recent - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/mempool/recent -
-
-
Description
-
Get a list of the last 10 transactions to enter the mempool. Each transaction object contains simplified overview data, with the following fields: txid, fee, vsize, and value.
-
- - - +
+ GET Mempool Recent +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/mempool/recent +
+
+
Description
+
Get a list of the last 10 transactions to enter the mempool. Each transaction object contains simplified overview data, with the following fields: txid, fee, vsize, and value.
+
+ +
-
+

Transactions

- - - - GET Children Pay for Parent - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/v1/cpfp/:txid -
-
-
Description
-
Returns the ancestors and the best descendant fees for a transaction.
-
- - - +
+ GET Children Pay for Parent +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/v1/cpfp/:txid +
+
+
Description
+
Returns the ancestors and the best descendant fees for a transaction.
+
+ +
- - - GET Transaction - - -
- GET {{ baseNetworkUrl }}/api/tx/:txid -
-
-
Description
-
Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
-
- - - +
+ GET Transaction +
+ GET {{ baseNetworkUrl }}/api/tx/:txid +
+
+
Description
+
Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
+
+ +
- - - GET Transaction Hex - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/hex -
-
-
Description
-
Returns a transaction serialized as hex.
-
- - - +
+ GET Transaction Hex +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/hex +
+
+
Description
+
Returns a transaction serialized as hex.
+
+ +
- - - GET Transaction Merkleblock Proof - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/merkleblock-proof -
-
-
Description
-
Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
-
- - - +
+ GET Transaction Merkleblock Proof +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/merkleblock-proof +
+
+
Description
+
Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
+
+ +
- - - GET Transaction Merkle Proof - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/merkle-proof -
-
-
Description
-
Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
-
- - - +
+ GET Transaction Merkle Proof +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/merkle-proof +
+
+
Description
+
Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
+
+ +
- - - GET Transaction Outspend - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/outspend/:vout -
-
-
Description
-
Returns the spending status of a transaction output. Available fields: spent (boolean), txid (optional), vin (optional), and status (optional, the status of the spending tx).
-
- - - +
+ GET Transaction Outspend +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/outspend/:vout +
+
+
Description
+
Returns the spending status of a transaction output. Available fields: spent (boolean), txid (optional), vin (optional), and status (optional, the status of the spending tx).
+
+ +
- - - GET Transaction Outspends - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/outspends -
-
-
Description
-
Returns the spending status of all transaction outputs.
-
- - - +
+ GET Transaction Outspends +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/outspends +
+
+
Description
+
Returns the spending status of all transaction outputs.
+
+ +
- - - GET Transaction Raw - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/raw -
-
-
Description
-
Returns a transaction as binary data.
-
- - - +
+ GET Transaction Raw +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/raw +
+
+
Description
+
Returns a transaction as binary data.
+
+ +
- - - GET Transaction Status - - -
-
Endpoint
- GET {{ baseNetworkUrl }}/api/tx/:txid/status -
-
-
Description
-
Returns the confirmation status of a transaction. Available fields: confirmed (boolean), block_height (optional), and block_hash (optional).
-
- - - +
+ GET Transaction Status +
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/tx/:txid/status +
+
+
Description
+
Returns the confirmation status of a transaction. Available fields: confirmed (boolean), block_height (optional), and block_hash (optional).
+
+ +
- - - GET Transactions - - -
Get Mempool Txids
-
-
Endpoint
- GET {{ baseNetworkUrl }}/api/txs/:index/:length -
-
-
Description
-
Returns :length of latest Bisq transactions, starting from :index.
-
- - - +
+ GET Transactions +
Get Mempool Txids
+
+
Endpoint
+ GET {{ baseNetworkUrl }}/api/txs/:index/:length +
+
+
Description
+
Returns :length of latest Bisq transactions, starting from :index.
+
+ +
- - - POST Transaction - - -
-
Endpoint
-
POST /api/tx
-
-
-
Description
-
Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The txid will be returned on success.
-
- - - - - +
+ POST Transaction +
+
Endpoint
+
POST /api/tx
+
+
+
Description
+
Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The txid will be returned on success.
+
+ +