[//]: # (Generated by genapidoc.py on 2026-01-13 14:56:51.459028. Do not edit manually.) FORMAT: 1A HOST: https://api.counterparty.io:4000 # Counterparty Core API The Counterparty Core API is the recommended way to query the state of a Counterparty node. All other methods have no official support. API routes are divided into groups: - [`blocks`](#/reference/blocks) - [`transactions`](#/reference/transactions) - [`addresses`](#/reference/addresses) - [`utxos`](#/reference/utxos) - [`compose`](#/reference/compose) - [`assets`](#/reference/assets) - [`orders`](#/reference/orders) - [`order_matches`](#/reference/order_matches) - [`bets`](#/reference/bets) - [`burns`](#/reference/burns) - [`dispensers`](#/reference/dispensers) - [`dividends`](#/reference/dividends) - [`events`](#/reference/events) - [`destructions`](#/reference/destructions) - [`dispenses`](#/reference/dispenses) - [`sends`](#/reference/sends) - [`issuances`](#/reference/issuances) - [`sweeps`](#/reference/sweeps) - [`broadcasts`](#/reference/broadcasts) - [`fairminters`](#/reference/fairminters) - [`fairmints`](#/reference/fairmints) - [`bitcoin`](#/reference/bitcoin) - [`mempool`](#/reference/mempool) - [`routes`](#/reference/routes) - [`Z-Pages`](#/reference/Z-Pages) - [`v1`](#/reference/v1) ## Headers and HTTP Code When the server is not ready, that is to say when all the extant blocks have not yet been parsed, every route will return a `503` error, except `/` and those routes that are in the `/blocks`, `/transactions` and `/backend` groups. All API responses contain the following 3 headers: * `X-COUNTERPARTY-HEIGHT` contains the last block parsed by Counterparty * `X-BITCOIN-HEIGHT` contains the last block known to Bitcoin Core * `X-COUNTERPARTY-READY` contains true if `X-COUNTERPARTY-HEIGHT` >= `X-BITCOIN-HEIGHT` - 1 * `X-LEDGER-STATE` contains `Starting`, `Catching Up`, `Following` or `Stopping` ## Responses Format All API responses follow the following format: ``` { "error": , "result": , "next_cursor": , "result_count": } ``` ## Pagination For all routes that return a list of results from the database, you can choose between two pagination modes: - With the `cursor` and `limit` parameters - With the `offset` and `limit` parameters The `cursor` parameter allows you to get results from a certain index. This index is generally retrieved from the `next_cursor` field of the previous result (see above). The `offset` parameter allows you to ignore a certain number of results before returning the rest. For example: `/v2/blocks?limit=5&cursor=844575` allows you to recover blocks 844575 to 844570. `/v2/blocks?limit=5&offset=5` allows you to retrieve the 5th to the tenth most recent blocks. All responses contain a `result_count` field allowing you to calculate the number of pages. ## Bitcoin Core Proxy Routes in the `/v2/bitcoin` group serve as a proxy to make requests to Bitcoin Core. ## Events API One of the new features of API v2 is the ability to make requests by events. This is the most powerful way to recover the vast majority of data. For example to retrieve events concerning dispensers for a given block: ``` /v2/blocks//events/OPEN_DISPENSER /v2/blocks//events/DISPENSER_UPDATE /v2/blocks//events/REFILL_DISPENSER /v2/blocks//events/DISPENSE ``` Or to know the events triggered by a given transaction: `/v2/transactions//events` You can also obtain the events triggered by a transaction using the `verbose` flag: `/v2/transactions?verbose=true` However, please note that in this way, the following events are excluded from the list of events: `NEW_TRANSACTION`, `TRANSACTION_PARSED`, `CREDIT`, `DEBIT`, `INCREMENT_TRANSACTION_COUNT`, `NEW_TRANSACTION_OUTPUT`. ### ZeroMQ Publisher You can enable the ZeroMQ server by starting `counterparty-server` with the `--enable-zmq-publisher` flag. All events are published, each in a specific topic. You can subscribe to the events that interest you. For example in Python: ``` context = zmq.asyncio.Context() socket = context.socket(zmq.SUB) socket.setsockopt(zmq.RCVHWM, 0) socket.setsockopt_string(zmq.SUBSCRIBE, "CREDIT") socket.setsockopt_string(zmq.SUBSCRIBE, "DEBIT") ``` You can use an empty string to subscribe to all events. By default events are published on port `4001`, you can customize this port with the flag `--zmq-publisher-port`. You can see a complete, working example in Python here: https://github.com/CounterpartyXCP/counterparty-core/blob/master/counterparty-core/tools/zmqclient.py. ### Notes about update events For the events `DISPENSER_UPDATE` and `ORDER_UPDATE`, depending on the reason for the update, the fields present in `params` may be different. Here are the different possibilities for `DISPENSER_UPDATE`: On refill dispenser and on dispense: - give_remaining - dispense_count - source - asset - status On closing dispenser with delay: - last_status_tx_hash - source - asset - status On closing dispenser: - give_remaining - source - asset - status and those for `ORDER_UPDATE`: On order cancellation: - status - tx_hash On order match cancellation: - give_remaining - get_remaining - status - fee_required_remaining On order match: - give_remaining - get_remaining - fee_required_remaining - fee_provided_remaining - status ## Events Reference Here is a list of events classified by theme and for each an example response: ### Blocks and Transactions #### `NEW_BLOCK` ``` { "result": [ { "event_index": 1029, "event": "NEW_BLOCK", "params": { "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_index": 245, "block_time": 1768316195, "difficulty": 545259519, "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000003" }, "tx_hash": null, "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1027, "result_count": 145 } ``` #### `NEW_TRANSACTION` ``` { "result": [ { "event_index": 1030, "event": "NEW_TRANSACTION", "params": { "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_index": 245, "block_time": 1768316195, "btc_amount": 1000, "data": "0d00", "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "fee": 0, "source": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "transaction_type": "dispense", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000074:1 00000000000000000000000000000000000000000000000000000000000000d4:0 3 1", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1020, "result_count": 122 } ``` #### `NEW_TRANSACTION_OUTPUT` ``` { "result": [ { "event_index": 1031, "event": "NEW_TRANSACTION_OUTPUT", "params": { "block_index": 245, "btc_amount": 1000, "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "out_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 981, "result_count": 6 } ``` #### `BLOCK_PARSED` ``` { "result": [ { "event_index": 1042, "event": "BLOCK_PARSED", "params": { "block_index": 245, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000059", "messages_hash": "000000000000000000000000000000000000000000000000000000000000010a", "transaction_count": 1, "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000111", "block_time": 1768316195 }, "tx_hash": null, "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1028, "result_count": 145 } ``` #### `TRANSACTION_PARSED` ``` { "result": [ { "event_index": 1041, "event": "TRANSACTION_PARSED", "params": { "supported": true, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1025, "result_count": 122 } ``` ### Asset Movements #### `DEBIT` ``` { "result": [ { "event_index": 1035, "event": "DEBIT", "params": { "action": "utxo move", "address": null, "asset": "XCP", "block_index": 245, "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "0000000000000000000000000000000000000000000000000000000000000074:1", "utxo_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1032, "result_count": 106 } ``` #### `CREDIT` ``` { "result": [ { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1036, "result_count": 126 } ``` #### `ENHANCED_SEND` ``` { "result": [ { "event_index": 653, "event": "ENHANCED_SEND", "params": { "asset": "MPMASSET", "block_index": 201, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": null, "msg_index": 0, "quantity": 1000, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "tx_index": 77, "block_time": 1768316002, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "block_index": 201, "block_time": 1768316002 } ], "next_cursor": 528, "result_count": 3 } ``` #### `MPMA_SEND` ``` { "result": [ { "event_index": 713, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 205, "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "memo": "memo1", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 } ], "next_cursor": 712, "result_count": 15 } ``` #### `SEND` ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` #### `ASSET_TRANSFER` ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` #### `SWEEP` ``` { "result": [ { "event_index": 571, "event": "SWEEP", "params": { "block_index": 190, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "fee_paid": 600000, "flags": 1, "memo": "sweep my assets", "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "tx_index": 65, "block_time": 1768315955, "fee_paid_normalized": "0.00600000" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "block_index": 190, "block_time": 1768315955 } ], "next_cursor": null, "result_count": 1 } ``` #### `ASSET_DIVIDEND` ``` { "result": [ { "event_index": 338, "event": "ASSET_DIVIDEND", "params": { "asset": "MYASSETA", "block_index": 146, "dividend_asset": "XCP", "fee_paid": 20000, "quantity_per_unit": 100000000, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000004d", "tx_index": 42, "block_time": 1768315794, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "dividend_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_per_unit_normalized": "1.00000000", "fee_paid_normalized": "0.00020000" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000004d", "block_index": 146, "block_time": 1768315794 } ], "next_cursor": null, "result_count": 1 } ``` ### Asset Creation and Destruction #### `RESET_ISSUANCE` ``` { "result": [ { "event_index": 1001, "event": "RESET_ISSUANCE", "params": { "asset": "RESET", "asset_events": "reset", "asset_longname": null, "block_index": 240, "call_date": 0, "call_price": 0.0, "callable": false, "description": "", "divisible": true, "fee_paid": 0, "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "locked": false, "mime_type": "text/plain", "quantity": 1200000000, "reset": true, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "transfer": false, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "tx_index": 117, "block_time": 1768316173, "quantity_normalized": "12.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "block_index": 240, "block_time": 1768316173 } ], "next_cursor": null, "result_count": 1 } ``` #### `ASSET_CREATION` ``` { "result": [ { "event_index": 1022, "event": "ASSET_CREATION", "params": { "asset_id": "117132633401", "asset_longname": null, "asset_name": "OPENFAIR", "block_index": 243, "block_time": 1768316185 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 } ], "next_cursor": 992, "result_count": 30 } ``` #### `ASSET_ISSUANCE` ``` { "result": [ { "event_index": 1023, "event": "ASSET_ISSUANCE", "params": { "asset": "OPENFAIR", "asset_events": "open_fairminter", "asset_longname": null, "block_index": 243, "call_date": 0, "call_price": 0, "callable": false, "description": "", "divisible": true, "fair_minting": true, "fee_paid": 50000000.0, "issuer": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "locked": false, "mime_type": "text/plain", "quantity": 0, "reset": false, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "valid", "transfer": false, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_time": 1768316185, "quantity_normalized": "0.00000000", "fee_paid_normalized": "0.50000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 } ], "next_cursor": 993, "result_count": 55 } ``` #### `ASSET_DESTRUCTION` ``` { "result": [ { "event_index": 1000, "event": "ASSET_DESTRUCTION", "params": { "asset": "RESET", "block_index": 240, "quantity": 12, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tag": "reset", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "tx_index": 117, "block_time": 1768316173, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "0.00000012" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "block_index": 240, "block_time": 1768316173 } ], "next_cursor": 885, "result_count": 5 } ``` ### DEX #### `OPEN_ORDER` ``` { "result": [ { "event_index": 1013, "event": "OPEN_ORDER", "params": { "block_index": 242, "expiration": 21, "expire_index": 263, "fee_provided": 10000, "fee_provided_remaining": 10000, "fee_required": 0, "fee_required_remaining": 0, "get_asset": "UTXOASSET", "get_quantity": 1000, "get_remaining": 1000, "give_asset": "BTC", "give_quantity": 1000, "give_remaining": 1000, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "open", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "tx_index": 119, "block_time": 1768316181, "give_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "get_asset_info": { "asset_longname": null, "description": "My super asset", "issuer": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "divisible": true, "locked": false, "owner": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu" }, "give_quantity_normalized": "0.00001000", "get_quantity_normalized": "0.00001000", "get_remaining_normalized": "0.00001000", "give_remaining_normalized": "0.00001000", "fee_provided_normalized": "0.00010000", "fee_required_normalized": "0.00000000", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 } ], "next_cursor": 1008, "result_count": 9 } ``` #### `ORDER_MATCH` ``` { "result": [ { "event_index": 1016, "event": "ORDER_MATCH", "params": { "backward_asset": "BTC", "backward_quantity": 1000, "block_index": 242, "fee_paid": 0, "forward_asset": "UTXOASSET", "forward_quantity": 1000, "id": "00000000000000000000000000000000000000000000000000000000000000d3_0000000000000000000000000000000000000000000000000000000000000113", "match_expire_index": 262, "status": "pending", "tx0_address": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "tx0_block_index": 241, "tx0_expiration": 21, "tx0_hash": "00000000000000000000000000000000000000000000000000000000000000d3", "tx0_index": 118, "tx1_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx1_block_index": 242, "tx1_expiration": 21, "tx1_hash": "0000000000000000000000000000000000000000000000000000000000000113", "tx1_index": 119, "block_time": 1768316181, "forward_asset_info": { "asset_longname": null, "description": "My super asset", "issuer": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "divisible": true, "locked": false, "owner": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu" }, "backward_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "forward_quantity_normalized": "0.00001000", "backward_quantity_normalized": "0.00001000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 } ], "next_cursor": 691, "result_count": 5 } ``` #### `ORDER_UPDATE` ``` { "result": [ { "event_index": 1015, "event": "ORDER_UPDATE", "params": { "fee_provided_remaining": 10000, "fee_required_remaining": 0, "get_remaining": 0, "give_remaining": 0, "status": "open", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 } ], "next_cursor": 1014, "result_count": 19 } ``` #### `ORDER_FILLED` ``` { "result": [ { "event_index": 507, "event": "ORDER_FILLED", "params": { "status": "filled", "tx_hash": "000000000000000000000000000000000000000000000000000000000000010b" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "block_index": 182, "block_time": 1768315921 } ], "next_cursor": null, "result_count": 1 } ``` #### `ORDER_MATCH_UPDATE` ``` { "result": [ { "event_index": 859, "event": "ORDER_MATCH_UPDATE", "params": { "id": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "order_match_id": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "status": "expired" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000042", "block_index": 225, "block_time": 1768316099 } ], "next_cursor": 685, "result_count": 4 } ``` #### `BTC_PAY` ``` { "result": [ { "event_index": 508, "event": "BTC_PAY", "params": { "block_index": 182, "btc_amount": 2000, "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "order_match_id": "0000000000000000000000000000000000000000000000000000000000000088_000000000000000000000000000000000000000000000000000000000000010b", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "tx_index": 57, "block_time": 1768315921, "btc_amount_normalized": "0.00002000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "block_index": 182, "block_time": 1768315921 } ], "next_cursor": null, "result_count": 1 } ``` #### `CANCEL_ORDER` ``` { "result": [ { "event_index": 553, "event": "CANCEL_ORDER", "params": { "block_index": 188, "offer_hash": "0000000000000000000000000000000000000000000000000000000000000046", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "tx_index": 63, "block_time": 1768315947 }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "block_index": 188, "block_time": 1768315947 } ], "next_cursor": null, "result_count": 1 } ``` #### `ORDER_EXPIRATION` ``` { "result": [ { "event_index": 758, "event": "ORDER_EXPIRATION", "params": { "block_index": 211, "order_hash": "00000000000000000000000000000000000000000000000000000000000000c2", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "block_time": 1768316043 }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000107", "block_index": 211, "block_time": 1768316043 } ], "next_cursor": 705, "result_count": 5 } ``` #### `ORDER_MATCH_EXPIRATION` ``` { "result": [ { "event_index": 861, "event": "ORDER_MATCH_EXPIRATION", "params": { "block_index": 225, "order_match_id": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "tx0_address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "tx1_address": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "block_time": 1768316099 }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000042", "block_index": 225, "block_time": 1768316099 } ], "next_cursor": 688, "result_count": 3 } ``` ### Dispenser #### `OPEN_DISPENSER` ``` { "result": [ { "event_index": 976, "event": "OPEN_DISPENSER", "params": { "asset": "XCP", "block_index": 236, "dispense_count": 0, "escrow_quantity": 5000, "give_quantity": 1, "give_remaining": 5000, "oracle_address": null, "origin": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "satoshirate": 1, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "tx_index": 114, "block_time": 1768316157, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00005000", "escrow_quantity_normalized": "0.00005000", "satoshirate_normalized": "0.00000001" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "block_index": 236, "block_time": 1768316157 } ], "next_cursor": 587, "result_count": 6 } ``` #### `DISPENSER_UPDATE` ``` { "result": [ { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 983, "result_count": 9 } ``` #### `REFILL_DISPENSER` ``` { "result": [ { "event_index": 253, "event": "REFILL_DISPENSER", "params": { "asset": "XCP", "block_index": 135, "destination": "13xJgUbAtbXHyHgzEbpJe386E35d1xDpC8", "dispense_quantity": 10, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000ff", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000039", "tx_index": 31, "block_time": 1768315751, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000039", "block_index": 135, "block_time": 1768315751 } ], "next_cursor": null, "result_count": 1 } ``` #### `DISPENSE` ``` { "result": [ { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 984, "result_count": 6 } ``` ### Broadcast #### `BROADCAST` ``` { "result": [ { "event_index": 210, "event": "BROADCAST", "params": { "block_index": 129, "fee_fraction_int": 0, "locked": false, "mime_type": "text/plain", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "valid", "text": "price-USD", "timestamp": 4003903983, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000093", "tx_index": 25, "value": 66600.0, "block_time": 1768315728, "fee_fraction_int_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000093", "block_index": 129, "block_time": 1768315728 } ], "next_cursor": 205, "result_count": 2 } ``` ### Fair Minting #### `NEW_FAIRMINTER` ``` { "result": [ { "event_index": 1021, "event": "NEW_FAIRMINTER", "params": { "asset": "OPENFAIR", "asset_longname": null, "asset_parent": null, "block_index": 243, "burn_payment": false, "description": "", "divisible": true, "end_block": 0, "hard_cap": 0, "lock_description": false, "lock_quantity": false, "max_mint_per_address": 0, "max_mint_per_tx": 10, "mime_type": "text/plain", "minted_asset_commission_int": 0, "pre_minted": false, "premint_quantity": 0, "price": 0, "quantity_by_price": 1, "soft_cap": 0, "soft_cap_deadline_block": 0, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "start_block": 0, "status": "open", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_time": 1768316185, "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000010", "premint_quantity_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 } ], "next_cursor": 874, "result_count": 18 } ``` #### `FAIRMINTER_UPDATE` ``` { "result": [ { "event_index": 883, "event": "FAIRMINTER_UPDATE", "params": { "status": "closed", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d7" }, "tx_hash": null, "block_index": 228, "block_time": 1768316112 } ], "next_cursor": 869, "result_count": 8 } ``` #### `NEW_FAIRMINT` ``` { "result": [ { "event_index": 835, "event": "NEW_FAIRMINT", "params": { "asset": "BURNER", "block_index": 221, "commission": 20000000, "earn_quantity": 80000000, "fairminter_tx_hash": "000000000000000000000000000000000000000000000000000000000000003b", "paid_quantity": 100000000, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000110", "tx_index": 97, "block_time": 1768316085, "asset_info": { "asset_longname": null, "description": "let's burn it", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": true, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "earn_quantity_normalized": "0.80000000", "commission_normalized": "0.20000000", "paid_quantity_normalized": "1.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000110", "block_index": 221, "block_time": 1768316085 } ], "next_cursor": 816, "result_count": 15 } ``` ### UTXO Support #### `ATTACH_TO_UTXO` ``` { "result": [ { "event_index": 965, "event": "ATTACH_TO_UTXO", "params": { "asset": "DETACHA", "block_index": 235, "destination": "0000000000000000000000000000000000000000000000000000000000000065:0", "destination_address": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "fee_paid": 0, "msg_index": 0, "quantity": 100000000, "send_type": "attach", "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000065", "tx_index": 112, "block_time": 1768316150, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "1.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000065", "block_index": 235, "block_time": 1768316150 } ], "next_cursor": 944, "result_count": 9 } ``` #### `DETACH_FROM_UTXO` ``` { "result": [ { "event_index": 957, "event": "DETACH_FROM_UTXO", "params": { "asset": "DETACHB", "block_index": 234, "destination": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "fee_paid": 0, "msg_index": 1, "quantity": 100000000, "send_type": "detach", "source": "0000000000000000000000000000000000000000000000000000000000000092:0", "source_address": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "tx_index": 111, "block_time": 1768316146, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "1.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "block_index": 234, "block_time": 1768316146 } ], "next_cursor": 954, "result_count": 5 } ``` #### `UTXO_MOVE` ``` { "result": [ { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1034, "result_count": 14 } ``` ### Burns #### `BURN` ``` { "result": [ { "event_index": 61, "event": "BURN", "params": { "block_index": 112, "burned": 50000000, "earned": 74999998167, "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a8", "tx_index": 9, "block_time": 1768315659, "burned_normalized": "0.50000000", "earned_normalized": "749.99998167" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a8", "block_index": 112, "block_time": 1768315659 } ], "next_cursor": 58, "result_count": 10 } ``` # Counterparty API Root [/v2/] ### Get Server Info [GET /v2/] Returns server information and the list of documented routes in JSON format. + Response 200 (application/json) ``` { "result": { "server_ready": true, "network": "mainnet", "version": "11.0.4", "backend_height": 850214, "counterparty_height": 850214, "ledger_state": "following", "documentation": "https://counterpartycore.docs.apiary.io/", "blueprint": "http://localhost:4000/v2/blueprint" } } ``` ## Mempool API The `/v2/mempool/events` route allows to retrieve events generated by transactions that have not yet been confirmed. Unconfirmed transactions are considered unordered and each one is parsed independently of the others. Therefore some transactions can be invalid once parsed in the mempool and valid once confirmed, or valid in the mempool and invalid once confirmed. For example, if a utxo move is chained after an attach, it will be invalid in the mempool but valid once confirmed. ## Group Blocks ### Get Blocks [GET /v2/blocks{?cursor,limit,offset,verbose}] Returns the list of the last ten blocks + Parameters + cursor: `245` (int, optional) - The index of the most recent block to return + Default: `null` + limit: `5` (int, optional) - The number of blocks to return + Default: `10` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000059", "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000111", "messages_hash": "000000000000000000000000000000000000000000000000000000000000010a", "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000003", "difficulty": 545259519, "transaction_count": 1 }, { "block_index": 244, "block_hash": "0000000000000000000000000000000000000000000000000000000000000003", "block_time": 1768316189, "ledger_hash": "000000000000000000000000000000000000000000000000000000000000003f", "txlist_hash": "000000000000000000000000000000000000000000000000000000000000006f", "messages_hash": "000000000000000000000000000000000000000000000000000000000000011a", "previous_block_hash": "00000000000000000000000000000000000000000000000000000000000000bd", "difficulty": 545259519, "transaction_count": 0 }, { "block_index": 243, "block_hash": "00000000000000000000000000000000000000000000000000000000000000bd", "block_time": 1768316185, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000105", "txlist_hash": "00000000000000000000000000000000000000000000000000000000000000c3", "messages_hash": "00000000000000000000000000000000000000000000000000000000000000ca", "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000035", "difficulty": 545259519, "transaction_count": 1 }, { "block_index": 242, "block_hash": "0000000000000000000000000000000000000000000000000000000000000035", "block_time": 1768316181, "ledger_hash": "00000000000000000000000000000000000000000000000000000000000000b4", "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000049", "messages_hash": "00000000000000000000000000000000000000000000000000000000000000fe", "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000072", "difficulty": 545259519, "transaction_count": 1 }, { "block_index": 241, "block_hash": "0000000000000000000000000000000000000000000000000000000000000072", "block_time": 1768316177, "ledger_hash": "00000000000000000000000000000000000000000000000000000000000000c0", "txlist_hash": "00000000000000000000000000000000000000000000000000000000000000c7", "messages_hash": "0000000000000000000000000000000000000000000000000000000000000119", "previous_block_hash": "00000000000000000000000000000000000000000000000000000000000000b0", "difficulty": 545259519, "transaction_count": 1 } ], "next_cursor": 240, "result_count": 145 } ``` ### Get Last Block [GET /v2/blocks/last{?verbose}] Return the information of the last block + Parameters + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000059", "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000111", "messages_hash": "000000000000000000000000000000000000000000000000000000000000010a", "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000003", "difficulty": 545259519, "transaction_count": 1 } } ``` ### Get Block By Height [GET /v2/blocks/{block_index}{?verbose}] Return the information of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000059", "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000111", "messages_hash": "000000000000000000000000000000000000000000000000000000000000010a", "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000003", "difficulty": 545259519, "transaction_count": 1 } } ``` ### Get Block By Hash [GET /v2/blocks/{block_hash}{?verbose}] Return the information of a block + Parameters + block_hash: `000000000000000000000000000000000000000000000000000000000000004f` (str, required) - The index of the block to return + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000059", "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000111", "messages_hash": "000000000000000000000000000000000000000000000000000000000000010a", "previous_block_hash": "0000000000000000000000000000000000000000000000000000000000000003", "difficulty": 545259519, "transaction_count": 1 } } ``` ### Get Transactions By Block [GET /v2/blocks/{block_index}/transactions{?type,show_unconfirmed,valid,cursor,limit,offset,verbose}] Returns the transactions of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + type (enum[str], optional) - The type of the transaction to return + Default: `all` + Members + `all` + `bet` + `broadcast` + `btcpay` + `cancel` + `destroy` + `dispenser` + `dispense` + `dividend` + `issuance` + `order` + `send` + `enhanced_send` + `mpma` + `rps` + `rpsresolve` + `sweep` + `fairminter` + `fairmint` + `attach` + `detach` + `utxomove` + `unknown` + show_unconfirmed (bool, optional) - Show unconfirmed transactions + Default: `null` + valid (bool, optional) - If True, only return valid transactions + Default: `null` + cursor: `121` (int, optional) - The last transaction index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of transactions to return + Default: `10` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "source": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "btc_amount": 1000, "fee": 0, "data": "0d00", "supported": true, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000074:1 00000000000000000000000000000000000000000000000000000000000000d4:0 3 1", "transaction_type": "dispense", "valid": 1, "events": [ { "event_index": 1034, "event": "UTXO_MOVE", "params": { "asset": "MYASSETA", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 0, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "unpacked_data": { "message_type": "dispense", "message_type_id": 13, "message_data": { "data": "00" } }, "btc_amount_normalized": "0.00001000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Transaction Types Count By Block [GET /v2/blocks/{block_index}/transactions/counts{?count_unconfirmed,verbose}] Returns the count of each transaction type + Parameters + block_index: `121` (int, required) - The index of the block to return + count_unconfirmed (bool, optional) - Count unconfirmed transactions + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` ### Get Events By Block [GET /v2/blocks/{block_index}/events{?event_name,cursor,limit,offset,verbose}] Returns the events of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + event_name (str, optional) - Comma separated list of events to return + Default: `null` + cursor: `1042` (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 1042, "event": "BLOCK_PARSED", "params": { "block_index": 245, "ledger_hash": "0000000000000000000000000000000000000000000000000000000000000059", "messages_hash": "000000000000000000000000000000000000000000000000000000000000010a", "transaction_count": 1, "txlist_hash": "0000000000000000000000000000000000000000000000000000000000000111", "block_time": 1768316195 }, "tx_hash": null }, { "event_index": 1041, "event": "TRANSACTION_PARSED", "params": { "supported": true, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" }, { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" } ], "next_cursor": 1037, "result_count": 14 } ``` ### Get Event Counts By Block [GET /v2/blocks/{block_index}/events/counts{?cursor,limit,offset,verbose}] Returns the event counts of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + cursor (str, optional) - The last event name to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event": "UTXO_MOVE", "event_count": 2 }, { "event": "TRANSACTION_PARSED", "event_count": 1 }, { "event": "NEW_TRANSACTION_OUTPUT", "event_count": 1 }, { "event": "NEW_TRANSACTION", "event_count": 1 }, { "event": "NEW_BLOCK", "event_count": 1 } ], "next_cursor": "DISPENSER_UPDATE", "result_count": 10 } ``` ### Get Events By Block And Event [GET /v2/blocks/{block_index}/events/{event}{?cursor,limit,offset,verbose}] Returns the events of a block filtered by event + Parameters + block_index: `245` (int, required) - The index of the block to return + event: `CREDIT` (str, required) - The event to filter by + cursor (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" }, { "event_index": 1036, "event": "CREDIT", "params": { "address": null, "asset": "XCP", "block_index": 245, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" }, { "event_index": 1033, "event": "CREDIT", "params": { "address": null, "asset": "MYASSETA", "block_index": 245, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4" } ], "next_cursor": null, "result_count": 3 } ``` ### Get Credits By Block [GET /v2/blocks/{block_index}/credits{?action,cursor,limit,offset,verbose}] Returns the credits of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + action (enum[str], optional) - The action to filter by + Default: `null` + Members + `None` + `Closed: Max dispenses reached` + `bet settled: for equal` + `bet settled: for notequal` + `bet settled: liquidated for bear` + `btcpay` + `burn` + `cancel order` + `close dispenser` + `dispense` + `dispenser close` + `dividend` + `feed fee` + `filled` + `issuance` + `mpma send` + `open dispenser empty addr` + `order cancelled` + `order expired` + `order match` + `recredit backward quantity` + `recredit forward quantity` + `recredit wager` + `recredit wager remaining` + `reset issuance` + `send` + `sweep` + `wins` + cursor (int, optional) - The last credit index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of credits to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "block_index": 245, "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "quantity": 66, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, { "block_index": 245, "address": null, "asset": "XCP", "quantity": 2000000000, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, { "block_index": 245, "address": null, "asset": "MYASSETA", "quantity": 2000000000, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" } ], "next_cursor": null, "result_count": 3 } ``` ### Get Debits By Block [GET /v2/blocks/{block_index}/debits{?action,cursor,limit,offset,verbose}] Returns the debits of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + action (enum[str], optional) - The action to filter by + Default: `null` + Members + `None` + `bet` + `destroy` + `dividend` + `dividend fee` + `issuance fee` + `mpma send` + `open RPS` + `open dispenser` + `open dispenser empty addr` + `open order` + `refill dispenser` + `reopen RPS after matching expiration` + `reset destroy` + `send` + `sweep` + `sweep fee` + cursor (int, optional) - The last index of the debits to return + Default: `null` + limit: `5` (int, optional) - The maximum number of debits to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "block_index": 245, "address": null, "asset": "XCP", "quantity": 2000000000, "action": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "utxo": "0000000000000000000000000000000000000000000000000000000000000074:1", "utxo_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, { "block_index": 245, "address": null, "asset": "MYASSETA", "quantity": 2000000000, "action": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "utxo": "0000000000000000000000000000000000000000000000000000000000000074:1", "utxo_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" } ], "next_cursor": null, "result_count": 2 } ``` ### Get Expirations [GET /v2/blocks/{block_index}/expirations{?cursor,limit,offset,verbose}] Returns the expirations of a block + Parameters + block_index: `211` (int, required) - The index of the block to return + cursor (int, optional) - The last index of the expirations to return + Default: `null` + limit: `5` (int, optional) - The maximum number of expirations to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "type": "order", "object_id": "00000000000000000000000000000000000000000000000000000000000000c2", "block_index": 211, "block_time": 1768316043 } ], "next_cursor": null, "result_count": 1 } ``` ### Get Cancels [GET /v2/blocks/{block_index}/cancels{?cursor,limit,offset,verbose}] Returns the cancels of a block + Parameters + block_index: `188` (int, required) - The index of the block to return + cursor (int, optional) - The last index of the cancels to return + Default: `null` + limit: `5` (int, optional) - The maximum number of cancels to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 63, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "block_index": 188, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "offer_hash": "0000000000000000000000000000000000000000000000000000000000000046", "status": "valid", "block_time": 1768315947 } ], "next_cursor": null, "result_count": 1 } ``` ### Get Valid Destructions By Block [GET /v2/blocks/{block_index}/destructions{?cursor,limit,offset,verbose}] Returns the destructions of a block + Parameters + block_index: `240` (int, required) - The index of the block to return + cursor (int, optional) - The last index of the destructions to return + Default: `null` + limit: `5` (int, optional) - The maximum number of destructions to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 117, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "block_index": 240, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "asset": "RESET", "quantity": 12, "tag": "reset", "status": "valid", "block_time": 1768316173, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "0.00000012" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Issuances By Block [GET /v2/blocks/{block_index}/issuances{?asset_events,cursor,limit,offset,verbose}] Returns the issuances of a block + Parameters + block_index: `243` (int, required) - The index of the block to return + asset_events (enum[str], optional) - Filter result by one or several comma separated asset events + Default: `all` + Members + `all` + `creation` + `reissuance` + `lock_quantity` + `reset` + `change_description` + `transfer` + `open_fairminter` + `fairmint` + `lock_description` + cursor (int, optional) - The last index of the issuances to return + Default: `null` + limit: `5` (int, optional) - The maximum number of issuances to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 120, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "msg_index": 0, "block_index": 243, "asset": "OPENFAIR", "quantity": 0, "divisible": true, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "issuer": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "transfer": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "", "fee_paid": 50000000, "status": "valid", "asset_longname": null, "description_locked": false, "fair_minting": true, "asset_events": "open_fairminter", "locked": false, "reset": false, "mime_type": "text/plain", "block_time": 1768316185, "quantity_normalized": "0.00000000", "fee_paid_normalized": "0.50000000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Sends By Block [GET /v2/blocks/{block_index}/sends{?send_type,cursor,limit,offset,verbose}] Returns the sends, include Enhanced and MPMA sends, of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + send_type (enum[str], optional) - The type of the send to return + Default: `all` + Members + `all` + `send` + `attach` + `move` + `detach` + cursor (int, optional) - The last index of the debits to return + Default: `null` + limit: `5` (int, optional) - The maximum number of debits to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "asset": "XCP", "quantity": 2000000000, "status": "valid", "msg_index": 1, "memo": null, "fee_paid": 0, "send_type": "move", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000", "fee_paid_normalized": "0.00000000" }, { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "asset": "MYASSETA", "quantity": 2000000000, "status": "valid", "msg_index": 0, "memo": null, "fee_paid": 0, "send_type": "move", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000", "fee_paid_normalized": "0.00000000" } ], "next_cursor": null, "result_count": 2 } ``` ### Get Dispenses By Block [GET /v2/blocks/{block_index}/dispenses{?cursor,limit,offset,verbose}] Returns the dispenses of a block + Parameters + block_index: `245` (int, required) - The index of the block to return + cursor (int, optional) - The last index of the dispenses to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispenses to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 121, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "btc_amount": 1000, "dispenser": { "tx_index": 33, "block_index": 245, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 0, "give_remaining": 9268, "oracle_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "last_status_tx_hash": null, "origin": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": 0.01, "oracle_price": 66600.0, "fiat_unit": "USD", "oracle_price_last_updated": 129, "satoshi_price": 16, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00009268", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000016" }, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Sweeps By Block [GET /v2/blocks/{block_index}/sweeps{?cursor,limit,offset,verbose}] Returns the sweeps of a block + Parameters + block_index: `190` (int, required) - The index of the block to return + cursor (int, optional) - The last index of the sweeps to return + Default: `null` + limit: `5` (int, optional) - The maximum number of sweeps to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 65, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "block_index": 190, "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "flags": 1, "status": "valid", "memo": "sweep my assets", "fee_paid": 600000, "block_time": 1768315955, "fee_paid_normalized": "0.00600000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Fairminters By Block [GET /v2/blocks/{block_index}/fairminters{?status,cursor,limit,offset,verbose}] Returns the fairminters by its block index + Parameters + block_index: `243` (int, required) - The block index of the fairminter to return + status (enum[str], optional) - The status of the fairminters to return + Default: `all` + Members + `all` + `open` + `closed` + `pending` + cursor (int, optional) - The last index of the fairminter to return + Default: `null` + limit: `5` (int, optional) - The maximum number of fairminter to return + Default: `100` + offset (int, optional) - The number of lines to skip before + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_index": 243, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "asset": "OPENFAIR", "asset_parent": null, "asset_longname": null, "description": "", "price": 0, "quantity_by_price": 1, "hard_cap": 0, "burn_payment": false, "max_mint_per_tx": 10, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "open", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": null, "paid_quantity": null, "commission": null, "block_time": 1768316185, "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000010", "premint_quantity_normalized": "0.00000000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Fairmints By Block [GET /v2/blocks/{block_index}/fairmints{?cursor,limit,offset,verbose}] Returns the fairmints by its block index + Parameters + block_index: `221` (int, required) - The block index of the fairmint to return + cursor (int, optional) - The last index of the fairmint to return + Default: `null` + limit: `5` (int, optional) - The maximum number of fairmint to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000110", "tx_index": 97, "block_index": 221, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "fairminter_tx_hash": "000000000000000000000000000000000000000000000000000000000000003b", "asset": "BURNER", "earn_quantity": 80000000, "paid_quantity": 100000000, "commission": 20000000, "status": "valid", "block_time": 1768316085, "asset_info": { "asset_longname": null, "description": "let's burn it", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": true, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "earn_quantity_normalized": "0.80000000", "commission_normalized": "0.20000000", "paid_quantity_normalized": "1.00000000" } ], "next_cursor": null, "result_count": 1 } ``` ## Group Transactions There are 14 types of transactions: - `broadcast` - `btcpay` - `cancel` - `destroy` - `dispenser` - `dispense` - `dividend` - `issuance` - `order` - `enhanced_send` - `mpma_send` - `sweep` - `attach` - `detach` Here is sample API output for each of these transactions: **Broadcast** ``` { "result": { "tx_index": 25, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000093", "block_index": 129, "block_hash": "00000000000000000000000000000000000000000000000000000000000000a0", "block_time": 1768315728, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "destination": null, "btc_amount": 0, "fee": 10000, "data": "1e851aeea6b9effb40f042800000000000604970726963652d555344", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000093:1 2 0", "transaction_type": "broadcast", "confirmed": true, "valid": 1, "events": [ { "event_index": 210, "event": "BROADCAST", "params": { "block_index": 129, "fee_fraction_int": 0, "locked": false, "mime_type": "text/plain", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "valid", "text": "price-USD", "timestamp": 4003903983, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000093", "tx_index": 25, "value": 66600.0, "block_time": 1768315728, "fee_fraction_int_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000093", "block_index": 129, "block_time": 1768315728 } ], "unpacked_data": { "message_type": "broadcast", "message_type_id": 30, "message_data": { "timestamp": 4003903983, "value": 66600.0, "fee_fraction_int": 0, "text": "price-USD", "mime_type": "text/plain", "status": "valid", "fee_fraction_int_normalized": "0.00000000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Btcpay** ``` { "result": { "tx_index": 57, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "block_index": 182, "block_hash": "00000000000000000000000000000000000000000000000000000000000000a7", "block_time": 1768315921, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "btc_amount": 2000, "fee": 10000, "data": "0b0000000000000000000000000000000000000000000000000000000000000088000000000000000000000000000000000000000000000000000000000000010b", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000fd:0 3 1", "transaction_type": "btcpay", "confirmed": true, "valid": 1, "events": [ { "event_index": 506, "event": "ORDER_MATCH_UPDATE", "params": { "id": "0000000000000000000000000000000000000000000000000000000000000088_000000000000000000000000000000000000000000000000000000000000010b", "order_match_id": "0000000000000000000000000000000000000000000000000000000000000088_000000000000000000000000000000000000000000000000000000000000010b", "status": "completed" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "block_index": 182, "block_time": 1768315921 }, { "event_index": 507, "event": "ORDER_FILLED", "params": { "status": "filled", "tx_hash": "000000000000000000000000000000000000000000000000000000000000010b" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "block_index": 182, "block_time": 1768315921 }, { "event_index": 508, "event": "BTC_PAY", "params": { "block_index": 182, "btc_amount": 2000, "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "order_match_id": "0000000000000000000000000000000000000000000000000000000000000088_000000000000000000000000000000000000000000000000000000000000010b", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "tx_index": 57, "block_time": 1768315921, "btc_amount_normalized": "0.00002000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fd", "block_index": 182, "block_time": 1768315921 } ], "unpacked_data": { "message_type": "btcpay", "message_type_id": 11, "message_data": { "tx0_hash": "0000000000000000000000000000000000000000000000000000000000000088", "tx1_hash": "000000000000000000000000000000000000000000000000000000000000010b", "order_match_id": "0000000000000000000000000000000000000000000000000000000000000088_000000000000000000000000000000000000000000000000000000000000010b", "status": "valid" } }, "btc_amount_normalized": "0.00002000" } } ``` **Cancel** ``` { "result": { "tx_index": 63, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "block_index": 188, "block_hash": "0000000000000000000000000000000000000000000000000000000000000056", "block_time": 1768315947, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000008547", "supported": true, "utxos_info": " 000000000000000000000000000000000000000000000000000000000000010d:1 2 0", "transaction_type": "cancel", "confirmed": true, "valid": 1, "events": [ { "event_index": 551, "event": "ORDER_UPDATE", "params": { "status": "cancelled", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000046" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "block_index": 188, "block_time": 1768315947 }, { "event_index": 553, "event": "CANCEL_ORDER", "params": { "block_index": 188, "offer_hash": "0000000000000000000000000000000000000000000000000000000000000046", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "tx_index": 63, "block_time": 1768315947 }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010d", "block_index": 188, "block_time": 1768315947 } ], "unpacked_data": { "message_type": "cancel", "message_type_id": 70, "message_data": { "offer_hash": "0000000000000000000000000000000000000000000000000000000000000046", "status": "valid" } }, "btc_amount_normalized": "0.00000000" } } ``` **Destroy** ``` { "result": { "tx_index": 117, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "block_index": 240, "block_hash": "00000000000000000000000000000000000000000000000000000000000000b0", "block_time": 1768316173, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "destination": null, "btc_amount": 0, "fee": 0, "data": "16871a0077ccb31a47868c00f5f4f560f6", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000d0:1 2 0", "transaction_type": "issuance", "confirmed": true, "valid": 1, "events": [ { "event_index": 1000, "event": "ASSET_DESTRUCTION", "params": { "asset": "RESET", "block_index": 240, "quantity": 12, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tag": "reset", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "tx_index": 117, "block_time": 1768316173, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "0.00000012" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "block_index": 240, "block_time": 1768316173 }, { "event_index": 1001, "event": "RESET_ISSUANCE", "params": { "asset": "RESET", "asset_events": "reset", "asset_longname": null, "block_index": 240, "call_date": 0, "call_price": 0.0, "callable": false, "description": "", "divisible": true, "fee_paid": 0, "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "locked": false, "mime_type": "text/plain", "quantity": 1200000000, "reset": true, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "transfer": false, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "tx_index": 117, "block_time": 1768316173, "quantity_normalized": "12.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d0", "block_index": 240, "block_time": 1768316173 } ], "unpacked_data": { "message_type": "issuance", "message_type_id": 22, "message_data": { "asset_id": 7851187, "asset": "RESET", "subasset_longname": null, "quantity": 1200000000, "divisible": true, "lock": false, "reset": true, "callable": false, "call_date": 0, "call_price": 0.0, "description": "", "mime_type": "text/plain", "status": "valid", "quantity_normalized": "12.00000000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Dispenser** ``` { "result": { "tx_index": 114, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "block_index": 236, "block_hash": "0000000000000000000000000000000000000000000000000000000000000097", "block_time": 1768316157, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "destination": null, "btc_amount": 0, "fee": 0, "data": "000000000000000000000000000000000000000000000000000000000000002b0100", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000a5:1 2 0", "transaction_type": "dispenser", "confirmed": true, "valid": 1, "events": [ { "event_index": 976, "event": "OPEN_DISPENSER", "params": { "asset": "XCP", "block_index": 236, "dispense_count": 0, "escrow_quantity": 5000, "give_quantity": 1, "give_remaining": 5000, "oracle_address": null, "origin": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "satoshirate": 1, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "tx_index": 114, "block_time": 1768316157, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00005000", "escrow_quantity_normalized": "0.00005000", "satoshirate_normalized": "0.00000001" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "block_index": 236, "block_time": 1768316157 } ], "unpacked_data": { "message_type": "dispenser", "message_type_id": 12, "message_data": { "asset": "XCP", "give_quantity": 1, "escrow_quantity": 5000, "mainchainrate": 1, "dispenser_status": 0, "action_address": null, "oracle_address": null, "status": "valid", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_quantity_normalized": "0.00000001", "escrow_quantity_normalized": "0.00005000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Dispense** ``` { "result": { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "source": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "btc_amount": 1000, "fee": 0, "data": "0d00", "supported": true, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000074:1 00000000000000000000000000000000000000000000000000000000000000d4:0 3 1", "transaction_type": "dispense", "confirmed": true, "valid": 1, "events": [ { "event_index": 1034, "event": "UTXO_MOVE", "params": { "asset": "MYASSETA", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 0, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "unpacked_data": { "message_type": "dispense", "message_type_id": 13, "message_data": { "data": "00" } }, "btc_amount_normalized": "0.00001000" } } ``` **Dividend** ``` { "result": { "tx_index": 42, "tx_hash": "000000000000000000000000000000000000000000000000000000000000004d", "block_index": 146, "block_hash": "0000000000000000000000000000000000000000000000000000000000000030", "block_time": 1768315794, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "320000000005f5e100000000182b37176e0000000000000001", "supported": true, "utxos_info": " 000000000000000000000000000000000000000000000000000000000000004d:1 2 0", "transaction_type": "dividend", "confirmed": true, "valid": 1, "events": [ { "event_index": 338, "event": "ASSET_DIVIDEND", "params": { "asset": "MYASSETA", "block_index": 146, "dividend_asset": "XCP", "fee_paid": 20000, "quantity_per_unit": 100000000, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000004d", "tx_index": 42, "block_time": 1768315794, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "dividend_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_per_unit_normalized": "1.00000000", "fee_paid_normalized": "0.00020000" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000004d", "block_index": 146, "block_time": 1768315794 } ], "unpacked_data": { "message_type": "dividend", "message_type_id": 50, "message_data": { "asset": "MYASSETA", "quantity_per_unit": 100000000, "dividend_asset": "XCP", "status": "valid", "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "dividend_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_per_unit_normalized": "1.00000000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Issuance** ``` { "result": { "tx_index": 120, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_hash": "00000000000000000000000000000000000000000000000000000000000000bd", "block_time": 1768316185, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "destination": null, "btc_amount": 0, "fee": 10000, "data": "5a931b0000001b45a625390000010a0000000000000000f4f4f4f56040", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000bc:1 2 0", "transaction_type": "fairminter", "confirmed": true, "valid": 1, "events": [ { "event_index": 1021, "event": "NEW_FAIRMINTER", "params": { "asset": "OPENFAIR", "asset_longname": null, "asset_parent": null, "block_index": 243, "burn_payment": false, "description": "", "divisible": true, "end_block": 0, "hard_cap": 0, "lock_description": false, "lock_quantity": false, "max_mint_per_address": 0, "max_mint_per_tx": 10, "mime_type": "text/plain", "minted_asset_commission_int": 0, "pre_minted": false, "premint_quantity": 0, "price": 0, "quantity_by_price": 1, "soft_cap": 0, "soft_cap_deadline_block": 0, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "start_block": 0, "status": "open", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_time": 1768316185, "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000010", "premint_quantity_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 }, { "event_index": 1022, "event": "ASSET_CREATION", "params": { "asset_id": "117132633401", "asset_longname": null, "asset_name": "OPENFAIR", "block_index": 243, "block_time": 1768316185 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 }, { "event_index": 1023, "event": "ASSET_ISSUANCE", "params": { "asset": "OPENFAIR", "asset_events": "open_fairminter", "asset_longname": null, "block_index": 243, "call_date": 0, "call_price": 0, "callable": false, "description": "", "divisible": true, "fair_minting": true, "fee_paid": 50000000.0, "issuer": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "locked": false, "mime_type": "text/plain", "quantity": 0, "reset": false, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "valid", "transfer": false, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_time": 1768316185, "quantity_normalized": "0.00000000", "fee_paid_normalized": "0.50000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 } ], "unpacked_data": { "message_type": "fairminter", "message_type_id": 90, "message_data": { "asset": "OPENFAIR", "asset_parent": "", "price": 0, "quantity_by_price": 1, "max_mint_per_tx": 10, "max_mint_per_address": 0, "hard_cap": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "minted_asset_commission": "0.00000000", "burn_payment": false, "lock_description": false, "lock_quantity": false, "divisible": true, "mime_type": "text/plain", "description": "", "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000010", "premint_quantity_normalized": "0.00000000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Order** ``` { "result": { "tx_index": 119, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_hash": "0000000000000000000000000000000000000000000000000000000000000035", "block_time": 1768316181, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "destination": null, "btc_amount": 0, "fee": 10000, "data": "0000000000000000000000000000000000000000000000000000000000000026e800150000000000000000", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000113:1 2 0", "transaction_type": "order", "confirmed": true, "valid": 1, "events": [ { "event_index": 1013, "event": "OPEN_ORDER", "params": { "block_index": 242, "expiration": 21, "expire_index": 263, "fee_provided": 10000, "fee_provided_remaining": 10000, "fee_required": 0, "fee_required_remaining": 0, "get_asset": "UTXOASSET", "get_quantity": 1000, "get_remaining": 1000, "give_asset": "BTC", "give_quantity": 1000, "give_remaining": 1000, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "open", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "tx_index": 119, "block_time": 1768316181, "give_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "get_asset_info": { "asset_longname": null, "description": "My super asset", "issuer": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "divisible": true, "locked": false, "owner": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu" }, "give_quantity_normalized": "0.00001000", "get_quantity_normalized": "0.00001000", "get_remaining_normalized": "0.00001000", "give_remaining_normalized": "0.00001000", "fee_provided_normalized": "0.00010000", "fee_required_normalized": "0.00000000", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 }, { "event_index": 1014, "event": "ORDER_UPDATE", "params": { "fee_provided_remaining": 10000, "fee_required_remaining": 0, "get_remaining": 0, "give_remaining": 0, "status": "open", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d3", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 }, { "event_index": 1015, "event": "ORDER_UPDATE", "params": { "fee_provided_remaining": 10000, "fee_required_remaining": 0, "get_remaining": 0, "give_remaining": 0, "status": "open", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 }, { "event_index": 1016, "event": "ORDER_MATCH", "params": { "backward_asset": "BTC", "backward_quantity": 1000, "block_index": 242, "fee_paid": 0, "forward_asset": "UTXOASSET", "forward_quantity": 1000, "id": "00000000000000000000000000000000000000000000000000000000000000d3_0000000000000000000000000000000000000000000000000000000000000113", "match_expire_index": 262, "status": "pending", "tx0_address": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "tx0_block_index": 241, "tx0_expiration": 21, "tx0_hash": "00000000000000000000000000000000000000000000000000000000000000d3", "tx0_index": 118, "tx1_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx1_block_index": 242, "tx1_expiration": 21, "tx1_hash": "0000000000000000000000000000000000000000000000000000000000000113", "tx1_index": 119, "block_time": 1768316181, "forward_asset_info": { "asset_longname": null, "description": "My super asset", "issuer": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "divisible": true, "locked": false, "owner": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu" }, "backward_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "forward_quantity_normalized": "0.00001000", "backward_quantity_normalized": "0.00001000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000113", "block_index": 242, "block_time": 1768316181 } ], "unpacked_data": { "message_type": "order", "message_type_id": 10, "message_data": { "give_asset": "BTC", "give_quantity": 1000, "get_asset": "UTXOASSET", "get_quantity": 1000, "expiration": 21, "fee_required": 0, "status": "open", "give_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "get_asset_info": { "asset_longname": null, "description": "My super asset", "issuer": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "divisible": true, "locked": false, "owner": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu" }, "give_quantity_normalized": "0.00001000", "get_quantity_normalized": "0.00001000", "fee_required_normalized": "0.00000000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Enhanced_send** ``` { "result": { "tx_index": 77, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "block_index": 201, "block_hash": "0000000000000000000000000000000000000000000000000000000000000091", "block_time": 1768316002, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001af50d80b8cc40", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000f6:1 2 0", "transaction_type": "enhanced_send", "confirmed": true, "valid": 1, "events": [ { "event_index": 653, "event": "ENHANCED_SEND", "params": { "asset": "MPMASSET", "block_index": 201, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": null, "msg_index": 0, "quantity": 1000, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "tx_index": 77, "block_time": 1768316002, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "block_index": 201, "block_time": 1768316002 } ], "unpacked_data": { "message_type": "enhanced_send", "message_type_id": 2, "message_data": { "asset": "MPMASSET", "quantity": 1000, "address": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": null, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00001000" } }, "btc_amount_normalized": "0.00000000" } } ``` **Mpma_send** ``` { "result": { "tx_index": 81, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_hash": "000000000000000000000000000000000000000000000000000000000000003a", "block_time": 1768316019, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001d000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e7000000000000000000000000000000000000000000000000000000000000000188", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000028:0 4 ", "transaction_type": "mpma", "confirmed": true, "valid": 1, "events": [ { "event_index": 704, "event": "ORDER_UPDATE", "params": { "status": "expired", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000102" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 705, "event": "ORDER_EXPIRATION", "params": { "block_index": 205, "order_hash": "0000000000000000000000000000000000000000000000000000000000000102", "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "block_time": 1768316019 }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 711, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 205, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "the memo", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 712, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 205, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "memo3", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 713, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 205, "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "memo": "memo1", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "the memo", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "quantity": 10, "memo": "memo1", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" } } ``` **Sweep** ``` { "result": { "tx_index": 65, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "block_index": 190, "block_hash": "00000000000000000000000000000000000000000000000000000000000000ae", "block_time": 1768315955, "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "destination": null, "btc_amount": 0, "fee": 10000, "data": "0000000000000000000000000000000000000000000000000000000000000022206d7920617373657473", "supported": true, "utxos_info": " 000000000000000000000000000000000000000000000000000000000000009e:1 2 0", "transaction_type": "sweep", "confirmed": true, "valid": null, "events": [ { "event_index": 571, "event": "SWEEP", "params": { "block_index": 190, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "fee_paid": 600000, "flags": 1, "memo": "sweep my assets", "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "tx_index": 65, "block_time": 1768315955, "fee_paid_normalized": "0.00600000" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "block_index": 190, "block_time": 1768315955 } ], "unpacked_data": { "message_type": "sweep", "message_type_id": 4, "message_data": { "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "flags": 1, "memo": "sweep my assets" } }, "btc_amount_normalized": "0.00000000" } } ``` **Attach** ``` { "result": { "tx_index": 112, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000065", "block_index": 235, "block_hash": "0000000000000000000000000000000000000000000000000000000000000052", "block_time": 1768316150, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "destination": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "btc_amount": 10000, "fee": 10000, "data": "65444554414348417c3130303030303030307c", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000065:0 3 1", "transaction_type": "attach", "confirmed": true, "valid": 1, "events": [ { "event_index": 965, "event": "ATTACH_TO_UTXO", "params": { "asset": "DETACHA", "block_index": 235, "destination": "0000000000000000000000000000000000000000000000000000000000000065:0", "destination_address": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "fee_paid": 0, "msg_index": 0, "quantity": 100000000, "send_type": "attach", "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000065", "tx_index": 112, "block_time": 1768316150, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "1.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000065", "block_index": 235, "block_time": 1768316150 } ], "unpacked_data": { "message_type": "attach", "message_type_id": 101, "message_data": { "asset": "DETACHA", "quantity": 100000000, "destination_vout": null, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "1.00000000" } }, "btc_amount_normalized": "0.00010000" } } ``` **Detach** ``` { "result": { "tx_index": 111, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "block_index": 234, "block_hash": "000000000000000000000000000000000000000000000000000000000000008b", "block_time": 1768316146, "source": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "destination": null, "btc_amount": 0, "fee": 0, "data": "6630", "supported": true, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000092:0 0000000000000000000000000000000000000000000000000000000000000002:1 2 0", "transaction_type": "detach", "confirmed": true, "valid": 1, "events": [ { "event_index": 954, "event": "DETACH_FROM_UTXO", "params": { "asset": "DETACHA", "block_index": 234, "destination": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "fee_paid": 0, "msg_index": 0, "quantity": 100000000, "send_type": "detach", "source": "0000000000000000000000000000000000000000000000000000000000000092:0", "source_address": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "tx_index": 111, "block_time": 1768316146, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "1.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "block_index": 234, "block_time": 1768316146 }, { "event_index": 957, "event": "DETACH_FROM_UTXO", "params": { "asset": "DETACHB", "block_index": 234, "destination": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "fee_paid": 0, "msg_index": 1, "quantity": 100000000, "send_type": "detach", "source": "0000000000000000000000000000000000000000000000000000000000000092:0", "source_address": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "tx_index": 111, "block_time": 1768316146, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g", "divisible": true, "locked": false, "owner": "bc1qsvtddtznyh0n4ft2as9g6kg3deg35x9p27776g" }, "quantity_normalized": "1.00000000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000002", "block_index": 234, "block_time": 1768316146 } ], "unpacked_data": { "message_type": "detach", "message_type_id": 102, "message_data": { "destination": null } }, "btc_amount_normalized": "0.00000000" } } ``` ### Get Transactions [GET /v2/transactions{?type,show_unconfirmed,valid,cursor,limit,offset,verbose}] Returns the list of the last ten transactions + Parameters + type (enum[str], optional) - The type of the transaction to return + Default: `all` + Members + `all` + `bet` + `broadcast` + `btcpay` + `cancel` + `destroy` + `dispenser` + `dispense` + `dividend` + `issuance` + `order` + `send` + `enhanced_send` + `mpma` + `rps` + `rpsresolve` + `sweep` + `fairminter` + `fairmint` + `attach` + `detach` + `utxomove` + `unknown` + show_unconfirmed (bool, optional) - Show unconfirmed transactions + Default: `null` + valid (bool, optional) - If True, only return valid transactions + Default: `null` + cursor: `121` (int, optional) - The index of the most recent transactions to return + Default: `null` + limit: `2` (int, optional) - The number of transactions to return + Default: `10` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "source": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "btc_amount": 1000, "fee": 0, "data": "0d00", "supported": true, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000074:1 00000000000000000000000000000000000000000000000000000000000000d4:0 3 1", "transaction_type": "dispense", "valid": 1, "events": [ { "event_index": 1034, "event": "UTXO_MOVE", "params": { "asset": "MYASSETA", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 0, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "unpacked_data": { "message_type": "dispense", "message_type_id": 13, "message_data": { "data": "00" } }, "btc_amount_normalized": "0.00001000" }, { "tx_index": 120, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_hash": "00000000000000000000000000000000000000000000000000000000000000bd", "block_time": 1768316185, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "destination": null, "btc_amount": 0, "fee": 10000, "data": "5a931b0000001b45a625390000010a0000000000000000f4f4f4f56040", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000bc:1 2 0", "transaction_type": "fairminter", "valid": 1, "events": [ { "event_index": 1021, "event": "NEW_FAIRMINTER", "params": { "asset": "OPENFAIR", "asset_longname": null, "asset_parent": null, "block_index": 243, "burn_payment": false, "description": "", "divisible": true, "end_block": 0, "hard_cap": 0, "lock_description": false, "lock_quantity": false, "max_mint_per_address": 0, "max_mint_per_tx": 10, "mime_type": "text/plain", "minted_asset_commission_int": 0, "pre_minted": false, "premint_quantity": 0, "price": 0, "quantity_by_price": 1, "soft_cap": 0, "soft_cap_deadline_block": 0, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "start_block": 0, "status": "open", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_time": 1768316185, "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000010", "premint_quantity_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 }, { "event_index": 1022, "event": "ASSET_CREATION", "params": { "asset_id": "117132633401", "asset_longname": null, "asset_name": "OPENFAIR", "block_index": 243, "block_time": 1768316185 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 }, { "event_index": 1023, "event": "ASSET_ISSUANCE", "params": { "asset": "OPENFAIR", "asset_events": "open_fairminter", "asset_longname": null, "block_index": 243, "call_date": 0, "call_price": 0, "callable": false, "description": "", "divisible": true, "fair_minting": true, "fee_paid": 50000000.0, "issuer": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "locked": false, "mime_type": "text/plain", "quantity": 0, "reset": false, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": "valid", "transfer": false, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "tx_index": 120, "block_time": 1768316185, "quantity_normalized": "0.00000000", "fee_paid_normalized": "0.50000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000bc", "block_index": 243, "block_time": 1768316185 } ], "unpacked_data": { "message_type": "fairminter", "message_type_id": 90, "message_data": { "asset": "OPENFAIR", "asset_parent": "", "price": 0, "quantity_by_price": 1, "max_mint_per_tx": 10, "max_mint_per_address": 0, "hard_cap": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "minted_asset_commission": "0.00000000", "burn_payment": false, "lock_description": false, "lock_quantity": false, "divisible": true, "mime_type": "text/plain", "description": "", "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000010", "premint_quantity_normalized": "0.00000000" } }, "btc_amount_normalized": "0.00000000" } ], "next_cursor": 119, "result_count": 122 } ``` ### Get Transaction Types Count [GET /v2/transactions/counts{?verbose}] Returns the count of each transaction type + Parameters + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "transaction_type": "issuance", "count": 20 }, { "transaction_type": "fairminter", "count": 18 }, { "transaction_type": "fairmint", "count": 15 }, { "transaction_type": "burn", "count": 10 }, { "transaction_type": "order", "count": 9 }, { "transaction_type": "attach", "count": 9 }, { "transaction_type": "dispenser", "count": 9 }, { "transaction_type": "utxomove", "count": 7 }, { "transaction_type": "dispense", "count": 6 }, { "transaction_type": "mpma", "count": 5 }, { "transaction_type": "detach", "count": 4 }, { "transaction_type": "enhanced_send", "count": 3 }, { "transaction_type": "broadcast", "count": 2 }, { "transaction_type": "destroy", "count": 1 }, { "transaction_type": "sweep", "count": 1 }, { "transaction_type": "cancel", "count": 1 }, { "transaction_type": "btcpay", "count": 1 }, { "transaction_type": "dividend", "count": 1 } ], "next_cursor": null, "result_count": 18 } ``` ### Info [GET /v2/transactions/info{?rawtransaction,block_index,verbose}] Returns Counterparty information from a raw transaction in hex format. + Parameters + rawtransaction: `0000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000011737de82b2c795ad75e7b660fc5629f05791763208d288bdbf687100000000000000000000000000000000000000000000000000000000000000b35cd1d7e6ee2102b8048d37896507992ebf570fdf00000000000000000000000000000000000000000000000000000000000000c603a82c5b37de82b2c795aa79dcd66b0df9a46ddfe3791356af37ab677b0c00000000000000000000000000000000000000000000000000000000000000db2a22e1fff82102b8048d37896507992ebf570fdf00000000000000000000000000000000000000000000000000000000000000c60000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000010f0000000000000000000000000000000000000000000000000000000000000109000000000000000000000000000000000000000000000000000000000000011c000000000000000000000000000000000000000000000000000000000000006b46003c47dd56bbe7000000000000000000000000000000000000000000000000000000000000010368507dd3acfb0121000000000000000000000000000000000000000000000000000000000000001b1100000000` (str, required) - Raw transaction in hex format + block_index (int, optional) - Block index mandatory for transactions before block 335000 + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "decoded_tx": { "version": 2, "segwit": true, "coinbase": false, "lock_time": 0, "tx_id": "0000000000000000000000000000000000000000000000000000000000000023", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "vtxinwit": [ [ "0000000000000000000000000000000000000000000000000000000000000061000000000000000000000000000000000000000000000000000000000000010368507dd3acfb01", "000000000000000000000000000000000000000000000000000000000000001b11" ] ], "parsed_vouts": [ [], 0, -4999990000, "000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e60a856d656d6f3380000000000000008000000000000000542b6b2b6b7988", [ [ null, 1000 ], [ null, 1000 ], [ null, 1000 ], [ "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", 4999987000 ] ], false ], "vin": [ { "hash": "0000000000000000000000000000000000000000000000000000000000000044", "n": 0, "sequence": 4294967295, "script_sig": "", "info": { "script_pub_key": "00148d5085ab9b85ca7da5d6a058ee66378aecaf7622", "value": 5000000000, "is_segwit": true } } ], "vout": [ { "value": 1000, "script_pub_key": "000000000000000000000000000000000000000000000000000000000000008f00000000000000000000000000000000000000000000000000000000000000b3000000000000000000000000000000000000000000000000000000000000009aed05f779739f1153ae" }, { "value": 1000, "script_pub_key": "000000000000000000000000000000000000000000000000000000000000008e00000000000000000000000000000000000000000000000000000000000000db000000000000000000000000000000000000000000000000000000000000005bed05f779739f1153ae" }, { "value": 1000, "script_pub_key": "000000000000000000000000000000000000000000000000000000000000008d6351000000000000000000000000000000000000000000000000000000000000010f0000000000000000000000000000000000000000000000000000000000000109f779739f1153ae" }, { "value": 4999987000, "script_pub_key": "00148d5085ab9b85ca7da5d6a058ee66378aecaf7622" } ] }, "data": "000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e60a856d656d6f3380000000000000008000000000000000542b6b2b6b7988", "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "memo2", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "quantity": 10, "memo": "memo1", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" } } ``` ### Info By Tx Hash [GET /v2/transactions/{tx_hash}/info{?verbose}] Returns Counterparty information from a transaction hash. + Parameters + tx_hash: `0000000000000000000000000000000000000000000000000000000000000089` (str, required) - Transaction hash + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "source": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "destination": null, "btc_amount": 0, "fee": 10000, "decoded_tx": { "version": 2, "segwit": true, "coinbase": false, "lock_time": 0, "tx_id": "0000000000000000000000000000000000000000000000000000000000000089", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "vtxinwit": [ [ "0000000000000000000000000000000000000000000000000000000000000063000000000000000000000000000000000000000000000000000000000000011ef50f07ff022501", "0000000000000000000000000000000000000000000000000000000000000021d6" ] ], "parsed_vouts": [ [], 0, -4949940000, "028401192710560300a18eabe60fb484f6ced06d16f790d4fcdad6867140", [ [ null, null ], [ "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", 4949940000 ] ], false ], "vin": [ { "hash": "0000000000000000000000000000000000000000000000000000000000000054", "n": 1, "sequence": 4294967295, "script_sig": "", "info": { "script_pub_key": "0014c72c8f45733619040c38e082c09a2b1f31ffb41f", "value": 4949950000, "is_segwit": true } } ], "vout": [ { "value": 0, "script_pub_key": "00000000000000000000000000000000000000000000000000000000000000acff22bf9c06f11c7c" }, { "value": 4949940000, "script_pub_key": "0014c72c8f45733619040c38e082c09a2b1f31ffb41f" } ] }, "data": "028401192710560300a18eabe60fb484f6ced06d16f790d4fcdad6867140", "unpacked_data": { "message_type": "enhanced_send", "message_type_id": 2, "message_data": { "asset": "XCP", "quantity": 10000, "address": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": null, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00010000" } }, "btc_amount_normalized": "0.00000000" } } ``` ### Unpack [GET /v2/transactions/unpack{?datahex,block_index,verbose}] Unpacks Counterparty data in hex format and returns the message type and data. + Parameters + datahex: `000000000000000000000000000000000000000000000000000000000000000500000000000000000000000000000000000000000000000000000000000000da000000000000000000000000000000000000000000000000000000000000003300000000000000000000000000000000000000000000000000000000000000c500000000000000000000000000000000000000000000000000000000000000360000000000000000000000000000000000000000000000000000000000000068fe4ec05dab922ccdc5727cbf664cafc7cdb845de534855266314c800000000` (str, required) - Data in hex format + block_index (int, optional) - Block index of the transaction containing this data + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "message_type": "enhanced_send", "message_type_id": 2, "message_data": { "error": "memo too long" } } } ``` ### Get Transaction By Tx Index [GET /v2/transactions/{tx_index}{?verbose}] Returns a transaction by its index. + Parameters + tx_index: `121` (int, required) - The index of the transaction + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "source": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "btc_amount": 1000, "fee": 0, "data": "0d00", "supported": true, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000074:1 00000000000000000000000000000000000000000000000000000000000000d4:0 3 1", "transaction_type": "dispense", "confirmed": true, "valid": 1, "events": [ { "event_index": 1034, "event": "UTXO_MOVE", "params": { "asset": "MYASSETA", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 0, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "unpacked_data": { "message_type": "dispense", "message_type_id": 13, "message_data": { "data": "00" } }, "btc_amount_normalized": "0.00001000" } } ``` ### Get Transaction By Hash [GET /v2/transactions/{tx_hash}{?verbose}] Returns a transaction by its hash. + Parameters + tx_hash: `00000000000000000000000000000000000000000000000000000000000000d4` (str, required) - The hash of the transaction + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_hash": "000000000000000000000000000000000000000000000000000000000000004f", "block_time": 1768316195, "source": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "btc_amount": 1000, "fee": 0, "data": "0d00", "supported": true, "utxos_info": "0000000000000000000000000000000000000000000000000000000000000074:1 00000000000000000000000000000000000000000000000000000000000000d4:0 3 1", "transaction_type": "dispense", "confirmed": true, "valid": 1, "events": [ { "event_index": 1034, "event": "UTXO_MOVE", "params": { "asset": "MYASSETA", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 0, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "unpacked_data": { "message_type": "dispense", "message_type_id": 13, "message_data": { "data": "00" } }, "btc_amount_normalized": "0.00001000" } } ``` ### Get Events By Transaction Index [GET /v2/transactions/{tx_index}/events{?event_name,cursor,limit,offset,verbose}] Returns the events of a transaction + Parameters + tx_index: `121` (int, required) - The index of the transaction to return + event_name (str, optional) - Comma separated list of events to return + Default: `null` + cursor (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 1041, "event": "TRANSACTION_PARSED", "params": { "supported": true, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1036, "result_count": 12 } ``` ### Get Events By Transaction Hash [GET /v2/transactions/{tx_hash}/events{?event_name,cursor,limit,offset,verbose}] Returns the events of a transaction + Parameters + tx_hash: `00000000000000000000000000000000000000000000000000000000000000d4` (str, required) - The hash of the transaction to return + event_name (str, optional) - Comma separated list of events to return + Default: `null` + cursor: `1042` (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 1041, "event": "TRANSACTION_PARSED", "params": { "supported": true, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1040, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 245, "btc_amount": 1000, "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "dispense_index": 0, "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1039, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 2, "give_remaining": 9268, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00009268" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1037, "event": "UTXO_MOVE", "params": { "asset": "XCP", "block_index": 245, "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "msg_index": 1, "quantity": 2000000000, "send_type": "move", "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "tx_index": 121, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": 1036, "result_count": 12 } ``` ### Get Sends By Transaction Hash [GET /v2/transactions/{tx_hash}/sends{?send_type,cursor,limit,offset,verbose}] Returns the sends, include Enhanced and MPMA sends, of a block + Parameters + tx_hash: `00000000000000000000000000000000000000000000000000000000000000d4` (str, required) - The hash of the transaction to return + send_type (enum[str], optional) - The type of the send to return + Default: `all` + Members + `all` + `send` + `attach` + `move` + `detach` + cursor (int, optional) - The last index of the debits to return + Default: `null` + limit: `5` (int, optional) - The maximum number of debits to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "asset": "XCP", "quantity": 2000000000, "status": "valid", "msg_index": 1, "memo": null, "fee_paid": 0, "send_type": "move", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000", "fee_paid_normalized": "0.00000000" }, { "tx_index": 121, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "source": "0000000000000000000000000000000000000000000000000000000000000074:1", "destination": "00000000000000000000000000000000000000000000000000000000000000d4:0", "asset": "MYASSETA", "quantity": 2000000000, "status": "valid", "msg_index": 0, "memo": null, "fee_paid": 0, "send_type": "move", "source_address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "destination_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000", "fee_paid_normalized": "0.00000000" } ], "next_cursor": null, "result_count": 2 } ``` ### Get Dispenses By Transaction Hash [GET /v2/transactions/{tx_hash}/dispenses{?cursor,limit,offset,verbose}] Returns the dispenses of a block + Parameters + tx_hash: `00000000000000000000000000000000000000000000000000000000000000d4` (str, required) - The hash of the transaction to return + cursor (int, optional) - The last index of the dispenses to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispenses to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 121, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "destination": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "dispense_quantity": 66, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000cd", "btc_amount": 1000, "dispenser": { "tx_index": 33, "block_index": 245, "source": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 0, "give_remaining": 9268, "oracle_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "last_status_tx_hash": null, "origin": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": 0.01, "oracle_price": 66600.0, "fiat_unit": "USD", "oracle_price_last_updated": 129, "satoshi_price": 16, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00009268", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000016" }, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00000066", "btc_amount_normalized": "0.00001000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Events By Transaction Index And Event [GET /v2/transactions/{tx_index}/events/{event}{?cursor,limit,offset,verbose}] Returns the events of a transaction + Parameters + tx_index: `121` (int, required) - The index of the transaction to return + event: `CREDIT` (str, required) - The event to filter by + cursor: `1042` (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1036, "event": "CREDIT", "params": { "address": null, "asset": "XCP", "block_index": 245, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1033, "event": "CREDIT", "params": { "address": null, "asset": "MYASSETA", "block_index": 245, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": null, "result_count": 3 } ``` ### Get Events By Transaction Hash And Event [GET /v2/transactions/{tx_hash}/events/{event}{?cursor,limit,offset,verbose}] Returns the events of a transaction + Parameters + tx_hash: `00000000000000000000000000000000000000000000000000000000000000d4` (str, required) - The hash of the transaction to return + event: `CREDIT` (str, required) - The event to filter by + cursor: `1042` (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 1038, "event": "CREDIT", "params": { "address": "bc1qrnsycz84ejd0lu9ksh5rdtnna4sf62lzecj6yw", "asset": "XCP", "block_index": 245, "calling_function": "dispense", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 66, "tx_index": 121, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000066" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1036, "event": "CREDIT", "params": { "address": null, "asset": "XCP", "block_index": 245, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 }, { "event_index": 1033, "event": "CREDIT", "params": { "address": null, "asset": "MYASSETA", "block_index": 245, "calling_function": "utxo move", "event": "00000000000000000000000000000000000000000000000000000000000000d4", "quantity": 2000000000, "tx_index": 121, "utxo": "00000000000000000000000000000000000000000000000000000000000000d4:0", "utxo_address": "bc1qjpjucsvpxhr4sh554rp4qadyj6ch0w6csqu8ty", "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "20.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d4", "block_index": 245, "block_time": 1768316195 } ], "next_cursor": null, "result_count": 3 } ``` ## Group Addresses ### Get Balances By Addresses [GET /v2/addresses/balances{?addresses,type,asset,cursor,limit,offset,sort,verbose}] Returns the balances of several addresses + Parameters + addresses: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg,bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - Comma separated list of addresses + type (enum[str], optional) - The type of balances to return + Default: `all` + Members + `all` + `utxo` + `address` + asset: `XCP` (str, optional) - The asset to return + Default: `null` + cursor (str, optional) - The last index of the balances to return + Default: `null` + limit: `5` (int, optional) - The maximum number of balances to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + sort: `quantity:desc` (str, optional) - The sort order of the balances to return (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "asset": "XCP", "asset_longname": null, "total": 157099979334, "addresses": [ { "address": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "utxo": null, "utxo_address": null, "quantity": 74500013138, "quantity_normalized": "745.00013138" }, { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "utxo": null, "utxo_address": null, "quantity": 82599966196, "quantity_normalized": "825.99966196" } ], "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "total_normalized": "1570.99979334" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Transactions By Addresses [GET /v2/addresses/transactions{?addresses,type,show_unconfirmed,valid,cursor,limit,offset,verbose}] Returns the transactions of a list of addresses + Parameters + addresses: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg,bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - Comma separated list of addresses to return + type (enum[str], optional) - The type of the transaction to return + Default: `all` + Members + `all` + `bet` + `broadcast` + `btcpay` + `cancel` + `destroy` + `dispenser` + `dispense` + `dividend` + `issuance` + `order` + `send` + `enhanced_send` + `mpma` + `rps` + `rpsresolve` + `sweep` + `fairminter` + `fairmint` + `attach` + `detach` + `utxomove` + `unknown` + show_unconfirmed (bool, optional) - Show unconfirmed transactions + Default: `null` + valid (bool, optional) - If True, only return valid transactions + Default: `null` + cursor: `121` (int, optional) - The last transaction index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of transactions to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 115, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "block_hash": "00000000000000000000000000000000000000000000000000000000000000b8", "block_time": 1768316161, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "btc_amount": 3000, "fee": 0, "data": "0d00", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000051:0 3 1", "transaction_type": "dispense", "valid": 1, "events": [ { "event_index": 983, "event": "DISPENSER_UPDATE", "params": { "asset": "XCP", "dispense_count": 1, "give_remaining": 2000, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "status": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_remaining_normalized": "0.00002000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "block_time": 1768316161 }, { "event_index": 984, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 237, "btc_amount": 3000, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "dispense_index": 0, "dispense_quantity": 3000, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "tx_index": 115, "block_time": 1768316161, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00003000", "btc_amount_normalized": "0.00003000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "block_time": 1768316161 } ], "unpacked_data": { "message_type": "dispense", "message_type_id": 13, "message_data": { "data": "00" } }, "btc_amount_normalized": "0.00003000" }, { "tx_index": 81, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_hash": "000000000000000000000000000000000000000000000000000000000000003a", "block_time": 1768316019, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001d000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e7000000000000000000000000000000000000000000000000000000000000000188", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000028:0 4 ", "transaction_type": "mpma", "valid": 1, "events": [ { "event_index": 704, "event": "ORDER_UPDATE", "params": { "status": "expired", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000102" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 705, "event": "ORDER_EXPIRATION", "params": { "block_index": 205, "order_hash": "0000000000000000000000000000000000000000000000000000000000000102", "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "block_time": 1768316019 }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 711, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 205, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "the memo", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 712, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 205, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "memo3", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 }, { "event_index": 713, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 205, "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "memo": "memo1", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "block_time": 1768316019 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "the memo", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "quantity": 10, "memo": "memo1", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 80, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_hash": "000000000000000000000000000000000000000000000000000000000000001f", "block_time": 1768316015, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001d000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e80000000a4000000000000000400000000000000028", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000cb:0 4 ", "transaction_type": "mpma", "valid": 1, "events": [ { "event_index": 685, "event": "ORDER_MATCH_UPDATE", "params": { "id": "0000000000000000000000000000000000000000000000000000000000000088_0000000000000000000000000000000000000000000000000000000000000102", "order_match_id": "0000000000000000000000000000000000000000000000000000000000000088_0000000000000000000000000000000000000000000000000000000000000102", "status": "expired" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 687, "event": "ORDER_UPDATE", "params": { "fee_required_remaining": 0, "get_remaining": 3000, "give_remaining": 3000, "status": "open", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000102", "fee_required_remaining_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 688, "event": "ORDER_MATCH_EXPIRATION", "params": { "block_index": 204, "order_match_id": "0000000000000000000000000000000000000000000000000000000000000088_0000000000000000000000000000000000000000000000000000000000000102", "tx0_address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "tx1_address": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "block_time": 1768316015 }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 689, "event": "ORDER_UPDATE", "params": { "fee_provided_remaining": 10000, "fee_required_remaining": 0, "get_remaining": 0, "give_remaining": 0, "status": "open", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000c2", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 690, "event": "ORDER_UPDATE", "params": { "fee_provided_remaining": 10000, "fee_required_remaining": 0, "get_remaining": 2000, "give_remaining": 2000, "status": "open", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000102", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 691, "event": "ORDER_MATCH", "params": { "backward_asset": "BTC", "backward_quantity": 1000, "block_index": 204, "fee_paid": 0, "forward_asset": "XCP", "forward_quantity": 1000, "id": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "match_expire_index": 224, "status": "pending", "tx0_address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "tx0_block_index": 189, "tx0_expiration": 21, "tx0_hash": "00000000000000000000000000000000000000000000000000000000000000c2", "tx0_index": 64, "tx1_address": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "tx1_block_index": 204, "tx1_expiration": 21, "tx1_hash": "0000000000000000000000000000000000000000000000000000000000000102", "tx1_index": 58, "block_time": 1768316015, "forward_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "backward_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "forward_quantity_normalized": "0.00001000", "backward_quantity_normalized": "0.00001000", "fee_paid_normalized": "0.00000000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 697, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 204, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "746865206d656d6f", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "tx_index": 80, "block_time": 1768316015, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 698, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 204, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "746865206d656d6f", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "tx_index": 80, "block_time": 1768316015, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 }, { "event_index": 699, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 204, "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "memo": "746865206d656d6f", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "tx_index": 80, "block_time": 1768316015, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "block_time": 1768316015 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "746865206d656d6f", "memo_is_hex": true, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "quantity": 10, "memo": "746865206d656d6f", "memo_is_hex": true, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 79, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_hash": "0000000000000000000000000000000000000000000000000000000000000066", "block_time": 1768316011, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e60a856d656d6f3380000000000000008000000000000000542b6b2b6b7988", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000023:0 4 ", "transaction_type": "mpma", "valid": 1, "events": [ { "event_index": 678, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 203, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "memo2", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_time": 1768316011 }, { "event_index": 679, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 203, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "memo3", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_time": 1768316011 }, { "event_index": 680, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 203, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": "memo1", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_time": 1768316011 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "memo2", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "quantity": 10, "memo": "memo1", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 78, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_hash": "0000000000000000000000000000000000000000000000000000000000000034", "block_time": 1768316006, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e70000000a4000000000000000400000000000000028", "supported": true, "utxos_info": " 000000000000000000000000000000000000000000000000000000000000009f:0 4 ", "transaction_type": "mpma", "valid": 1, "events": [ { "event_index": 658, "event": "ORDER_UPDATE", "params": { "status": "expired", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000088" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 660, "event": "ORDER_EXPIRATION", "params": { "block_index": 202, "order_hash": "0000000000000000000000000000000000000000000000000000000000000088", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "block_time": 1768316006 }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 666, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 202, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "the memo", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 667, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 202, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "the memo", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 668, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 202, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": "the memo", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "the memo", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "quantity": 10, "memo": "the memo", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" } ], "next_cursor": 77, "result_count": 50 } ``` ### Get Events By Addresses [GET /v2/addresses/events{?addresses,event_name,cursor,limit,offset,verbose}] Returns the events of a list of addresses + Parameters + addresses: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg,bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - Comma separated list of addresses to return + event_name (str, optional) - Comma separated list of events to return + Default: `null` + cursor: `1042` (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "event_index": 984, "event": "DISPENSE", "params": { "asset": "XCP", "block_index": 237, "btc_amount": 3000, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "dispense_index": 0, "dispense_quantity": 3000, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "tx_index": 115, "block_time": 1768316161, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00003000", "btc_amount_normalized": "0.00003000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "block_time": 1768316161 }, { "event_index": 982, "event": "CREDIT", "params": { "address": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "block_index": 237, "calling_function": "dispense", "event": "0000000000000000000000000000000000000000000000000000000000000051", "quantity": 3000, "tx_index": 115, "utxo": null, "utxo_address": null, "block_time": 1768316161, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00003000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "block_time": 1768316161 }, { "event_index": 980, "event": "NEW_TRANSACTION", "params": { "block_hash": "00000000000000000000000000000000000000000000000000000000000000b8", "block_index": 237, "block_time": 1768316161, "btc_amount": 3000, "data": "0d00", "destination": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "fee": 0, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "transaction_type": "dispense", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "tx_index": 115, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000051:0 3 1", "btc_amount_normalized": "0.00003000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "block_time": 1768316161 }, { "event_index": 861, "event": "ORDER_MATCH_EXPIRATION", "params": { "block_index": 225, "order_match_id": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "tx0_address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "tx1_address": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "block_time": 1768316099 }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000042", "block_index": 225, "block_time": 1768316099 }, { "event_index": 860, "event": "CREDIT", "params": { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "block_index": 225, "calling_function": "order expired", "event": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "quantity": 1000, "tx_index": 0, "utxo": null, "utxo_address": null, "block_time": 1768316099, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00001000" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000042", "block_index": 225, "block_time": 1768316099 } ], "next_cursor": 758, "result_count": 267 } ``` ### Get Mempool Events By Addresses [GET /v2/addresses/mempool{?addresses,event_name,cursor,limit,verbose}] Returns the mempool events of a list of addresses + Parameters + addresses: `bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh,bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc` (str, required) - Comma separated list of addresses to return + event_name (str, optional) - Comma separated list of events to return + Default: `null` + cursor (int, optional) - The last event index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of events to return + Default: `100` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "event": "ENHANCED_SEND", "params": { "asset": "XCP", "block_index": 9999999, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": null, "msg_index": 0, "quantity": 10000, "send_type": "send", "source": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "tx_index": 122, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00010000" }, "timestamp": 1768316198.8766072 }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "event": "CREDIT", "params": { "address": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "asset": "XCP", "block_index": 245, "calling_function": "send", "event": "0000000000000000000000000000000000000000000000000000000000000089", "quantity": 10000, "tx_index": 122, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00010000" }, "timestamp": 1768316198.8766072 }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "event": "DEBIT", "params": { "action": "send", "address": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "asset": "XCP", "block_index": 245, "event": "0000000000000000000000000000000000000000000000000000000000000089", "quantity": 10000, "tx_index": 122, "utxo": null, "utxo_address": null, "block_time": 1768316195, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00010000" }, "timestamp": 1768316198.8766072 }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "event": "NEW_TRANSACTION", "params": { "block_hash": "mempool", "block_index": 9999999, "block_time": 1768316198.8766072, "btc_amount": 0, "data": "028401192710560300a18eabe60fb484f6ced06d16f790d4fcdad6867140", "destination": "", "fee": 10000, "source": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "transaction_type": "enhanced_send", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000089", "tx_index": 122, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000089:1 2 0", "btc_amount_normalized": "0.00000000" }, "timestamp": 1768316198.8766072 } ], "next_cursor": null, "result_count": 4 } ``` ### Get Address Balances [GET /v2/addresses/{address}/balances{?type,cursor,limit,offset,sort,verbose}] Returns the balances of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + type (enum[str], optional) - The type of balances to return + Default: `all` + Members + `all` + `utxo` + `address` + cursor (int, optional) - The last index of the balances to return + Default: `null` + limit: `5` (int, optional) - The maximum number of balances to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + sort: `quantity:desc` (str, optional) - The sort order of the balances to return (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "A95428956980101314", "asset_longname": null, "quantity": 100000000000, "utxo": null, "utxo_address": null, "asset_info": { "asset_longname": "A95428959745315388.SUBNUMERIC", "description": "A subnumeric asset", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "1000.00000000" }, { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "MPMASSET", "asset_longname": null, "quantity": 99999998960, "utxo": null, "utxo_address": null, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "999.99998960" }, { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "MYASSETA", "asset_longname": null, "quantity": 97999999980, "utxo": null, "utxo_address": null, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "979.99999980" }, { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "asset_longname": null, "quantity": 82599966196, "utxo": null, "utxo_address": null, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "825.99966196" }, { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "TESTLOCKDESC", "asset_longname": null, "quantity": 9999990000, "utxo": null, "utxo_address": null, "asset_info": { "asset_longname": null, "description": "Test Locking Description", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "99.99990000" } ], "next_cursor": null, "result_count": 5 } ``` ### Get Balances By Address And Asset [GET /v2/addresses/{address}/balances/{asset}{?type,cursor,limit,offset,verbose}] Returns the balances of an address and asset + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + asset: `XCP` (str, required) - The asset to return + type (enum[str], optional) - The type of balances to return + Default: `all` + Members + `all` + `utxo` + `address` + cursor (int, optional) - The last index of the balances to return + Default: `null` + limit: `5` (int, optional) - The maximum number of balances to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "asset_longname": null, "quantity": 82599966196, "utxo": null, "utxo_address": null, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "825.99966196" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Credits By Address [GET /v2/addresses/{address}/credits{?action,cursor,limit,offset,verbose}] Returns the credits of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + action (enum[str], optional) - The action to filter by + Default: `null` + Members + `None` + `Closed: Max dispenses reached` + `bet settled: for equal` + `bet settled: for notequal` + `bet settled: liquidated for bear` + `btcpay` + `burn` + `cancel order` + `close dispenser` + `dispense` + `dispenser close` + `dividend` + `feed fee` + `filled` + `issuance` + `mpma send` + `open dispenser empty addr` + `order cancelled` + `order expired` + `order match` + `recredit backward quantity` + `recredit forward quantity` + `recredit wager` + `recredit wager remaining` + `reset issuance` + `send` + `sweep` + `wins` + cursor (int, optional) - The last index of the credits to return + Default: `null` + limit: `5` (int, optional) - The maximum number of credits to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "block_index": 225, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 1000, "calling_function": "order expired", "event": "00000000000000000000000000000000000000000000000000000000000000c2_0000000000000000000000000000000000000000000000000000000000000102", "tx_index": 0, "utxo": null, "utxo_address": null, "block_time": 1768316099, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00001000" }, { "block_index": 205, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 10, "calling_function": "mpma send", "event": "0000000000000000000000000000000000000000000000000000000000000028", "tx_index": 81, "utxo": null, "utxo_address": null, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, { "block_index": 204, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 10, "calling_function": "mpma send", "event": "00000000000000000000000000000000000000000000000000000000000000cb", "tx_index": 80, "utxo": null, "utxo_address": null, "block_time": 1768316015, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, { "block_index": 204, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 3000, "calling_function": "order expired", "event": "0000000000000000000000000000000000000000000000000000000000000088_0000000000000000000000000000000000000000000000000000000000000102", "tx_index": 0, "utxo": null, "utxo_address": null, "block_time": 1768316015, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00003000" }, { "block_index": 202, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 5000, "calling_function": "cancel order", "event": "0000000000000000000000000000000000000000000000000000000000000088", "tx_index": 0, "utxo": null, "utxo_address": null, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00005000" } ], "next_cursor": 78, "result_count": 22 } ``` ### Get Debits By Address [GET /v2/addresses/{address}/debits{?action,cursor,limit,offset,verbose}] Returns the debits of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + action (enum[str], optional) - The action to filter by + Default: `null` + Members + `None` + `bet` + `destroy` + `dividend` + `dividend fee` + `issuance fee` + `mpma send` + `open RPS` + `open dispenser` + `open dispenser empty addr` + `open order` + `refill dispenser` + `reopen RPS after matching expiration` + `reset destroy` + `send` + `sweep` + `sweep fee` + cursor (int, optional) - The last index of the debits to return + Default: `null` + limit: `5` (int, optional) - The maximum number of debits to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "block_index": 203, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 10, "action": "mpma send", "event": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "utxo": null, "utxo_address": null, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, { "block_index": 203, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "MPMASSET", "quantity": 20, "action": "mpma send", "event": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "utxo": null, "utxo_address": null, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000020" }, { "block_index": 202, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 10, "action": "mpma send", "event": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "utxo": null, "utxo_address": null, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, { "block_index": 202, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "MPMASSET", "quantity": 20, "action": "mpma send", "event": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "utxo": null, "utxo_address": null, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000020" }, { "block_index": 201, "address": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "MPMASSET", "quantity": 1000, "action": "send", "event": "00000000000000000000000000000000000000000000000000000000000000f6", "tx_index": 77, "utxo": null, "utxo_address": null, "block_time": 1768316002, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00001000" } ], "next_cursor": 64, "result_count": 29 } ``` ### Get Bet By Feed [GET /v2/addresses/{address}/bets{?status,cursor,limit,offset,verbose}] Returns the bets of a feed + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address of the feed + status: `filled` (enum[str], optional) - The status of the bet + Default: `open` + Members + `cancelled` + `dropped` + `expired` + `filled` + `open` + cursor (int, optional) - The last index of the bets to return + Default: `null` + limit: `5` (int, optional) - The maximum number of bets to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` ### Get Broadcasts By Source [GET /v2/addresses/{address}/broadcasts{?cursor,limit,offset,verbose}] Returns the broadcasts of a source + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + cursor (int, optional) - The last index of the broadcasts to return + Default: `null` + limit: `5` (int, optional) - The maximum number of broadcasts to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 24, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f5", "block_index": 128, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "timestamp": 4003903983, "value": 999.0, "fee_fraction_int": 0, "text": "Hello, world!", "locked": false, "status": "valid", "mime_type": "text/plain", "block_time": 1768315723, "fee_fraction_int_normalized": "0.00000000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Burns By Address [GET /v2/addresses/{address}/burns{?cursor,limit,offset,verbose}] Returns the burns of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + cursor (int, optional) - The last index of the burns to return + Default: `null` + limit: `5` (int, optional) - The maximum number of burns to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 7, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000fc", "block_index": 112, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "burned": 50000000, "earned": 74999998167, "status": "valid", "block_time": 1768315659, "burned_normalized": "0.50000000", "earned_normalized": "749.99998167" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Sends By Address [GET /v2/addresses/{address}/sends{?send_type,cursor,limit,offset,verbose}] Returns the sends, include Enhanced and MPMA sends, of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + send_type (enum[str], optional) - The type of sends to return + Default: `all` + Members + `all` + `send` + `attach` + `move` + `detach` + cursor (int, optional) - The last index of the sends to return + Default: `null` + limit: `5` (int, optional) - The maximum number of sends to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 81, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000028", "block_index": 205, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 10, "status": "valid", "msg_index": 2, "memo": "memo1", "fee_paid": 0, "send_type": "send", "source_address": null, "destination_address": null, "block_time": 1768316019, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010", "fee_paid_normalized": "0.00000000" }, { "tx_index": 80, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cb", "block_index": 204, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "destination": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "quantity": 10, "status": "valid", "msg_index": 2, "memo": "746865206d656d6f", "fee_paid": 0, "send_type": "send", "source_address": null, "destination_address": null, "block_time": 1768316015, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010", "fee_paid_normalized": "0.00000000" }, { "tx_index": 79, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "quantity": 10, "status": "valid", "msg_index": 2, "memo": "memo1", "fee_paid": 0, "send_type": "send", "source_address": null, "destination_address": null, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010", "fee_paid_normalized": "0.00000000" }, { "tx_index": 79, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "asset": "MPMASSET", "quantity": 10, "status": "valid", "msg_index": 1, "memo": "memo3", "fee_paid": 0, "send_type": "send", "source_address": null, "destination_address": null, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010", "fee_paid_normalized": "0.00000000" }, { "tx_index": 79, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "asset": "MPMASSET", "quantity": 10, "status": "valid", "msg_index": 0, "memo": "memo2", "fee_paid": 0, "send_type": "send", "source_address": null, "destination_address": null, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010", "fee_paid_normalized": "0.00000000" } ], "next_cursor": 25, "result_count": 16 } ``` ### Get Receive By Address [GET /v2/addresses/{address}/receives{?send_type,cursor,limit,offset,verbose}] Returns the receives of an address + Parameters + address: `bc1qhhw2s5cmeu5e4dxd5yynz0w5plgz0u7j2n6g0e` (str, required) - The address to return + send_type (enum[str], optional) - The type of sends to return + Default: `all` + Members + `all` + `send` + `attach` + `move` + `detach` + cursor (int, optional) - The last index of the sends to return + Default: `null` + limit: `5` (int, optional) - The maximum number of sends to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 38, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f0", "block_index": 142, "source": "00000000000000000000000000000000000000000000000000000000000000ef:0", "destination": "bc1qhhw2s5cmeu5e4dxd5yynz0w5plgz0u7j2n6g0e", "asset": "MYASSETA", "quantity": 1000000000, "status": "valid", "msg_index": 0, "memo": null, "fee_paid": 0, "send_type": "detach", "source_address": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "destination_address": null, "block_time": 1768315779, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "10.00000000", "fee_paid_normalized": "0.00000000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Sends By Address And Asset [GET /v2/addresses/{address}/sends/{asset}{?send_type,cursor,limit,offset,verbose}] Returns the sends, include Enhanced and MPMA sends, of an address and asset + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + asset: `EXPANSIVE` (str, required) - The asset to return + send_type (enum[str], optional) - The type of sends to return + Default: `all` + Members + `all` + `send` + `attach` + `move` + `detach` + cursor (int, optional) - The last index of the sends to return + Default: `null` + limit: `5` (int, optional) - The maximum number of sends to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` ### Get Receive By Address And Asset [GET /v2/addresses/{address}/receives/{asset}{?send_type,cursor,limit,offset,verbose}] Returns the receives of an address and asset + Parameters + address: `bc1qhhw2s5cmeu5e4dxd5yynz0w5plgz0u7j2n6g0e` (str, required) - The address to return + asset: `EXPANSIVE` (str, required) - The asset to return + send_type (enum[str], optional) - The type of sends to return + Default: `all` + Members + `all` + `send` + `attach` + `move` + `detach` + cursor (int, optional) - The last index of the sends to return + Default: `null` + limit: `5` (int, optional) - The maximum number of sends to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` ### Get Valid Destructions By Address [GET /v2/addresses/{address}/destructions{?cursor,limit,offset,verbose}] Returns the destructions of a block + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + cursor (int, optional) - The last index of the destructions to return + Default: `null` + limit: `5` (int, optional) - The maximum number of destructions to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 14, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000118", "block_index": 121, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "FAIRMINTB", "quantity": 300000000, "tag": "soft cap not reached", "status": "valid", "block_time": 1768315695, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "3.00000000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Dispensers By Address [GET /v2/addresses/{address}/dispensers{?status,exclude_with_oracle,cursor,limit,offset,sort,verbose}] Returns the dispensers of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + status (enum[str], optional) - The status of the dispensers to return + Default: `all` + Members + `all` + `open` + `closed` + `closing` + `open_empty_address` + exclude_with_oracle (bool, optional) - Whether to exclude dispensers with an oracle + Default: `null` + cursor (int, optional) - The last index of the dispensers to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispensers to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + sort: `give_quantity:desc` (str, optional) - The sort order of the dispensers to return (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 26, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "price": 1.0, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "block_time": 1768315739, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001", "price_normalized": "1.0000000000000000" }, { "tx_index": 68, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000060", "block_index": 194, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "TESTLOCKDESC", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 0, "give_remaining": 6000, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 1, "last_status_tx_source": null, "close_block_index": null, "price": 1.0, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "block_time": 1768315972, "asset_info": { "asset_longname": null, "description": "Test Locking Description", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00006000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001", "price_normalized": "1.0000000000000000" } ], "next_cursor": null, "result_count": 2 } ``` ### Get Dispenser By Address And Asset [GET /v2/addresses/{address}/dispensers/{asset}{?verbose}] Returns the dispenser of an address and an asset + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + asset: `XCP` (str, required) - The asset to return + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "tx_index": 26, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "XCP", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "price": 1.0, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "block_time": 1768315739, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001", "price_normalized": "1.0000000000000000" } } ``` ### Get Dispenses By Source [GET /v2/addresses/{address}/dispenses/sends{?cursor,limit,offset,verbose}] Returns the dispenses of a source + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + cursor (int, optional) - The last index of the dispenses to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispenses to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 69, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000ee", "block_index": 194, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "TESTLOCKDESC", "dispense_quantity": 4000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000060", "btc_amount": 4000, "dispenser": { "tx_index": 68, "block_index": 194, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 0, "give_remaining": 6000, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 1, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00006000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315972, "asset_info": { "asset_longname": null, "description": "Test Locking Description", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "dispense_quantity_normalized": "0.00004000", "btc_amount_normalized": "0.00004000" }, { "tx_index": 28, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000dc", "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 4000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 4000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315739, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00004000", "btc_amount_normalized": "0.00004000" }, { "tx_index": 27, "dispense_index": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000090", "block_index": 131, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 6000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 6000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315735, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00006000", "btc_amount_normalized": "0.00006000" } ], "next_cursor": null, "result_count": 3 } ``` ### Get Dispenses By Destination [GET /v2/addresses/{address}/dispenses/receives{?cursor,limit,offset,verbose}] Returns the dispenses of a destination + Parameters + address: `bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - The address to return + cursor (int, optional) - The last index of the dispenses to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispenses to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 115, "dispense_index": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 3000, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "btc_amount": 3000, "dispenser": { "tx_index": 114, "block_index": 237, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "give_quantity": 1, "escrow_quantity": 5000, "satoshirate": 1, "status": 0, "give_remaining": 2000, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "dispense_count": 1, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00002000", "escrow_quantity_normalized": "0.00005000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768316161, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00003000", "btc_amount_normalized": "0.00003000" }, { "tx_index": 69, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000ee", "block_index": 194, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "TESTLOCKDESC", "dispense_quantity": 4000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000060", "btc_amount": 4000, "dispenser": { "tx_index": 68, "block_index": 194, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 0, "give_remaining": 6000, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 1, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00006000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315972, "asset_info": { "asset_longname": null, "description": "Test Locking Description", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "dispense_quantity_normalized": "0.00004000", "btc_amount_normalized": "0.00004000" }, { "tx_index": 28, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000dc", "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 4000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 4000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315739, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00004000", "btc_amount_normalized": "0.00004000" }, { "tx_index": 27, "dispense_index": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000090", "block_index": 131, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 6000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 6000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315735, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00006000", "btc_amount_normalized": "0.00006000" } ], "next_cursor": null, "result_count": 4 } ``` ### Get Dispenses By Source And Asset [GET /v2/addresses/{address}/dispenses/sends/{asset}{?cursor,limit,offset,verbose}] Returns the dispenses of an address and an asset + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + asset: `XCP` (str, required) - The asset to return + cursor (int, optional) - The last index of the dispenses to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispenses to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 28, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000dc", "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 4000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 4000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315739, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00004000", "btc_amount_normalized": "0.00004000" }, { "tx_index": 27, "dispense_index": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000090", "block_index": 131, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 6000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 6000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315735, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00006000", "btc_amount_normalized": "0.00006000" } ], "next_cursor": null, "result_count": 2 } ``` ### Get Dispenses By Destination And Asset [GET /v2/addresses/{address}/dispenses/receives/{asset}{?cursor,limit,offset,verbose}] Returns the dispenses of an address and an asset + Parameters + address: `bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - The address to return + asset: `XCP` (str, required) - The asset to return + cursor (int, optional) - The last index of the dispenses to return + Default: `null` + limit: `5` (int, optional) - The maximum number of dispenses to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 115, "dispense_index": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000051", "block_index": 237, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 3000, "dispenser_tx_hash": "00000000000000000000000000000000000000000000000000000000000000a5", "btc_amount": 3000, "dispenser": { "tx_index": 114, "block_index": 237, "source": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "give_quantity": 1, "escrow_quantity": 5000, "satoshirate": 1, "status": 0, "give_remaining": 2000, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1qr7pv9cxqadaa6vmvx8fa4fldqufgyagta4ju0k", "dispense_count": 1, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00002000", "escrow_quantity_normalized": "0.00005000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768316161, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00003000", "btc_amount_normalized": "0.00003000" }, { "tx_index": 28, "dispense_index": 0, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000dc", "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 4000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 4000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315739, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00004000", "btc_amount_normalized": "0.00004000" }, { "tx_index": 27, "dispense_index": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000090", "block_index": 131, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "asset": "XCP", "dispense_quantity": 6000, "dispenser_tx_hash": "0000000000000000000000000000000000000000000000000000000000000114", "btc_amount": 6000, "dispenser": { "tx_index": 26, "block_index": 132, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_quantity": 1, "escrow_quantity": 10000, "satoshirate": 1, "status": 10, "give_remaining": 0, "oracle_address": null, "last_status_tx_hash": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "dispense_count": 2, "last_status_tx_source": null, "close_block_index": null, "fiat_price": null, "oracle_price": null, "fiat_unit": null, "oracle_price_last_updated": null, "satoshi_price": 1, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00000000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001", "satoshi_price_normalized": "0.00000001" }, "block_time": 1768315735, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "dispense_quantity_normalized": "0.00006000", "btc_amount_normalized": "0.00006000" } ], "next_cursor": null, "result_count": 3 } ``` ### Get Sweeps By Address [GET /v2/addresses/{address}/sweeps{?cursor,limit,offset,verbose}] Returns the sweeps of an address + Parameters + address: `bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh` (str, required) - The address to return + cursor (int, optional) - The last index of the sweeps to return + Default: `null` + limit: `5` (int, optional) - The maximum number of sweeps to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 65, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009e", "block_index": 190, "source": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "flags": 1, "status": "valid", "memo": "sweep my assets", "fee_paid": 600000, "block_time": 1768315955, "fee_paid_normalized": "0.00600000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Issuances By Address [GET /v2/addresses/{address}/issuances{?asset_events,cursor,limit,offset,verbose}] Returns the issuances of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + asset_events (enum[str], optional) - Filter result by one or several comma separated asset events + Default: `all` + Members + `all` + `creation` + `reissuance` + `lock_quantity` + `reset` + `change_description` + `transfer` + `open_fairminter` + `fairmint` + `lock_description` + cursor (int, optional) - The last index of the issuances to return + Default: `null` + limit: `5` (int, optional) - The maximum number of issuances to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 76, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010e", "msg_index": 0, "block_index": 200, "asset": "MPMASSET", "quantity": 100000000000, "divisible": true, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "transfer": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "My super asset B", "fee_paid": 50000000, "status": "valid", "asset_longname": null, "description_locked": false, "fair_minting": false, "asset_events": "creation", "locked": false, "reset": false, "mime_type": "text/plain", "block_time": 1768315998, "quantity_normalized": "1000.00000000", "fee_paid_normalized": "0.50000000" }, { "tx_index": 52, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000cf", "msg_index": 0, "block_index": 156, "asset": "A95428956980101314", "quantity": 100000000000, "divisible": true, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "transfer": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "A subnumeric asset", "fee_paid": 0, "status": "valid", "asset_longname": "A95428959745315388.SUBNUMERIC", "description_locked": false, "fair_minting": false, "asset_events": "creation", "locked": false, "reset": false, "mime_type": "text/plain", "block_time": 1768315837, "quantity_normalized": "1000.00000000", "fee_paid_normalized": "0.00000000" }, { "tx_index": 51, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000096", "msg_index": 0, "block_index": 155, "asset": "TESTLOCKDESC", "quantity": 0, "divisible": true, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "transfer": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "Test Locking Description", "fee_paid": 0, "status": "valid", "asset_longname": null, "description_locked": true, "fair_minting": false, "asset_events": "lock_description", "locked": false, "reset": false, "mime_type": "text/plain", "block_time": 1768315833, "quantity_normalized": "0.00000000", "fee_paid_normalized": "0.00000000" }, { "tx_index": 50, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000112", "msg_index": 0, "block_index": 154, "asset": "A95428959745315388", "quantity": 0, "divisible": true, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "transfer": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "Test Locking Description", "fee_paid": 0, "status": "valid", "asset_longname": "TESTLOCKDESC.MYSUBASSET", "description_locked": false, "fair_minting": false, "asset_events": "creation", "locked": false, "reset": false, "mime_type": "text/plain", "block_time": 1768315829, "quantity_normalized": "0.00000000", "fee_paid_normalized": "0.00000000" }, { "tx_index": 49, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000045", "msg_index": 0, "block_index": 153, "asset": "TESTLOCKDESC", "quantity": 10000000000, "divisible": true, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "transfer": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "Test Locking Description", "fee_paid": 50000000, "status": "valid", "asset_longname": null, "description_locked": false, "fair_minting": false, "asset_events": "creation", "locked": false, "reset": false, "mime_type": "text/plain", "block_time": 1768315825, "quantity_normalized": "100.00000000", "fee_paid_normalized": "0.50000000" } ], "next_cursor": 20, "result_count": 25 } ``` ### Get Valid Assets By Issuer Or Owner [GET /v2/addresses/{address}/assets{?named,cursor,limit,offset,verbose}] Returns the valid assets issued or owned by an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The issuer or owner to return + named: `true` (bool, optional) - Whether to return only named assets + Default: `null` + cursor (int, optional) - The last index of the assets to return + Default: `null` + limit: `5` (int, optional) - The maximum number of assets to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "asset": "MPMASSET", "asset_id": "101158363923", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 100000000000, "description": "My super asset B", "description_locked": false, "first_issuance_block_index": 200, "last_issuance_block_index": 200, "mime_type": "text/plain", "first_issuance_block_time": 1768315998, "last_issuance_block_time": 1768315998, "supply_normalized": "1000.00000000" }, { "asset": "TESTLOCKDESC", "asset_id": "70403005118950974", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 10000000000, "description": "Test Locking Description", "description_locked": false, "first_issuance_block_index": 153, "last_issuance_block_index": 155, "mime_type": "text/plain", "first_issuance_block_time": 1768315825, "last_issuance_block_time": 1768315833, "supply_normalized": "100.00000000" }, { "asset": "FREEFAIRMINT", "asset_id": "20774156646107637", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 180, "description": "", "description_locked": false, "first_issuance_block_index": 148, "last_issuance_block_index": 150, "mime_type": "text/plain", "first_issuance_block_time": 1768315803, "last_issuance_block_time": 1768315811, "supply_normalized": "0.00000180" }, { "asset": "MYASSETA", "asset_id": "103804245870", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 100000000000, "description": "My super asset A", "description_locked": false, "first_issuance_block_index": 139, "last_issuance_block_index": 139, "mime_type": "text/plain", "first_issuance_block_time": 1768315766, "last_issuance_block_time": 1768315766, "supply_normalized": "1000.00000000" }, { "asset": "FAIRMINTD", "asset_id": "1046814266085", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 40, "description": "", "description_locked": false, "first_issuance_block_index": 126, "last_issuance_block_index": 127, "mime_type": "text/plain", "first_issuance_block_time": 1768315716, "last_issuance_block_time": 1768315719, "supply_normalized": "0.00000040" } ], "next_cursor": 4, "result_count": 8 } ``` ### Get Valid Assets By Issuer [GET /v2/addresses/{address}/assets/issued{?named,cursor,limit,offset,verbose}] Returns the valid assets issued by an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The issuer to return + named: `true` (bool, optional) - Whether to return only named assets + Default: `null` + cursor (int, optional) - The last index of the assets to return + Default: `null` + limit: `5` (int, optional) - The maximum number of assets to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "asset": "MPMASSET", "asset_id": "101158363923", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 100000000000, "description": "My super asset B", "description_locked": false, "first_issuance_block_index": 200, "last_issuance_block_index": 200, "mime_type": "text/plain", "first_issuance_block_time": 1768315998, "last_issuance_block_time": 1768315998, "supply_normalized": "1000.00000000" }, { "asset": "TESTLOCKDESC", "asset_id": "70403005118950974", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 10000000000, "description": "Test Locking Description", "description_locked": false, "first_issuance_block_index": 153, "last_issuance_block_index": 155, "mime_type": "text/plain", "first_issuance_block_time": 1768315825, "last_issuance_block_time": 1768315833, "supply_normalized": "100.00000000" }, { "asset": "FREEFAIRMINT", "asset_id": "20774156646107637", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 180, "description": "", "description_locked": false, "first_issuance_block_index": 148, "last_issuance_block_index": 150, "mime_type": "text/plain", "first_issuance_block_time": 1768315803, "last_issuance_block_time": 1768315811, "supply_normalized": "0.00000180" }, { "asset": "MYASSETA", "asset_id": "103804245870", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 100000000000, "description": "My super asset A", "description_locked": false, "first_issuance_block_index": 139, "last_issuance_block_index": 139, "mime_type": "text/plain", "first_issuance_block_time": 1768315766, "last_issuance_block_time": 1768315766, "supply_normalized": "1000.00000000" }, { "asset": "FAIRMINTD", "asset_id": "1046814266085", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 40, "description": "", "description_locked": false, "first_issuance_block_index": 126, "last_issuance_block_index": 127, "mime_type": "text/plain", "first_issuance_block_time": 1768315716, "last_issuance_block_time": 1768315719, "supply_normalized": "0.00000040" } ], "next_cursor": 4, "result_count": 8 } ``` ### Get Valid Assets By Owner [GET /v2/addresses/{address}/assets/owned{?named,cursor,limit,offset,verbose}] Returns the valid assets owned by an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The owner to return + named: `true` (bool, optional) - Whether to return only named assets + Default: `null` + cursor (int, optional) - The last index of the assets to return + Default: `null` + limit: `5` (int, optional) - The maximum number of assets to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "asset": "MPMASSET", "asset_id": "101158363923", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 100000000000, "description": "My super asset B", "description_locked": false, "first_issuance_block_index": 200, "last_issuance_block_index": 200, "mime_type": "text/plain", "first_issuance_block_time": 1768315998, "last_issuance_block_time": 1768315998, "supply_normalized": "1000.00000000" }, { "asset": "TESTLOCKDESC", "asset_id": "70403005118950974", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 10000000000, "description": "Test Locking Description", "description_locked": false, "first_issuance_block_index": 153, "last_issuance_block_index": 155, "mime_type": "text/plain", "first_issuance_block_time": 1768315825, "last_issuance_block_time": 1768315833, "supply_normalized": "100.00000000" }, { "asset": "FREEFAIRMINT", "asset_id": "20774156646107637", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 180, "description": "", "description_locked": false, "first_issuance_block_index": 148, "last_issuance_block_index": 150, "mime_type": "text/plain", "first_issuance_block_time": 1768315803, "last_issuance_block_time": 1768315811, "supply_normalized": "0.00000180" }, { "asset": "MYASSETA", "asset_id": "103804245870", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 100000000000, "description": "My super asset A", "description_locked": false, "first_issuance_block_index": 139, "last_issuance_block_index": 139, "mime_type": "text/plain", "first_issuance_block_time": 1768315766, "last_issuance_block_time": 1768315766, "supply_normalized": "1000.00000000" }, { "asset": "FAIRMINTD", "asset_id": "1046814266085", "asset_longname": null, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "supply": 40, "description": "", "description_locked": false, "first_issuance_block_index": 126, "last_issuance_block_index": 127, "mime_type": "text/plain", "first_issuance_block_time": 1768315716, "last_issuance_block_time": 1768315719, "supply_normalized": "0.00000040" } ], "next_cursor": 4, "result_count": 8 } ``` ### Get Transactions By Address [GET /v2/addresses/{address}/transactions{?type,show_unconfirmed,valid,cursor,limit,offset,verbose}] Returns the transactions of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + type (enum[str], optional) - The type of the transaction to return + Default: `all` + Members + `all` + `bet` + `broadcast` + `btcpay` + `cancel` + `destroy` + `dispenser` + `dispense` + `dividend` + `issuance` + `order` + `send` + `enhanced_send` + `mpma` + `rps` + `rpsresolve` + `sweep` + `fairminter` + `fairmint` + `attach` + `detach` + `utxomove` + `unknown` + show_unconfirmed (bool, optional) - Show unconfirmed transactions + Default: `null` + valid (bool, optional) - If True, only return valid transactions + Default: `null` + cursor: `121` (int, optional) - The last transaction index to return + Default: `null` + limit: `5` (int, optional) - The maximum number of transactions to return + Default: `10` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 79, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_hash": "0000000000000000000000000000000000000000000000000000000000000066", "block_time": 1768316011, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e60a856d656d6f3380000000000000008000000000000000542b6b2b6b7988", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000023:0 4 ", "transaction_type": "mpma", "valid": 1, "events": [ { "event_index": 678, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 203, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "memo2", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_time": 1768316011 }, { "event_index": 679, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 203, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "memo3", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_time": 1768316011 }, { "event_index": 680, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 203, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": "memo1", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "tx_index": 79, "block_time": 1768316011, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000023", "block_index": 203, "block_time": 1768316011 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "memo2", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "quantity": 10, "memo": "memo1", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 78, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_hash": "0000000000000000000000000000000000000000000000000000000000000034", "block_time": 1768316006, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001c000000000000000000000000000000000000000000000000000000000000011b00000000000000000000000000000000000000000000000000000000000000e70000000a4000000000000000400000000000000028", "supported": true, "utxos_info": " 000000000000000000000000000000000000000000000000000000000000009f:0 4 ", "transaction_type": "mpma", "valid": 1, "events": [ { "event_index": 658, "event": "ORDER_UPDATE", "params": { "status": "expired", "tx_hash": "0000000000000000000000000000000000000000000000000000000000000088" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 660, "event": "ORDER_EXPIRATION", "params": { "block_index": 202, "order_hash": "0000000000000000000000000000000000000000000000000000000000000088", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "block_time": 1768316006 }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 666, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 202, "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "memo": "the memo", "msg_index": 0, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 667, "event": "MPMA_SEND", "params": { "asset": "MPMASSET", "block_index": 202, "destination": "bc1qcukg73tnxcvsgrpcuzpvpx3truclldqllwc8xc", "memo": "the memo", "msg_index": 1, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 }, { "event_index": 668, "event": "MPMA_SEND", "params": { "asset": "XCP", "block_index": 202, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": "the memo", "msg_index": 2, "quantity": 10, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "tx_index": 78, "block_time": 1768316006, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000009f", "block_index": 202, "block_time": 1768316006 } ], "unpacked_data": { "message_type": "mpma_send", "message_type_id": 3, "message_data": [ { "asset": "MPMASSET", "destination": "bc1q5x82hes0kjz0dnksd5t00yx5lndddpn38jywyh", "quantity": 10, "memo": "the memo", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00000010" }, { "asset": "XCP", "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "quantity": 10, "memo": "the memo", "memo_is_hex": false, "asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_normalized": "0.00000010" } ] }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 77, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "block_index": 201, "block_hash": "0000000000000000000000000000000000000000000000000000000000000091", "block_time": 1768316002, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000001af50d80b8cc40", "supported": true, "utxos_info": " 00000000000000000000000000000000000000000000000000000000000000f6:1 2 0", "transaction_type": "enhanced_send", "valid": 1, "events": [ { "event_index": 653, "event": "ENHANCED_SEND", "params": { "asset": "MPMASSET", "block_index": 201, "destination": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": null, "msg_index": 0, "quantity": 1000, "send_type": "send", "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "tx_index": 77, "block_time": 1768316002, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00001000" }, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f6", "block_index": 201, "block_time": 1768316002 } ], "unpacked_data": { "message_type": "enhanced_send", "message_type_id": 2, "message_data": { "asset": "MPMASSET", "quantity": 1000, "address": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "memo": null, "asset_info": { "asset_longname": null, "description": "My super asset B", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "quantity_normalized": "0.00001000" } }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 76, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010e", "block_index": 200, "block_hash": "000000000000000000000000000000000000000000000000000000000000004b", "block_time": 1768315998, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000003c722061737365742042", "supported": true, "utxos_info": " 000000000000000000000000000000000000000000000000000000000000010e:1 2 0", "transaction_type": "issuance", "valid": 1, "events": [ { "event_index": 644, "event": "ASSET_CREATION", "params": { "asset_id": "101158363923", "asset_longname": null, "asset_name": "MPMASSET", "block_index": 200, "block_time": 1768315998 }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010e", "block_index": 200, "block_time": 1768315998 }, { "event_index": 645, "event": "ASSET_ISSUANCE", "params": { "asset": "MPMASSET", "asset_events": "creation", "asset_longname": null, "block_index": 200, "call_date": 0, "call_price": 0.0, "callable": false, "description": "My super asset B", "description_locked": false, "divisible": true, "fee_paid": 50000000, "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "locked": false, "mime_type": "text/plain", "msg_index": 0, "quantity": 100000000000, "reset": false, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": "valid", "transfer": false, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010e", "tx_index": 76, "block_time": 1768315998, "quantity_normalized": "1000.00000000", "fee_paid_normalized": "0.50000000" }, "tx_hash": "000000000000000000000000000000000000000000000000000000000000010e", "block_index": 200, "block_time": 1768315998 } ], "unpacked_data": { "message_type": "issuance", "message_type_id": 22, "message_data": { "asset_id": 101158363923, "asset": "MPMASSET", "subasset_longname": null, "quantity": 100000000000, "divisible": true, "lock": false, "reset": false, "callable": false, "call_date": 0, "call_price": 0.0, "description": "My super asset B", "mime_type": "text/plain", "status": "valid", "quantity_normalized": "1000.00000000" } }, "btc_amount_normalized": "0.00000000" }, { "tx_index": 68, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000060", "block_index": 193, "block_hash": "0000000000000000000000000000000000000000000000000000000000000027", "block_time": 1768315968, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "destination": null, "btc_amount": 0, "fee": 10000, "data": "000000000000000000000000000000000000000000000000000000000000002c0100", "supported": true, "utxos_info": " 0000000000000000000000000000000000000000000000000000000000000060:1 2 0", "transaction_type": "dispenser", "valid": 1, "events": [ { "event_index": 587, "event": "OPEN_DISPENSER", "params": { "asset": "TESTLOCKDESC", "block_index": 193, "dispense_count": 0, "escrow_quantity": 10000, "give_quantity": 1, "give_remaining": 10000, "oracle_address": null, "origin": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "satoshirate": 1, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "status": 0, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000060", "tx_index": 68, "block_time": 1768315968, "asset_info": { "asset_longname": null, "description": "Test Locking Description", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "give_quantity_normalized": "0.00000001", "give_remaining_normalized": "0.00010000", "escrow_quantity_normalized": "0.00010000", "satoshirate_normalized": "0.00000001" }, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000060", "block_index": 193, "block_time": 1768315968 } ], "unpacked_data": { "message_type": "dispenser", "message_type_id": 12, "message_data": { "asset": "TESTLOCKDESC", "give_quantity": 1, "escrow_quantity": 10000, "mainchainrate": 1, "dispenser_status": 0, "action_address": null, "oracle_address": null, "status": "valid", "asset_info": { "asset_longname": null, "description": "Test Locking Description", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "give_quantity_normalized": "0.00000001", "escrow_quantity_normalized": "0.00010000" } }, "btc_amount_normalized": "0.00000000" } ], "next_cursor": 67, "result_count": 32 } ``` ### Get Transaction Types Count By Address [GET /v2/addresses/{address}/transactions/counts{?count_unconfirmed,verbose}] Returns the count of each transaction type + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + count_unconfirmed (bool, optional) - Count unconfirmed transactions + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "transaction_type": "issuance", "count": 6 }, { "transaction_type": "fairminter", "count": 6 }, { "transaction_type": "dispenser", "count": 6 }, { "transaction_type": "order", "count": 4 }, { "transaction_type": "mpma", "count": 3 }, { "transaction_type": "attach", "count": 2 }, { "transaction_type": "enhanced_send", "count": 1 }, { "transaction_type": "dividend", "count": 1 }, { "transaction_type": "cancel", "count": 1 }, { "transaction_type": "burn", "count": 1 }, { "transaction_type": "broadcast", "count": 1 } ], "next_cursor": null, "result_count": 11 } ``` ### Get Dividends Distributed By Address [GET /v2/addresses/{address}/dividends{?cursor,limit,offset,verbose}] Returns the dividends distributed by an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + cursor (int, optional) - The last index of the assets to return + Default: `null` + limit: `5` (int, optional) - The maximum number of assets to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 42, "tx_hash": "000000000000000000000000000000000000000000000000000000000000004d", "block_index": 146, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "MYASSETA", "dividend_asset": "XCP", "quantity_per_unit": 100000000, "fee_paid": 20000, "status": "valid", "block_time": 1768315794, "asset_info": { "asset_longname": null, "description": "My super asset A", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "dividend_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "quantity_per_unit_normalized": "1.00000000", "fee_paid_normalized": "0.00020000" } ], "next_cursor": null, "result_count": 1 } ``` ### Get Orders By Address [GET /v2/addresses/{address}/orders{?status,cursor,limit,offset,sort,verbose}] Returns the orders of an address + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address to return + status (enum[str], optional) - The status of the orders to return + Default: `all` + Members + `all` + `open` + `expired` + `filled` + `cancelled` + cursor (int, optional) - The last index of the orders to return + Default: `null` + limit: `5` (int, optional) - The maximum number of orders to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + sort: `expiration:desc` (str, optional) - The sort order of the orders to return (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_index": 64, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000c2", "block_index": 211, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_asset": "XCP", "give_quantity": 1000, "give_remaining": 0, "get_asset": "BTC", "get_quantity": 1000, "get_remaining": 0, "expiration": 21, "expire_index": 210, "fee_required": 0, "fee_required_remaining": 0, "fee_provided": 10000, "fee_provided_remaining": 10000, "status": "expired", "get_asset_divisible": false, "give_asset_divisible": true, "give_price": 1.0, "get_price": 1.0, "block_time": 1768316043, "give_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "get_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "give_quantity_normalized": "0.00001000", "get_quantity_normalized": "0.00001000", "get_remaining_normalized": "0.00000000", "give_remaining_normalized": "0.00000000", "fee_provided_normalized": "0.00010000", "fee_required_normalized": "0.00000000", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000", "give_price_normalized": "1.0000000000000000", "get_price_normalized": "1.0000000000000000" }, { "tx_index": 62, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000046", "block_index": 188, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_asset": "XCP", "give_quantity": 1000, "give_remaining": 1000, "get_asset": "BTC", "get_quantity": 1000, "get_remaining": 1000, "expiration": 21, "expire_index": 208, "fee_required": 0, "fee_required_remaining": 0, "fee_provided": 10000, "fee_provided_remaining": 10000, "status": "cancelled", "get_asset_divisible": false, "give_asset_divisible": true, "give_price": 1.0, "get_price": 1.0, "block_time": 1768315947, "give_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "get_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "give_quantity_normalized": "0.00001000", "get_quantity_normalized": "0.00001000", "get_remaining_normalized": "0.00001000", "give_remaining_normalized": "0.00001000", "fee_provided_normalized": "0.00010000", "fee_required_normalized": "0.00000000", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000", "give_price_normalized": "1.0000000000000000", "get_price_normalized": "1.0000000000000000" }, { "tx_index": 55, "tx_hash": "0000000000000000000000000000000000000000000000000000000000000088", "block_index": 202, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_asset": "XCP", "give_quantity": 10000, "give_remaining": 5000, "get_asset": "BTC", "get_quantity": 10000, "get_remaining": 5000, "expiration": 21, "expire_index": 201, "fee_required": 0, "fee_required_remaining": 0, "fee_provided": 10000, "fee_provided_remaining": 10000, "status": "expired", "get_asset_divisible": false, "give_asset_divisible": true, "give_price": 1.0, "get_price": 1.0, "block_time": 1768316006, "give_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "get_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "give_quantity_normalized": "0.00010000", "get_quantity_normalized": "0.00010000", "get_remaining_normalized": "0.00005000", "give_remaining_normalized": "0.00005000", "fee_provided_normalized": "0.00010000", "fee_required_normalized": "0.00000000", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000", "give_price_normalized": "1.0000000000000000", "get_price_normalized": "1.0000000000000000" }, { "tx_index": 53, "tx_hash": "00000000000000000000000000000000000000000000000000000000000000d6", "block_index": 179, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "give_asset": "XCP", "give_quantity": 1000, "give_remaining": 1000, "get_asset": "BTC", "get_quantity": 1000, "get_remaining": 1000, "expiration": 21, "expire_index": 178, "fee_required": 0, "fee_required_remaining": 0, "fee_provided": 10000, "fee_provided_remaining": 10000, "status": "expired", "get_asset_divisible": false, "give_asset_divisible": true, "give_price": 1.0, "get_price": 1.0, "block_time": 1768315852, "give_asset_info": { "asset_longname": null, "description": "The Counterparty protocol native currency", "issuer": null, "divisible": true, "locked": true, "owner": null }, "get_asset_info": { "divisible": true, "asset_longname": null, "description": "The Bitcoin cryptocurrency", "locked": false, "issuer": null }, "give_quantity_normalized": "0.00001000", "get_quantity_normalized": "0.00001000", "get_remaining_normalized": "0.00001000", "give_remaining_normalized": "0.00001000", "fee_provided_normalized": "0.00010000", "fee_required_normalized": "0.00000000", "fee_required_remaining_normalized": "0.00000000", "fee_provided_remaining_normalized": "0.00010000", "give_price_normalized": "1.0000000000000000", "get_price_normalized": "1.0000000000000000" } ], "next_cursor": null, "result_count": 4 } ``` ### Get Fairminters By Address [GET /v2/addresses/{address}/fairminters{?status,cursor,limit,offset,verbose}] Returns the fairminter by its source + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The source of the fairminter to return + status (enum[str], optional) - The status of the fairminters to return + Default: `all` + Members + `all` + `open` + `closed` + `pending` + cursor (int, optional) - + Default: `null` + limit (int, optional) - + Default: `100` + offset (int, optional) - + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000064", "tx_index": 44, "block_index": 150, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "FREEFAIRMINT", "asset_parent": null, "asset_longname": null, "description": "", "price": 0, "quantity_by_price": 1, "hard_cap": 180, "burn_payment": false, "max_mint_per_tx": 100, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "closed", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": 180, "paid_quantity": 0, "commission": 0, "block_time": 1768315811, "price_normalized": "0.0000000000000000", "hard_cap_normalized": "0.00000180", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000100", "premint_quantity_normalized": "0.00000000", "earned_quantity_normalized": "0.00000180", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000000" }, { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f1", "tx_index": 43, "block_index": 147, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "A95428958968845068", "asset_parent": "MYASSETA", "asset_longname": "MYASSETA.SUBMYASSETA", "description": "", "price": 1, "quantity_by_price": 5, "hard_cap": 0, "burn_payment": false, "max_mint_per_tx": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "open", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": null, "paid_quantity": null, "commission": null, "block_time": 1768315799, "price_normalized": "0.2000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000005", "max_mint_per_tx_normalized": "0.00000000", "premint_quantity_normalized": "0.00000000" }, { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000e2", "tx_index": 22, "block_index": 126, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "FAIRMINTD", "asset_parent": null, "asset_longname": null, "description": "", "price": 50, "quantity_by_price": 60, "hard_cap": 0, "burn_payment": false, "max_mint_per_tx": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "open", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": 40, "paid_quantity": 34, "commission": 0, "block_time": 1768315716, "price_normalized": "0.8333333333333333", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000060", "max_mint_per_tx_normalized": "0.00000000", "premint_quantity_normalized": "0.00000000", "earned_quantity_normalized": "0.00000040", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000034" }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000069", "tx_index": 18, "block_index": 122, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "FAIRMINTC", "asset_parent": null, "asset_longname": null, "description": "", "price": 1, "quantity_by_price": 5, "hard_cap": 0, "burn_payment": false, "max_mint_per_tx": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 0, "soft_cap_deadline_block": 0, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "open", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": 19, "paid_quantity": 5, "commission": 0, "block_time": 1768315699, "price_normalized": "0.2000000000000000", "hard_cap_normalized": "0.00000000", "soft_cap_normalized": "0.00000000", "quantity_by_price_normalized": "0.00000005", "max_mint_per_tx_normalized": "0.00000000", "premint_quantity_normalized": "0.00000000", "earned_quantity_normalized": "0.00000019", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000005" }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000118", "tx_index": 14, "block_index": 121, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "FAIRMINTB", "asset_parent": null, "asset_longname": null, "description": "", "price": 1, "quantity_by_price": 1, "hard_cap": 10000000000, "burn_payment": false, "max_mint_per_tx": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 1000000000, "soft_cap_deadline_block": 121, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "closed", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": 300000000, "paid_quantity": 300000000, "commission": 0, "block_time": 1768315695, "price_normalized": "1.0000000000000000", "hard_cap_normalized": "100.00000000", "soft_cap_normalized": "10.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000000", "premint_quantity_normalized": "0.00000000", "earned_quantity_normalized": "3.00000000", "commission_normalized": "0.00000000", "paid_quantity_normalized": "3.00000000" }, { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000eb", "tx_index": 10, "block_index": 116, "source": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "asset": "FAIRMINTA", "asset_parent": null, "asset_longname": null, "description": "", "price": 1, "quantity_by_price": 1, "hard_cap": 10000000000, "burn_payment": false, "max_mint_per_tx": 0, "premint_quantity": 0, "start_block": 0, "end_block": 0, "minted_asset_commission_int": 0, "soft_cap": 1000000000, "soft_cap_deadline_block": 115, "lock_description": false, "lock_quantity": false, "divisible": true, "pre_minted": false, "status": "closed", "max_mint_per_address": 0, "mime_type": "text/plain", "earned_quantity": 10000000000, "paid_quantity": 10000000000, "commission": 0, "block_time": 1768315676, "price_normalized": "1.0000000000000000", "hard_cap_normalized": "100.00000000", "soft_cap_normalized": "10.00000000", "quantity_by_price_normalized": "0.00000001", "max_mint_per_tx_normalized": "0.00000000", "premint_quantity_normalized": "0.00000000", "earned_quantity_normalized": "100.00000000", "commission_normalized": "0.00000000", "paid_quantity_normalized": "100.00000000" } ], "next_cursor": null, "result_count": 6 } ``` ### Get Fairmints By Address [GET /v2/addresses/{address}/fairmints{?cursor,limit,offset,verbose}] Returns the mints by address + Parameters + address: `bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - The address of the mints to return + cursor (int, optional) - + Default: `null` + limit (int, optional) - + Default: `100` + offset (int, optional) - + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000be", "tx_index": 46, "block_index": 150, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "0000000000000000000000000000000000000000000000000000000000000064", "asset": "FREEFAIRMINT", "earn_quantity": 80, "paid_quantity": 0, "commission": 0, "status": "valid", "block_time": 1768315811, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "0.00000080", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000000" }, { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000b6", "tx_index": 45, "block_index": 149, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "0000000000000000000000000000000000000000000000000000000000000064", "asset": "FREEFAIRMINT", "earn_quantity": 100, "paid_quantity": 0, "commission": 0, "status": "valid", "block_time": 1768315807, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "0.00000100", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000000" }, { "tx_hash": "000000000000000000000000000000000000000000000000000000000000008a", "tx_index": 23, "block_index": 127, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "00000000000000000000000000000000000000000000000000000000000000e2", "asset": "FAIRMINTD", "earn_quantity": 40, "paid_quantity": 34, "commission": 0, "status": "valid", "block_time": 1768315719, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "0.00000040", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000034" }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000048", "tx_index": 21, "block_index": 125, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "0000000000000000000000000000000000000000000000000000000000000069", "asset": "FAIRMINTC", "earn_quantity": 11, "paid_quantity": 3, "commission": 0, "status": "valid", "block_time": 1768315712, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "0.00000011", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000003" }, { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000e1", "tx_index": 20, "block_index": 124, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "0000000000000000000000000000000000000000000000000000000000000069", "asset": "FAIRMINTC", "earn_quantity": 3, "paid_quantity": 1, "commission": 0, "status": "valid", "block_time": 1768315708, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "0.00000003", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000001" }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000025", "tx_index": 19, "block_index": 123, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "0000000000000000000000000000000000000000000000000000000000000069", "asset": "FAIRMINTC", "earn_quantity": 5, "paid_quantity": 1, "commission": 0, "status": "valid", "block_time": 1768315704, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "0.00000005", "commission_normalized": "0.00000000", "paid_quantity_normalized": "0.00000001" }, { "tx_hash": "00000000000000000000000000000000000000000000000000000000000000f4", "tx_index": 15, "block_index": 118, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "0000000000000000000000000000000000000000000000000000000000000118", "asset": "FAIRMINTB", "earn_quantity": 100000000, "paid_quantity": 100000000, "commission": 0, "status": "valid", "block_time": 1768315685, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "1.00000000", "commission_normalized": "0.00000000", "paid_quantity_normalized": "1.00000000" }, { "tx_hash": "0000000000000000000000000000000000000000000000000000000000000108", "tx_index": 11, "block_index": 114, "source": "bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3", "fairminter_tx_hash": "00000000000000000000000000000000000000000000000000000000000000eb", "asset": "FAIRMINTA", "earn_quantity": 500000000, "paid_quantity": 500000000, "commission": 0, "status": "valid", "block_time": 1768315668, "asset_info": { "asset_longname": null, "description": "", "issuer": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg", "divisible": true, "locked": false, "owner": "bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg" }, "earn_quantity_normalized": "5.00000000", "commission_normalized": "0.00000000", "paid_quantity_normalized": "5.00000000" } ], "next_cursor": null, "result_count": 8 } ``` ### Get Fairmints By Address And Asset [GET /v2/addresses/{address}/fairmints/{asset}{?cursor,limit,offset,verbose}] Returns the mints by address and asset + Parameters + address: `bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - The address of the mints to return + asset: `BURNER` (str, required) - The asset of the mints to return + cursor (int, optional) - + Default: `null` + limit (int, optional) - + Default: `100` + offset (int, optional) - + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [], "next_cursor": null, "result_count": 0 } ``` ## Group Utxos ### Get Utxo Balances [GET /v2/utxos/{utxo}/balances{?cursor,limit,offset,verbose}] Returns the balances of an utxo + Parameters + utxo: `00000000000000000000000000000000000000000000000000000000000000df:0` (str, required) - The utxo to return + cursor (int, optional) - The last index of the balances to return + Default: `null` + limit: `5` (int, optional) - The maximum number of balances to return + Default: `100` + offset (int, optional) - The number of lines to skip before returning results (overrides the `cursor` parameter) + Default: `null` + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": [ { "asset": "UTXOASSET", "asset_longname": null, "quantity": 1000000000, "utxo": "00000000000000000000000000000000000000000000000000000000000000df:0", "utxo_address": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "asset_info": { "asset_longname": null, "description": "My super asset", "issuer": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu", "divisible": true, "locked": false, "owner": "bc1qp57f8njpjg7rn0jl5u958nl2y5npu04e0unjqu" }, "quantity_normalized": "10.00000000" } ], "next_cursor": null, "result_count": 1 } ``` ### Utxos With Balances [GET /v2/utxos/withbalances{?utxos,verbose}] Check if the utxos have balances + Parameters + utxos: `$UTXO_1,$UTXO_2` (str, required) - Comma separated list of utxos + verbose: `true` (bool, optional) - Include asset and dispenser info and normalized quantities in the response. + Default: `false` + Response 200 (application/json) ``` { "result": { "$UTXO_1": false, "$UTXO_2": false } } ``` ## Group Compose **Notes about fee calculation** To calculate the fees required for a transaction, we do not know the final size of the transaction before signing it. So the composer injects fake script_sig and witnesses into the transaction before calculating the adjusted vsize. Two remarks: 1. this only works for standard scripts 1. the size of DER signatures can vary by a few bytes and it is impossible to predict it. The composer uses a fixed size of 70 bytes so there may be a discrepancy of a few satoshis with the fees requested with `sat_per_vbyte` (for example if a DER signature is 72 bytes with `sat_per_vbyte=2` there will be an error of 4 sats in the calculated fees). **Note about transaction chaining** if you make several transactions in the same block, you need to chain them using `inputs_set=:`; otherwise, you can't guarantee the final order of the transactions. **Deprecated parameters** The following parameters are deprecated in the new composer and will no longer be supported in a future version: - `fee_per_kb`: Use `sat_per_vbyte` instead - `fee_provided`: Ue `max_fee` instead - `unspent_tx_hash`: Use `inputs_set` instead - `dust_return_pubkey`: Use `multisig_pubkey` instead - `return_psbt`: Use `verbose` instead - `regular_dust_size`: Automatically calculated - `multisig_dust_size`: Automatically calculated - `extended_tx_info`: API v1 only, use API v2 instead - `old_style_api`: API v1 only, use API v2 instead - `p2sh_pretx_txid`: Ignored, P2SH disabled - `segwit`: Ignored, Segwit automatically detected ### Compose Bet [GET /v2/addresses/{address}/compose/bet{?feed_address,bet_type,deadline,wager_quantity,counterwager_quantity,expiration,leverage,target_value,encoding,validate,sat_per_vbyte,confirmation_target,exact_fee,max_fee,inputs_set,allow_unconfirmed_inputs,exclude_utxos,use_utxos_with_balances,exclude_utxos_with_balances,disable_utxo_locks,use_all_inputs_set,multisig_pubkey,change_address,more_outputs,pubkeys,verbose,return_only_data,segwit_dust_size,inscription,verbose}] Composes a transaction to issue a bet against a feed. + Parameters + address: `bc1q34ggt2umsh98mfwk5pvwue3h3tk27a3zcg39dg` (str, required) - The address that will make the bet + feed_address: `bc1q3ycntf5zhxxmk0s70kl3xwmn75xcpwxv70q0k3` (str, required) - The address that hosts the feed to be bet on + bet_type: `2` (int, required) - Bet 0 for Bullish CFD (deprecated), 1 for Bearish CFD (deprecated), 2 for Equal, 3 for NotEqual + deadline: `3000000000` (int, required) - The time at which the bet should be decided/settled, in Unix time (seconds since epoch) + wager_quantity: `1000` (int, required) - The quantities of XCP to wager (in satoshis, hence integer) + counterwager_quantity: `1000` (int, required) - The minimum quantities of XCP to be wagered against, for the bets to match (in satoshis, hence integer) + expiration: `100` (int, required) - The number of blocks after which the bet expires if it remains unmatched + leverage (int, optional) - Leverage, as a fraction of 5040 + Default: `5040` + target_value: `1000` (int, optional) - Target value for Equal/NotEqual bet + Default: `null` + encoding (str, optional) - The encoding method to use + Default: `auto` + validate (bool, optional) - Validate the transaction + Default: `True` + sat_per_vbyte (float, optional) - The fee per vbyte in satoshis + Default: `null` + confirmation_target (int, optional) - The number of blocks to target for confirmation + Default: `3` + exact_fee: `0` (int, optional) - The exact fee to use in satoshis + Default: `null` + max_fee (int, optional) - The maximum fee to use in satoshis + Default: `null` + inputs_set (str, optional) - A comma-separated list of UTXOs (`:`) to use as inputs for the transaction being created. To speed up the composition you can also use the following format for utxos: `:::`. + Default: `null` + allow_unconfirmed_inputs (bool, optional) - Set to true to allow this transaction to utilize unconfirmed UTXOs as inputs + Default: `null` + exclude_utxos (str, optional) - A comma-separated list of UTXO txids to exclude when selecting UTXOs to use as inputs for the transaction being created + Default: `null` + use_utxos_with_balances (bool, optional) - Use UTXO with balances + Default: `null` + exclude_utxos_with_balances (bool, optional) - Exclude silently UTXO with balances instead of raising an exception. Important: the `exclude-utxos-with-balances` will not exclude unconfirmed `attach` and `utxomove`. You need to explicitly exclude them with the `exclude-utxos` parameter + Default: `null` + disable_utxo_locks (bool, optional) - By default, UTXOs utilized when creating a transaction are 'locked' for a few seconds, to prevent a case where rapidly generating create- calls reuse UTXOs due to their spent status not being updated in bitcoind yet. Specify true for this parameter to disable this behavior, and not temporarily lock UTXOs + Default: `null` + use_all_inputs_set (bool, optional) - Use all UTXOs provide with `inputs-set` parameter + Default: `null` + multisig_pubkey (str, optional) - The reedem public key to use for multisig encoding, by default it is searched for the source address + Default: `null` + change_address (str, optional) - The address to send the change to + Default: `null` + more_outputs (str, optional) - Additional outputs to include in the transaction in the format `:
` or `: