2021-12-01 17:01:50 -05:00
< ng-container * ngIf = "{ val: network$ | async } as network" >
< div class = "container-xl text-left" >
< div id = "restAPI" * ngIf = "restTabActivated" >
2021-12-15 21:31:00 -05:00
< div class = "doc-nav-desktop" [ ngClass ] = " docsNavPosition " >
2021-12-15 22:55:29 -05:00
< p * ngIf = "network.val !== 'bisq' && network.val !== 'liquid'" > General< / p >
< a * ngIf = "network.val !== 'bisq' && network.val !== 'liquid'" href = "#" > GET Difficulty Adjustment< / a >
< p * ngIf = "network.val === 'bisq'" > Markets< / p >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market Currencies< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market Depth< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market HLOC< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Markets< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market Offers< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market Ticker< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market Trades< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Market Volumes< / a >
< p * ngIf = "network.val === 'bisq'" > General< / p >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Stats< / a >
< p > Addresses< / p >
< a href = "#" > GET Address< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Address Transactions< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Address Transactions Chain< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Address Transactions Mempool< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Address UTXO< / a >
< p * ngIf = "network.val === 'liquid'" > Assets< / p >
< a * ngIf = "network.val === 'liquid'" href = "#" > GET Assets< / a >
< a * ngIf = "network.val === 'liquid'" href = "#" > GET Asset Transactions< / a >
< a * ngIf = "network.val === 'liquid'" href = "#" > GET Asset Supply< / a >
< p > Blocks< / p >
< a href = "#" > GET Block< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Header< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Height< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Raw< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Status< / a >
< a href = "#" > GET Block Tip Height< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Tip Hash< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Transaction ID< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Transaction IDs< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Block Transactions< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Blocks< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Blocks< / a >
< p * ngIf = "network.val !== 'bisq'" > Fees< / p >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Mempool Blocks Fees< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Recommended Fees< / a >
< p * ngIf = "network.val !== 'bisq'" > Mempool< / p >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Mempool< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Mempool Transaction IDs< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Mempool Recent< / a >
< p > Transactions< / p >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Children Pay for Parent< / a >
< a href = "#" > GET Transaction< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Transaction Hex< / a >
< a * ngIf = "network.val !== 'bisq' && network.val !== 'liquid'" href = "#" > GET Transaction Merkleblock Proof< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Transaction Merkle Proof< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Transaction Outspend< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Transaction Outspends< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Transaction Raw< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > GET Transaction Status< / a >
< a * ngIf = "network.val === 'bisq'" href = "#" > GET Transactions< / a >
< a * ngIf = "network.val !== 'bisq'" href = "#" > POST Transaction< / a >
2021-12-15 13:17:37 -05:00
< / div >
< div class = "doc-content" >
< p > Reference for the {{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} < ng-container i18n = "api-docs.title" > API service< / ng-container > .< / p >
< div class = "api-category" * ngIf = "network.val !== 'bisq' && network.val !== 'liquid'" >
< h4 i18n = "api-docs.tab.general|API Docs tab for General" > General< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
< ngb-panel id = "difficultyAdjustment" * ngIf = "network.val !== 'liquid'" >
< ng-template ngbPanelTitle >
< span > GET Difficulty Adjustment< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "difficulty" >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . difficulty ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/v1/difficulty-adjustment< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns details about difficulty adjustment.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . difficulty " [ network ] = " network . val " > < / app-code-template >
< / div >
< / ng-template >
< / ngb-panel >
< / ngb-accordion >
< / div >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< div class = "api-category" * ngIf = "network.val === 'bisq'" >
< h4 i18n = "Bisq All Markets" > Markets< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< ngb-panel id = "bisqMarketsCurrencies" >
< ng-template ngbPanelTitle >
< span > GET Market Currencies< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . marketsCurrencies ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/currencies< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides list of available currencies for a given base currency. < / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketsCurrencies " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "marketDepth" >
< ng-template ngbPanelTitle >
< span > GET Market Depth< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . marketDepth ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/depth?market=[:market]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides list of open offer prices for a single market.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketDepth " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "bisqMarketsHloc" >
< ng-template ngbPanelTitle >
< span > GET Market HLOC< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . marketHloc ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/hloc?market=[:market]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketHloc " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "bisqMarketsMarkets" >
< ng-template ngbPanelTitle >
< span > GET Markets< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . markets ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/markets< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides list of available markets.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . markets " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "bisqMarketsOffers" >
< ng-template ngbPanelTitle >
< span > GET Market Offers< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . marketOffers ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/offers?market=[:market]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides list of open offer details for a single market.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketOffers " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "bisqMarketsTicker" >
< ng-template ngbPanelTitle >
< span > GET Market Ticker< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . marketTicker ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/ticker?market=[:market]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides 24 hour price ticker for single market or all markets< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketTicker " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "bisqMarketsTrades" >
< ng-template ngbPanelTitle >
< span > GET Market Trades< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . marketTrades ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/trades?market=[:market]& limit=[:limit]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Provides list of completed trades for a single market.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketTrades " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "bisqMarketsVolumes" >
< ng-template ngbPanelTitle >
< span > GET Market Volumes< / span >
< / ng-template >
< ng-template ngbPanelContent >
2021-12-01 17:01:50 -05:00
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
2021-12-15 13:17:37 -05:00
< a [ href ] = " wrapUrl ( network . val , code . marketVolumes ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/volumes?basecurrency=[:basecurrency]< / a >
2021-12-01 17:01:50 -05:00
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
2021-12-15 13:17:37 -05:00
< div i18n > Provides periodic volume data in terms of base currency for one or all markets.< / div >
2021-12-01 17:01:50 -05:00
< / div >
2021-12-15 13:17:37 -05:00
< app-code-template [ hostname ] = " hostname " [ code ] = " code . marketVolumes " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< / ngb-accordion >
< / div >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< div class = "api-category" * ngIf = "network.val === 'bisq'" >
< h4 ngbNavLink i18n = "api-docs.tab.bsq|API Docs tab for BSQ" > General< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< ngb-panel id = "bisqStats" >
< ng-template ngbPanelTitle >
< span > GET Stats< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . stats ) " target = "_blank'" target = "_blank" > GET {{ baseNetworkUrl }}/api/stats< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns statistics about all Bisq transactions.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . stats " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< / ngb-accordion >
< / div >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< div class = "api-category" >
< h4 i18n = "api-docs.tab.addresses|API Docs tab for Addresses" > Addresses< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< ngb-panel id = "address" >
< ng-template ngbPanelTitle >
< span > GET Address< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . address ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/address/:address< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns details about an address. Available fields: < code > address< / code > , < code > chain_stats< / code > , and < code > mempool_stats< / code > . {{ '{' }}chain,mempool{{ '}' }}_stats each contain an object with < code > tx_count< / code > , < code > funded_txo_count< / code > , < code > funded_txo_sum< / code > , < code > spent_txo_count< / code > , and < code > spent_txo_sum< / code > .< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . address " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "addressTransactions" >
< ng-template ngbPanelTitle >
< span > GET Address Transactions< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . addressTransactions ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/address/:address/txs< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > 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 < code > :last_seen_txid< / code > (see below).< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . addressTransactions " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "addressTransactionsChain" >
< ng-template ngbPanelTitle >
< span > GET Address Transactions Chain< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . addressTransactionsChain ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/address/:address/txs/chain< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > 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.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . addressTransactionsChain " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "addressTransactionsMempool" >
< ng-template ngbPanelTitle >
< span > GET Address Transactions Mempool< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . addressTransactionsMempool ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/address/:address/txs/mempool< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . addressTransactionsMempool " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "addressUTXO" >
< ng-template ngbPanelTitle >
< span > GET Address UTXO< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . addressUTXO ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/address/:address/utxo< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Get the list of unspent transaction outputs associated with the address/scripthash. Available fields: < code > txid< / code > , < code > vout< / code > , < code > value< / code > , and < code > status< / code > (with the status of the funding tx).< ng-container * ngIf = "network.val === 'liquid'" > There is also a < code > valuecommitment< / code > field that may appear in place of < code > value< / code > , plus the following additional fields: < code > asset< / code > /< code > assetcommitment< / code > , < code > nonce< / code > /< code > noncecommitment< / code > , < code > surjection_proof< / code > , and < code > range_proof< / code > .< / ng-container > < / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . addressUTXO " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< / ngb-accordion >
< / div >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< div class = "api-category" * ngIf = "network.val === 'liquid'" >
< h4 i18n = "api-docs.tab.assets|API Docs tab for Assets" > Assets< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
2021-12-01 17:01:50 -05:00
2021-12-15 13:17:37 -05:00
< ngb-panel id = "assets" >
< ng-template ngbPanelTitle >
< span > GET Assets< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . assets ) " target = "_blank" > GET /liquid/api/asset/:asset_id< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns information about a Liquid asset.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . assets " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "assetTransactions" >
< ng-template ngbPanelTitle >
< span > GET Asset Transactions< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< a [ href ] = " wrapUrl ( network . val , code . assetTransactions ) " target = "_blank" > GET /liquid/api/asset/:asset_id/txs[/mempool|/chain]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > 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.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . assetTransactions " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "assetSupply" >
< ng-template ngbPanelTitle >
< span > GET Asset Supply< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . assetSupply ) " target = "_blank" > GET /liquid/api/asset/:asset_id/supply[/decimal]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > 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.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . assetSupply " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< / ngb-accordion >
< / div >
< div class = "api-category" >
< h4 i18n = "api-docs.tab.blocks|API Docs tab for Blocks" > Blocks< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
< ngb-panel id = "block" >
< ng-template ngbPanelTitle >
< span > GET Block< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . block ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns details about a block. Available fields: < code > id< / code > , < code > height< / code > , < code > version< / code > , < code > timestamp< / code > , < code > bits< / code > , < code > nonce< / code > , < code > merkle_root< / code > , < code > tx_count< / code > , < code > size< / code > , < code > weight< / code > ,< ng-container * ngIf = "network.val === 'liquid'" > < code > proof< / code > ,< / ng-container > and < code > previousblockhash< / code > .< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . block " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockHeader" >
< ng-template ngbPanelTitle >
< span > GET Block Header< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockHeader ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash/header< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the hex-encoded block header.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockHeader " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockHeight" >
< ng-template ngbPanelTitle >
< span > GET Block Height< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockHeader ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block-height/:height< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the hash of the block currently at < code > :height< / code > .< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockHeight " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockRaw" >
< ng-template ngbPanelTitle >
< span > GET Block Raw< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< a [ href ] = " wrapUrl ( network . val , code . blockRaw ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash/raw< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the raw block representation in binary.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockRaw " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockStatus" >
< ng-template ngbPanelTitle >
< span > GET Block Status< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "title" > Get Block Status< / div >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockStatus ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash/status< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the confirmation status of a block. Available fields: < code > in_best_chain< / code > (boolean, false for orphaned blocks), < code > next_best< / code > (the hash of the next block, only available for blocks in the best chain).< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockStatus " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "blockTipHeight" >
< ng-template ngbPanelTitle >
< span > GET Block Tip Height< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockTipHeight ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/blocks/tip/height< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the height of the last block.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockTipHeight " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockTipHash" >
< ng-template ngbPanelTitle >
< span > GET Block Tip Hash< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockTipHash ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/blocks/tip/hash< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the hash of the last block.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockTipHash " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockTxId" >
< ng-template ngbPanelTitle >
< span > GET Block Transaction ID< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockTxId ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash/txid/:index< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the transaction at index < code > :index< / code > within the specified block.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockTxId " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockTxIds" >
< ng-template ngbPanelTitle >
< span > GET Block Transaction IDs< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockTxIds ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash/txids< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns a list of all txids in the block.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockTxIds " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blockTxs" >
< ng-template ngbPanelTitle >
< span > GET Block Transactions< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blockTxs ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/block/:hash/txs[/:start_index]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns a list of transactions in the block (up to 25 transactions beginning at < code > start_index< / code > ). Transactions returned here do not have the < code > status< / code > field, since all the transactions share the same block and confirmation status.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blockTxs " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "blocks" >
< ng-template ngbPanelTitle >
< span > GET Blocks< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blocks ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/blocks[/:start_height]< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the 10 newest blocks starting at the tip or at < code > :start_height< / code > if specified.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blocks " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val === 'bisq'" id = "blocks" >
< ng-template ngbPanelTitle >
< span > GET Blocks< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . blocksBisq ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/blocks/:index/:length< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the 10 newest blocks starting at the tip or at < code > :start_height< / code > if specified.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . blocksBisq " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< / ngb-accordion >
< / div >
< div class = "api-category" * ngIf = "network.val !== 'bisq'" >
< h4 i18n = "api-docs.tab.fees|API Docs tab for Fees" > Fees< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
< ngb-panel id = "feeMempoolBlocks" >
< ng-template ngbPanelTitle >
< span > GET Mempool Blocks Fees< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . feeMempoolBlocks ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/v1/fees/mempool-blocks< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.fees.mempool-blocks|API Docs for /api/v1/fees/mempool-blocks" > Returns current mempool as projected blocks.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . feeMempoolBlocks " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "feeRecommended" >
< ng-template ngbPanelTitle >
< span > GET Recommended Fees< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . feeRecommended ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/v1/fees/recommended< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.fees.recommended|API Docs for /api/v1/fees/recommended" > Returns our currently suggested fees for new transactions.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . feeRecommended " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< / ngb-accordion >
< / div >
< div class = "api-category" * ngIf = "network.val !== 'bisq'" >
< h4 i18n = "api-docs.tab.mempool|API Docs tab for Mempool" > Mempool< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
< ngb-panel id = "mempool" >
< ng-template ngbPanelTitle >
< span > GET Mempool< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . mempool ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/mempool< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.mempool.mempool|API Docs for /api/mempool" > Returns current mempool backlog statistics.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . mempool " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "mempoolTxs" >
< ng-template ngbPanelTitle >
< span > GET Mempool Transactions IDs< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . mempoolTxs ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/mempool/txids< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.mempool.txids|API Docs for /api/mempool/txids" > Get the full list of txids in the mempool as an array. The order of the txids is arbitrary and does not match bitcoind.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . mempoolTxs " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "mempoolRecent" >
< ng-template ngbPanelTitle >
< span > GET Mempool Recent< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . mempoolRecent ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/mempool/recent< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.mempool.recent|API Docs for /api/mempool/recent" > Get a list of the last 10 transactions to enter the mempool. Each transaction object contains simplified overview data, with the following fields: < code > txid< / code > , < code > fee< / code > , < code > vsize< / code > , and < code > value< / code > .< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . mempoolRecent " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< / ngb-accordion >
< / div >
< div class = "api-category" >
< h4 i18n = "api-docs.tab.transactions|API Docs tab for Transactions" > Transactions< / h4 >
< ngb-accordion [ closeOthers ] = " true " animated = "true" type = "dark" >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "cpfp" >
< ng-template ngbPanelTitle >
< span > GET Children Pay for Parent< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionCpfp ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/v1/cpfp/:txid< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.fees.cpfp|API Docs for /api/v1/fees/cpfp" > Returns the ancestors and the best descendant fees for a transaction.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionCpfp " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel id = "transaction" >
< ng-template ngbPanelTitle >
< span > GET Transaction< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< a [ href ] = " wrapUrl ( network . val , code . transaction ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns details about a transaction. Available fields: < code > txid< / code > , < code > version< / code > , < code > locktime< / code > , < code > size< / code > , < code > weight< / code > , < code > fee< / code > , < code > vin< / code > , < code > vout< / code > , and < code > status< / code > .< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transaction " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "transactionHex" >
< ng-template ngbPanelTitle >
< span > GET Transaction Hex< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionHex ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/hex< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns a transaction serialized as hex.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionHex " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq' && network.val !== 'liquid'" id = "transactionMerkleBlockProof" >
< ng-template ngbPanelTitle >
< span > GET Transaction Merkleblock Proof< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionMerkleBlockProof ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/merkleblock-proof< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns a merkle inclusion proof for the transaction using < a href = "https://bitcoin.org/en/glossary/merkle-block" > bitcoind's merkleblock< / a > format.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionMerkleBlockProof " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "transactionMerkleProof" >
< ng-template ngbPanelTitle >
< span > GET Transaction Merkle Proof< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionMerkleProof ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/merkle-proof< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns a merkle inclusion proof for the transaction using < a href = "https://electrumx.readthedocs.io/en/latest/protocol-methods.html#blockchain-transaction-get-merkle" > Electrum's blockchain.transaction.get_merkle format.< / a > < / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionMerkleProof " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "transactionOutspend" >
< ng-template ngbPanelTitle >
< span > GET Transaction Outspend< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionOutspend ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/outspend/:vout< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the spending status of a transaction output. Available fields: < code > spent< / code > (boolean), < code > txid< / code > (optional), < code > vin< / code > (optional), and < code > status< / code > (optional, the status of the spending tx).< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionOutspend " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "transactionOutspends" >
< ng-template ngbPanelTitle >
< span > GET Transaction Outspends< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionOutspends ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/outspends< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the spending status of all transaction outputs.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionOutspends " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "transactionRaw" >
< ng-template ngbPanelTitle >
< span > GET Transaction Raw< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionRaw ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/raw< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns a transaction as binary data.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionRaw " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "transactionStatus" >
< ng-template ngbPanelTitle >
< span > GET Transaction Status< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionStatus ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/tx/:txid/status< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns the confirmation status of a transaction. Available fields: < code > confirmed< / code > (boolean), < code > block_height< / code > (optional), and < code > block_hash< / code > (optional).< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionStatus " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val === 'bisq'" id = "transactionsBisq" >
< ng-template ngbPanelTitle >
< span > GET Transactions< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "title" > Get Mempool Txids< / div >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< a [ href ] = " wrapUrl ( network . val , code . transactionsBisq ) " target = "_blank" > GET {{ baseNetworkUrl }}/api/txs/:index/:length< / a >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Returns :length of latest Bisq transactions, starting from :index.< / div >
< / div >
< app-code-template [ hostname ] = " hostname " [ code ] = " code . transactionsBisq " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< ngb-panel * ngIf = "network.val !== 'bisq'" id = "postTransaction" >
< ng-template ngbPanelTitle >
< span > POST Transaction< / span >
< / ng-template >
< ng-template ngbPanelContent >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
< div > POST /api/tx< / div >
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n > Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The < code > txid< / code > will be returned on success.< / div >
< / div >
< app-code-template [ method ] = " ' post ' " [ hostname ] = " hostname " [ code ] = " code . transactionPost " [ network ] = " network . val " > < / app-code-template >
< / ng-template >
< / ngb-panel >
< / ngb-accordion >
< / div >
2021-12-01 17:01:50 -05:00
< / div >
< / div >
< div id = "websocketAPI" * ngIf = "!restTabActivated && ( network.val !== 'bisq' )" >
< div class = "api-category" >
< div class = "websocket" >
< div class = "endpoint" >
< div class = "subtitle" i18n = "Api docs endpoint" > Endpoint< / div >
{{ wrapUrl(network.val, code.websocket, true) }}
< / div >
< div class = "description" >
< div class = "subtitle" i18n > Description< / div >
< div i18n = "api-docs.websocket.websocket" > Default push: < code > {{ '{' }} action: 'want', data: ['blocks', ...] {{ '}' }}< / code > to express what you want pushed. Available: < code > blocks< / code > , < code > mempool-blocks< / code > , < code > live-2h-chart< / code > , and < code > stats< / code > .< br > < br > Push transactions related to address: < code > {{ '{' }} 'track-address': '3PbJ...bF9B' {{ '}' }}< / code > to receive all new transactions containing that address as input or output. Returns an array of transactions. < code > address-transactions< / code > for new mempool transactions, and < code > block-transactions< / code > for new block confirmed transactions.< / div >
< / div >
< app-code-template [ method ] = " ' websocket ' " [ hostname ] = " hostname " [ code ] = " code . websocket " [ network ] = " network . val " > < / app-code-template >
< / div >
< / div >
< / div >
< / div >
< / ng-container >
