# Welcome
Welcome to TAAL Docs!!
You can use these docs to learn more about TAAL’s core products, explore guides, and check our API references.
***You can get access to*** [***TAAL PLATFORM***](https://platform.taal.com/) ***and get*** ***.***
## **What is TAAL?**
TAAL delivers value-added blockchain services, providing professional-grade, highly scalable blockchain infrastructure, and transactional solutions to support builders and businesses building on the BitcoinSV protocol.
## **TAAL Services**
### Transaction Processing
As a Transaction processor (or miner) TAAL validates clients transactions and time stamps them by sequencing and encoding them into blocks, which are then published and added to the BSV blockchain.
TAAL API is an easy to integrate, open communication channel to the blockchain. By connecting an application to this endpoint data, in the form of transactions, can be processed, instantly verified, and once settled this data can be viewed anytime. Creating great value to applications that require real time blockchain data at scale, now and into the future.
### Digital Asset Tokenization with the 1Sat Ordinals protocol
1SatOrdinals in an implementation of Ordinals running on the BSV blockchain. The tokens represent individual satoshis (the smallest unit of Bitcoin) that are "inscribed" with specific data, such as images or text. 1Sat Ordinals on BSV are fast, inexpensive, and fully scriptable via native Bitcoin Script.
{% content-ref url="/pages/yVYDNz3FO6mrbJNNwhec" %}
[1Sat Ordinals tokens API](/core-products/1sat-ordinals-tokens-api)
{% endcontent-ref %}
### Other benefits
* The ability to have low-cost transactions (less than a penny), which make a difference when issuers are dropping millions of NFTs, for example. This attribute means more margin for the issuers on primary and secondary markets.
* Interoperability with ecosystem wallets and other blockchain platforms.
* Transparency allows the token to be tracked throughout its lifecycle, which makes a difference in a regulatory environment.
* No network congestion — as the tokens are issued at the network level on a blockchain that scales unbounded.
You can license this technology from TAAL, download the SDK, and start building their next game-changing NFT or digital asset platform today!
{% hint style="info" %}
[Whitepaper](https://www.taal.com/wp-content/uploads/2022/01/STAS_White-Paper_20211214_1.0_Finalweb4.pdf)
{% endhint %}
{% hint style="info" %}
[TAAL Website](https://www.taal.com/)
{% endhint %}
{% hint style="info" %}
[Blog Post](https://www.taal.com/blog/)
{% endhint %}
# Get an API Key
The following are the steps to get an API key from TAAL:
1. Enter the URL in your browser
2. Register or login on to **TAAL PLATFORM**.
3. Your mainnet and testnet API keys will be displayed.
# WhatsOnChain
**WhatsOnChain API docs have moved!** [**https://docs.whatsonchain.com/**](https://docs.whatsonchain.com/)
# Health
## Get API Status
A simple endpoint to show that the API server is up and running.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///woc
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl "https://api.whatsonchain.com/v1/bsv/main/woc"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl "https://api.whatsonchain.com/v1/btc/main/woc"
```
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```
Whats On Chain
```
{% endtab %}
{% tab title="BTC" %}
```
Whats On Chain
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
# Chain Info
## Get Blockchain Info
This endpoint retrieves information about the state of the specified chain for the selected network.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///chain/info
```
{% endcode %}
#### Example Request
{% tabs fullWidth="false" %}
{% tab title="BSV" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/chain/info"
```
{% endcode %}
{% endtab %}
{% tab title="BTC" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/chain/info"
```
{% endcode %}
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
{
"chain": "main",
"blocks": 905064,
"headers": 905064,
"bestblockhash": "0000000000000000112ea3732c0417a2cee0130e9217dbba1b0ff078c92c904e",
"difficulty": 51223782275.04099,
"mediantime": 1752242156,
"verificationprogress": 0.9999990488341951,
"pruned": false,
"chainwork": "00000000000000000000000000000000000000000167559704876ce49d636d35"
}
```
{% endtab %}
{% tab title="BTC" %}
```json
{
"chain": "main",
"blocks": 904937,
"headers": 904937,
"bestblockhash": "000000000000000000005c486692de6f8726bd9223bf4a2f80babedff0d44a91",
"difficulty": 116958512019762.1,
"mediantime": 1752160121,
"verificationprogress": 0.9999988962482643,
"pruned": false,
"chainwork": "0000000000000000000000000000000000000000d12c110e37cfdb5d73cdd4ec",
"size_on_disk": 763791035344
}
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
## Get Circulating Supply
This endpoint retrieves the circulating supply of the specified blockchain.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///circulatingsupply
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/circulatingsupply"
```
{% endcode %}
{% endtab %}
{% tab title="BTC" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/circulatingsupply"
```
{% endcode %}
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```
19890434.375
```
{% endtab %}
{% tab title="BTC" %}
```
19890428.125
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ------------------------------------ |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
## Get Chain Tips
This endpoint retrieves information about all known tips in the block tree.
The possible values for status:
1. `invalid`: This branch contains at least one invalid block.
2. `headers-only`: Not all blocks for this branch are available, but the headers are valid.
3. `valid-headers`: All blocks are available for this branch, but they were never fully validated.
4. `valid-fork`: This branch is not part of the active chain, but is fully validated.
5. `active`: This is the tip of the active main chain, which is certainly valid.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///chain/tips
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/chain/tips"
```
{% endcode %}
{% endtab %}
{% tab title="BTC" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/chain/tips"
```
{% endcode %}
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
[{
"height": 905064,
"hash": "0000000000000000112ea3732c0417a2cee0130e9217dbba1b0ff078c92c904e",
"branchlen": 0,
"status": "active"
}, {
"height": 905048,
"hash": "0000000000000000089a618e0f8b8fa5dcc8a201211d09aea1434a1e03c357cf",
"branchlen": 1,
"status": "valid-headers"
},
...
]
```
{% endtab %}
{% tab title="BTC" %}
```json
[{
"height": 905086,
"hash": "0000000000000000000061958ebfa47a17b104af4cf77cd0f23141748397d505",
"branchlen": 0,
"status": "active"
}, {
"height": 904623,
"hash": "00000000000000000002274bf6db24519f56a7d6b4841f216cb82e7dc345b499",
"branchlen": 1,
"status": "valid-fork"
},
...
]
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
## Get Peer Info
This endpoint retrieves information about peers connected to the node.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///peer/info
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/peer/info"
```
{% endcode %}
{% endtab %}
{% tab title="BTC" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/peer/info"
```
{% endcode %}
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
[{
"id": 14,
"addr": "78.110.160.26:56514",
"addrlocal": "135.181.137.155:8333",
"services": "0000000000000021",
"relaytxes": true,
"lastsend": 1752244985,
"lastrecv": 1752244982,
"bytessent": 9198799,
"bytesrecv": 1112300,
"conntime": 1752211964,
"timeoffset": -58,
"pingtime": 0.042279,
"minping": 0.039421,
"version": 70016,
"subver": "/Bitcoin SV:1.0.16/",
"inbound": true,
"addnode": false,
"startingheight": 905015,
"txninvsize": 0,
"banscore": 0,
"synced_headers": 905064,
"synced_blocks": 905064,
"whitelisted": false,
"bytessent_per_msg": {
"addr": 27507,
"blocktxn": 0,
"cmpctblock": 0,
"feefilter": 0,
"getaddr": 0,
"getdata": 0,
"getheaders": 1053,
"headers": 954,
"inv": 3158821,
"notfound": 0,
"ping": 8832,
"pong": 8832,
"reject": 0,
"sendcmpct": 33,
"sendheaders": 24,
"tx": 5992415,
"verack": 24,
"version": 146
},
"bytesrecv_per_msg": {
"addr": 55,
"blocktxn": 0,
"cmpctblock": 0,
"feefilter": 0,
"getaddr": 24,
"getdata": 109395,
"getheaders": 1053,
"headers": 4801,
"inv": 978214,
"notfound": 0,
"ping": 8832,
"pong": 8832,
"reject": 694,
"sendcmpct": 33,
"sendheaders": 24,
"tx": 0,
"verack": 24,
"version": 147
}
},
...
]
```
{% endtab %}
{% tab title="BTC" %}
```json
[{
"id": 19,
"addr": "192.53.168.227:14985",
"addrlocal": "65.108.123.176:44132",
"services": "0000000000000c09",
"relaytxes": false,
"lastsend": 1752244946,
"lastrecv": 1752244946,
"bytessent": 3247905,
"bytesrecv": 2058824,
"conntime": 1749118420,
"timeoffset": 0,
"pingtime": 0.319371,
"version": 70016,
"subver": "/Satoshi:28.1.0/",
"inbound": false,
"startingheight": 899889,
"banscore": 0,
"feefilter": 0,
"syncnode": false,
"v2_connection": false
}, {
"id": 26,
"addr": "176.9.38.204:8333",
"addrlocal": "65.108.123.176:58004",
"services": "000000000000040d",
"relaytxes": true,
"lastsend": 1752245027,
"lastrecv": 1752245028,
"bytessent": 1042075735,
"bytesrecv": 520385665,
"conntime": 1749119628,
"timeoffset": -1,
"pingtime": 4.409384,
"version": 70015,
"subver": "/Satoshi:0.18.1/",
"inbound": false,
"startingheight": 899889,
"banscore": 0,
"feefilter": 0,
"syncnode": false,
"v2_connection": false
},
...
]
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
# Block
## Get by Hash
This endpoint retrieves the block details of a given hash.
{% hint style="info" %}
(BSV-only) For a block with up to 1000 transactions, all transaction ids are returned in response to this call.
* If a block has more than 1000 transactions, only the top 100 transaction ids are returned.
* To get the remaining ids see the [Get Block Pages](#get-block-pages) section.
{% endhint %}
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///block/hash/
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/hash/000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb"
```
{% endcode %}
{% endtab %}
{% tab title="BTC" %}
{% code overflow="wrap" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/block/hash/00000000000000000002145230780fd4fd371945f9365664d98a2631358d3f8c"
```
{% endcode %}
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
{
"hash": "000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb",
"confirmations": 330021,
"size": 14421,
"height": 575045,
"version": 536928256,
"versionHex": "2000e000",
"merkleroot": "4ebcba09addd720991d03473f39dce4b9a72cc164e505cd446687a54df9b1585",
"txcount": 5,
"nTx": 0,
"num_tx": 5,
"tx": ["bb146889d71357667c58a37258f40b0521a6ba7a259fbfa721b747d55567551a", "c7e8317b48e72644e2b83c87c54f61bcda82326392f969a097fb801aed69b500", "fd39debc631cf1a97702052fa60303d53062d6f2c1b624ab1f5fc0d20233736f", "65cb37947ccb7c5b7cc4ac36a200613bfc39a7f7c6c0314a23dbcc5b3908b5b8", "0f9d562702259822778193ff46f0c6d5e4aa744a433982770d3134e2bf454d10"],
"time": 1553416668,
"mediantime": 1553414858,
"nonce": 87914848,
"bits": "180997ee",
"difficulty": 114608607557.4425,
"chainwork": "000000000000000000000000000000000000000000ddf5d385546872bab7dc01",
"previousblockhash": "00000000000000000988156c7075dc9147a5b62922f1310862e8b9000d46dd9b",
"nextblockhash": "00000000000000000112b36a37c10235fa0c991f680bc5482ba9692e0ae697db",
"coinbaseTx": {
"txid": "bb146889d71357667c58a37258f40b0521a6ba7a259fbfa721b747d55567551a",
"hash": "bb146889d71357667c58a37258f40b0521a6ba7a259fbfa721b747d55567551a",
"version": 1,
"size": 119,
"locktime": 0,
"vin": [{
"coinbase": "0345c6082f626d67706f6f6c2e636f6d2f473173717918707a8aae4a936f101e0000",
"txid": "",
"vout": 0,
"scriptSig": {
"asm": "",
"hex": ""
},
"sequence": 4294967295
}],
"vout": [{
"value": 12.50023822,
"n": 0,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 85770ad0ee64a4f3ee4027e199c32f876e03a2d9 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a91485770ad0ee64a4f3ee4027e199c32f876e03a2d988ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": ["1DAhUiQxHzL1oAusoUDdUM89spXuAG1sqy"],
"isTruncated": false
}
}],
"blockhash": "000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb",
"confirmations": 330021,
"time": 1553416668,
"blocktime": 1553416668,
"blockheight": 575045
},
"totalFees": 0.0002382199999999557,
"miner": "Bmgpool",
"pages": null
}
```
{% endtab %}
{% tab title="BTC" %}
```json
{
"tx": ["f89b6ba9d48b1adb98d8e8f37ac9611183826a9f361bac970c562f42a76fed15", ...]
"miner": "AntPool",
"hash": "00000000000000000002145230780fd4fd371945f9365664d98a2631358d3f8c",
"confirmations": 578,
"size": 1509584,
"height": 904510,
"version": 546201600,
"versionHex": "208e6000",
"merkleroot": "0736388ae96f0cfbea8995039e9ecea3ddcec17ab54d2e737267c3df4c7b4818",
"txcount": 5072,
"time": 1751923471,
"mediantime": 1751920846,
"nonce": 3906737240,
"bits": "17026816",
"difficulty": 116958512019762.1,
"chainwork": "0000000000000000000000000000000000000000d07aa30757a4549b9da2c8c2",
"previousblockhash": "000000000000000000015a6b45bf7b5f5ca04553206f980de6f11c62a3e9a3b4",
"nextblockhash": "00000000000000000001df5557c00a211ad5613ff0e2402df124c58b4dd17729",
"totalFees": 0.048824670000000125,
"src": "bitcoin",
"coinbaseTx": {
"hex": "010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff56033ecd0d194d696e656420627920416e74506f6f6c20b600c900259e479ffabe6d6d500729c2badb393c33ecb43df4d1b1cfb72500e1bbc007bd8d7e40686cde9913100000000000000000000bb837e9e80000000000ffffffff07220200000000000017a91442402a28dd61f2718a4b27ae72a4791d5bbdade78721ddea120000000017a9145249bdf2c131d43995cff42e8feee293f79297a8870000000000000000266a24aa21a9ed4b61cde4f19f3e7e56901daf86503053b3e5d555ca2a9f1931e831844a75facb00000000000000002f6a2d434f52450142fdeae88682a965939fee9b7b2bd5b99694ff644e3ecda72cb7961caa4b541b1e322bcfe0b5a0300000000000000000146a12455853415401000d130f0e0e0b041f1200130000000000000000296a277379733aae4701474853a120872f92d1cfed38b1b72411f262ba2488a79035706a3a761a761f0000000000000000002b6a2952534b424c4f434b3a42c1fa55569b4e42870d0389e18cbee1cb1aceb4328ab065760c511500764bc50120000000000000000000000000000000000000000000000000000000000000000000000000",
"txid": "f89b6ba9d48b1adb98d8e8f37ac9611183826a9f361bac970c562f42a76fed15",
"hash": "045aec8ab9081f3d39cbb2ba0a7a28ce93eb0accfe3b5308246844d01b4e6de0",
"size": 471,
"version": 1,
"locktime": 0,
"vout": [{
"value": 0.00000546,
"n": 0,
"scriptPubKey": {
"asm": "OP_HASH160 42402a28dd61f2718a4b27ae72a4791d5bbdade7 OP_EQUAL",
"hex": "a91442402a28dd61f2718a4b27ae72a4791d5bbdade787",
"reqSigs": 1,
"type": "scripthash",
"addresses": ["37jKPSmbEGwgfacCr2nayn1wTaqMAbA94Z"],
"isTruncated": false
},
"scripthash": "6ae165e8ea6275a089d2222c7a8ac38585de11861c06c420352d464793a099d0"
},
...
],
"blockhash": "00000000000000000002145230780fd4fd371945f9365664d98a2631358d3f8c",
"confirmations": 578,
"time": 1751923471,
"blocktime": 1751923471,
"vincount": 1,
"voutcount": 7,
"voutvalue": 3.17382467,
"vin": [{
"n": 0,
"coinbase": "033ecd0d194d696e656420627920416e74506f6f6c20b600c900259e479ffabe6d6d500729c2badb393c33ecb43df4d1b1cfb72500e1bbc007bd8d7e40686cde9913100000000000000000000bb837e9e80000000000",
"sequence": 4294967295,
"minerInfo": {
"name": "AntPool",
"link": "https://www.antpool.com/",
"type": "tag"
}
}]
}
}
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
| hash | Block hash. |
## Get by Height
This endpoint retrieves the block details of a given block height.
{% hint style="info" %}
(BSV-only) For a block with up to 1000 transactions, all transaction ids are returned in response to this call.
* If a block has more than 1000 transactions, only the top 100 transaction ids are returned.
* To get the remaining ids see the [Get Block Pages](#get-block-pages) section.
{% endhint %}
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///block/height/
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/height/575045"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/block/height/904510"
```
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
{
"hash": "000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb",
"confirmations": 330022,
"size": 14421,
"height": 575045,
"version": 536928256,
"versionHex": "2000e000",
"merkleroot": "4ebcba09addd720991d03473f39dce4b9a72cc164e505cd446687a54df9b1585",
"txcount": 5,
"nTx": 0,
"num_tx": 5,
"tx": ["bb146889d71357667c58a37258f40b0521a6ba7a259fbfa721b747d55567551a", "c7e8317b48e72644e2b83c87c54f61bcda82326392f969a097fb801aed69b500", "fd39debc631cf1a97702052fa60303d53062d6f2c1b624ab1f5fc0d20233736f", "65cb37947ccb7c5b7cc4ac36a200613bfc39a7f7c6c0314a23dbcc5b3908b5b8", "0f9d562702259822778193ff46f0c6d5e4aa744a433982770d3134e2bf454d10"],
"time": 1553416668,
"mediantime": 1553414858,
"nonce": 87914848,
"bits": "180997ee",
"difficulty": 114608607557.4425,
"chainwork": "000000000000000000000000000000000000000000ddf5d385546872bab7dc01",
"previousblockhash": "00000000000000000988156c7075dc9147a5b62922f1310862e8b9000d46dd9b",
"nextblockhash": "00000000000000000112b36a37c10235fa0c991f680bc5482ba9692e0ae697db",
"coinbaseTx": {
"txid": "bb146889d71357667c58a37258f40b0521a6ba7a259fbfa721b747d55567551a",
"hash": "bb146889d71357667c58a37258f40b0521a6ba7a259fbfa721b747d55567551a",
"version": 1,
"size": 119,
"locktime": 0,
"vin": [{
"coinbase": "0345c6082f626d67706f6f6c2e636f6d2f473173717918707a8aae4a936f101e0000",
"txid": "",
"vout": 0,
"scriptSig": {
"asm": "",
"hex": ""
},
"sequence": 4294967295
}],
"vout": [{
"value": 12.50023822,
"n": 0,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 85770ad0ee64a4f3ee4027e199c32f876e03a2d9 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a91485770ad0ee64a4f3ee4027e199c32f876e03a2d988ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": ["1DAhUiQxHzL1oAusoUDdUM89spXuAG1sqy"],
"isTruncated": false
}
}],
"blockhash": "000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb",
"confirmations": 330022,
"time": 1553416668,
"blocktime": 1553416668,
"blockheight": 575045
},
"totalFees": 0.0002382199999999557,
"miner": "Bmgpool",
"pages": null
}
```
{% endtab %}
{% tab title="BTC" %}
```json
{
"tx": ["f89b6ba9d48b1adb98d8e8f37ac9611183826a9f361bac970c562f42a76fed15", ...]
"miner": "AntPool",
"hash": "00000000000000000002145230780fd4fd371945f9365664d98a2631358d3f8c",
"confirmations": 578,
"size": 1509584,
"height": 904510,
"version": 546201600,
"versionHex": "208e6000",
"merkleroot": "0736388ae96f0cfbea8995039e9ecea3ddcec17ab54d2e737267c3df4c7b4818",
"txcount": 5072,
"time": 1751923471,
"mediantime": 1751920846,
"nonce": 3906737240,
"bits": "17026816",
"difficulty": 116958512019762.1,
"chainwork": "0000000000000000000000000000000000000000d07aa30757a4549b9da2c8c2",
"previousblockhash": "000000000000000000015a6b45bf7b5f5ca04553206f980de6f11c62a3e9a3b4",
"nextblockhash": "00000000000000000001df5557c00a211ad5613ff0e2402df124c58b4dd17729",
"totalFees": 0.048824670000000125,
"src": "bitcoin",
"coinbaseTx": {
"hex": "010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff56033ecd0d194d696e656420627920416e74506f6f6c20b600c900259e479ffabe6d6d500729c2badb393c33ecb43df4d1b1cfb72500e1bbc007bd8d7e40686cde9913100000000000000000000bb837e9e80000000000ffffffff07220200000000000017a91442402a28dd61f2718a4b27ae72a4791d5bbdade78721ddea120000000017a9145249bdf2c131d43995cff42e8feee293f79297a8870000000000000000266a24aa21a9ed4b61cde4f19f3e7e56901daf86503053b3e5d555ca2a9f1931e831844a75facb00000000000000002f6a2d434f52450142fdeae88682a965939fee9b7b2bd5b99694ff644e3ecda72cb7961caa4b541b1e322bcfe0b5a0300000000000000000146a12455853415401000d130f0e0e0b041f1200130000000000000000296a277379733aae4701474853a120872f92d1cfed38b1b72411f262ba2488a79035706a3a761a761f0000000000000000002b6a2952534b424c4f434b3a42c1fa55569b4e42870d0389e18cbee1cb1aceb4328ab065760c511500764bc50120000000000000000000000000000000000000000000000000000000000000000000000000",
"txid": "f89b6ba9d48b1adb98d8e8f37ac9611183826a9f361bac970c562f42a76fed15",
"hash": "045aec8ab9081f3d39cbb2ba0a7a28ce93eb0accfe3b5308246844d01b4e6de0",
"size": 471,
"version": 1,
"locktime": 0,
"vout": [{
"value": 0.00000546,
"n": 0,
"scriptPubKey": {
"asm": "OP_HASH160 42402a28dd61f2718a4b27ae72a4791d5bbdade7 OP_EQUAL",
"hex": "a91442402a28dd61f2718a4b27ae72a4791d5bbdade787",
"reqSigs": 1,
"type": "scripthash",
"addresses": ["37jKPSmbEGwgfacCr2nayn1wTaqMAbA94Z"],
"isTruncated": false
},
"scripthash": "6ae165e8ea6275a089d2222c7a8ac38585de11861c06c420352d464793a099d0"
},
...
],
"blockhash": "00000000000000000002145230780fd4fd371945f9365664d98a2631358d3f8c",
"confirmations": 578,
"time": 1751923471,
"blocktime": 1751923471,
"vincount": 1,
"voutcount": 7,
"voutvalue": 3.17382467,
"vin": [{
"n": 0,
"coinbase": "033ecd0d194d696e656420627920416e74506f6f6c20b600c900259e479ffabe6d6d500729c2badb393c33ecb43df4d1b1cfb72500e1bbc007bd8d7e40686cde9913100000000000000000000bb837e9e80000000000",
"sequence": 4294967295,
"minerInfo": {
"name": "AntPool",
"link": "https://www.antpool.com/",
"type": "tag"
}
}]
}
}
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
| height | Block hash. |
## Get Block Pages (BSV-only)
If a block has more than **1000** transactions, the page URLs will be provided in the `pages` element when getting a block by hash or height.
{% code title="Example pages element in "Get block by height/hash" response:" %}
```json
{
"hash": "000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb",
...
"pages": {
"uri": [
"/block/hash/000000000000000000885a4d8e9912f085b42288adc58b3ee5830a7da9f4fef4/page/1",
"/block/hash/000000000000000000885a4d8e9912f085b42288adc58b3ee5830a7da9f4fef4/page/2",
...
],
"size": 50000
}
```
{% endcode %}
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//block/hash//page/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/hash/000000000000000000885a4d8e9912f085b42288adc58b3ee5830a7da9f4fef4/page/1"
```
{% endcode %}
{% code title="Example Response" %}
```json
[
"89b4e01ea1ab27edb6ea66899637b526faebeb42ca0302ff9ed916670f1330fe",
"1097bfc9b1f586352a1ab29afd27c1f89e0a5d9790ea08a2b2a7d988ea6f2cfe",
....
]
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| network | Selected network: `main` or `test`. |
| hash | Block hash. |
| number | Page number. |
## Get Header by Hash or Height
This endpoint retrieves the block header details of a given hash or height.
Use *`?format=block-headers-client`* as a query parameter for the [block-headers-client](https://github.com/bitcoin-sv/block-headers-client) response format.
Possible values for the status when the block-headers-client format is requested:
1. `active`: Block is a part of the current active chain.
2. `orphaned`: Block is not a part of the current active chain.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///block//header
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb/header"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/block/00000000000000000000c1412566504aeb8921b82126172437d3dd04e8683b9a/header"
```
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
{
"hash": "000000000000000004a288072ebb35e37233f419918f9783d499979cb6ac33eb",
"confirmations": 330022,
"size": 14421,
"height": 575045,
"version": 536928256,
"versionHex": "2000e000",
"merkleroot": "4ebcba09addd720991d03473f39dce4b9a72cc164e505cd446687a54df9b1585",
"time": 1553416668,
"mediantime": 1553414858,
"nonce": 87914848,
"bits": "180997ee",
"difficulty": 114608607557.4425,
"chainwork": "000000000000000000000000000000000000000000ddf5d385546872bab7dc01",
"previousblockhash": "00000000000000000988156c7075dc9147a5b62922f1310862e8b9000d46dd9b",
"nextblockhash": "00000000000000000112b36a37c10235fa0c991f680bc5482ba9692e0ae697db",
"nTx": 0,
"num_tx": 5
}
```
{% endtab %}
{% tab title="BTC" %}
```json
{
"hash": "00000000000000000000c1412566504aeb8921b82126172437d3dd04e8683b9a",
"previousblockhash": "000000000000000000020988865dd391816915731f44a2c50bd5f0a45e4ba44a",
"nextblockhash": "0000000000000000000246cd1ee83a0f684c11046899b27a90befd83c85bc8d3",
"height": 905073,
"confirmations": 34,
"time": 1752236138,
"version": 537214976,
"versionHex": "20054000",
"merkleroot": "5581b409a5067197468e82e20599eef9678f81880fa3e902cc08b0c648693549",
"bits": "17026816",
"nonce": 3798315392,
"difficulty": 116958512019762.1,
"txcount": 2945,
"nTx": 2945,
"chainwork": "0000000000000000000000000000000000000000d164940637443d7138ea87dc",
"mediantime": 1752234300
}
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
| hash | Block hash. |
## Get Headers
This endpoint retrieves the last 10 block headers.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///block/headers
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/headers"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/block/headers"
```
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
[{
"hash": "000000000000000001c1f8612fde5c70ba17d52b76db6f5c1e6403613f67dc72",
"confirmations": 1,
"size": 8187014,
"height": 905066,
"version": 738197504,
"versionHex": "2c000000",
"merkleroot": "63b4bd4890b9c0866981608b4208877f72a37245be8bf03c70d990372b25a8d5",
"time": 1752245194,
"mediantime": 1752242975,
"nonce": 3389927517,
"bits": "181584ed",
"difficulty": 51093569403.56039,
"chainwork": "0000000000000000000000000000000000000000016755aed8ebac0032110051",
"previousblockhash": "00000000000000000d4a64c6818ed5a694b0f02a674fab052f04c44f8ab82a0a",
"nextblockhash": "",
"nTx": 0,
"num_tx": 1027
}, {
"hash": "00000000000000000d4a64c6818ed5a694b0f02a674fab052f04c44f8ab82a0a",
"confirmations": 2,
"size": 3055109,
"height": 905065,
"version": 575381504,
"versionHex": "224ba000",
"merkleroot": "2e48066f4155602c02580087f6418cc9c215d50c5d5dd7675b74f5df7e82aa84",
"time": 1752244987,
"mediantime": 1752242284,
"nonce": 526349350,
"bits": "181573d9",
"difficulty": 51252456251.77387,
"chainwork": "0000000000000000000000000000000000000000016755a2f375c70ebdaa0ab3",
"previousblockhash": "0000000000000000112ea3732c0417a2cee0130e9217dbba1b0ff078c92c904e",
"nextblockhash": "000000000000000001c1f8612fde5c70ba17d52b76db6f5c1e6403613f67dc72",
"nTx": 0,
"num_tx": 3116
},
...
]
```
{% endtab %}
{% tab title="BTC" %}
```json
[{
"hash": "00000000000000000002676232151539d2094d342e4ca69e42f90dcc010b5166",
"previousblockhash": "0000000000000000000061958ebfa47a17b104af4cf77cd0f23141748397d505",
"nextblockhash": "",
"height": 905087,
"confirmations": 1,
"time": 1752245105,
"version": 769130496,
"versionHex": "2dd80000",
"merkleroot": "b63f3f987192f8f067687b6548a1279d5ead90f08310280f085a067e02f119c8",
"bits": "17026816",
"nonce": 3104566716,
"difficulty": 116958512019762.1,
"txcount": 0,
"nTx": 4505,
"chainwork": "0000000000000000000000000000000000000000d16a654564630b4d9c4412c0",
"mediantime": 1752240725
}, {
"hash": "0000000000000000000061958ebfa47a17b104af4cf77cd0f23141748397d505",
"previousblockhash": "000000000000000000023b837b327cf7baa43b41850501d6be7e3e48d0021f62",
"nextblockhash": "00000000000000000002676232151539d2094d342e4ca69e42f90dcc010b5166",
"height": 905086,
"confirmations": 2,
"time": 1752244939,
"version": 536895488,
"versionHex": "20006000",
"merkleroot": "2c16c87bcfbca675178a5a72c011262863b998e562a6e4b8a1472465cca6258a",
"bits": "17026816",
"nonce": 3008593203,
"difficulty": 116958512019762.1,
"txcount": 0,
"nTx": 3835,
"chainwork": "0000000000000000000000000000000000000000d169fae57373212b952b6442",
"mediantime": 1752239292
},
...
]
```
{% endtab %}
{% endtabs %}
**URL Parameters**
Parameter
Description
chain
Desired blockchain: bsv or btc.
network
Selected network: main or test.
## Get Header Bytes File Links
This endpoint retrieves a list of block header binary file links and each file only contains 80-byte block headers. These contain 10,000 block headers per file up to height `760,000`.
Then 2,000 blocks per file after height `760,001` . New files are automatically created after every 2,000 blocks and added to the list.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1///block/headers/resources
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/headers/resources"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/block/headers/resources"
```
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
{
"files":[
"https://api.whatsonchain.com/v1/bsv/main/block/headers/0_10000_headers.bin",
"https://api.whatsonchain.com/v1/bsv/main/block/headers/100001_110000_headers.bin",
"https://api.whatsonchain.com/v1/bsv/main/block/headers/110001_120000_headers.bin"
...
]
}
```
{% endtab %}
{% tab title="BTC" %}
```json
{
"files": [
"https://api.whatsonchain.com/v1/btc/main/block/headers/0_2000_headers.bin",
"https://api.whatsonchain.com/v1/btc/main/block/headers/2001_4000_headers.bin",
"https://api.whatsonchain.com/v1/btc/main/block/headers/4001_6000_headers.bin",
...
]
}
```
{% endtab %}
{% endtabs %}
**URL Parameters**
Parameter
Description
chain
Desired blockchain: bsv or btc.
network
Selected network: main or test.
## Get Latest Header Bytes
This endpoint retrieves the latest specified number of block headers (up to `100`) as a binary file. If "the `count` parameter is not provided, returns the latest header file, with up to 2000 block headers.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv/main/block/headers/latest?count=
```
{% endcode %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/headers/latest?count=10"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/block/headers/latest?count=10"
```
{% endtab %}
{% endtabs %}
**URL Parameters**
Parameter
Description
chain
Desired blockchain: bsv or btc.
network
Selected network: main or test.
count (optional)
Headers requested: between 1 (default) and 100.
# Transaction
## Get by Transaction Hash
This endpoint retrieves the transaction details for a given transaction ID.
{% hint style="info" %}
* In the response body, if any output's hex size `vout[x].scriptPubKey.hex` exceeds `100KB`, then the data for `vout[x].scriptPubKey.hex` and `vout[x].scriptPubKey.asm` is truncated and a flag `vout[x].scriptPubKey.isTruncated` is set to `true`.
* For unconfirmed transactions, `blockhash` and `confirmations` info won't be returned, as it doesn't exist.
* A separate endpoint [Get Raw Transaction Output Data](#get-raw-transaction-output-data) can be used to fetch the full hex data, if required by the client application.
{% endhint %}
#### HTTP Request
{% tabs %}
{% tab title="BSV" %}
```
GET https://api.whatsonchain.com/v1/bsv//tx/hash/
```
{% endtab %}
{% tab title="BTC" %}
```
GET https://api.whatsonchain.com/v1///tx/
```
{% endtab %}
{% endtabs %}
#### Example Request
{% tabs %}
{% tab title="BSV" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/tx/c1d32f28baa27a376ba977f6a8de6ce0a87041157cef0274b20bfda2b0d8df96"
```
{% endtab %}
{% tab title="BTC" %}
```sh
curl --location --request GET "https://api.whatsonchain.com/v1/btc/main/tx/b1ec43184ff57a3143e2ad5ed646916030324bf41fec7f41aaeba86125cea660"
```
{% endtab %}
{% endtabs %}
#### Example Response
{% tabs %}
{% tab title="BSV" %}
```json
{
"txid": "c1d32f28baa27a376ba977f6a8de6ce0a87041157cef0274b20bfda2b0d8df96",
"hash": "c1d32f28baa27a376ba977f6a8de6ce0a87041157cef0274b20bfda2b0d8df96",
"version": 1,
"size": 113,
"locktime": 0,
"vin": [{
"coinbase": "03d7c6082f7376706f6f6c2e636f6d2f3edff034600055b8467f0040",
"txid": "",
"vout": 0,
"scriptSig": {
"asm": "",
"hex": ""
},
"sequence": 4294967295
}],
"vout": [{
"value": 12.5000042,
"n": 0,
"scriptPubKey": {
"asm": "OP_DUP OP_HASH160 492558fb8ca71a3591316d095afc0f20ef7d42f7 OP_EQUALVERIFY OP_CHECKSIG",
"hex": "76a914492558fb8ca71a3591316d095afc0f20ef7d42f788ac",
"reqSigs": 1,
"type": "pubkeyhash",
"addresses": ["17fm4xevwDh3XRHv9UoqYrVgPMbwcGHsUs"],
"isTruncated": false
}
}],
"blockhash": "0000000000000000091216c46973d82db057a6f9911352892b7769ed517681c3",
"confirmations": 329877,
"time": 1553501874,
"blocktime": 1553501874,
"blockheight": 575191
}
```
{% endtab %}
{% tab title="BTC" %}
```json
{
"blockhash": "00000000000000000000374e27879ca3f89d8b1e826b0e188f15219311e74757",
"blockheight": 903404,
"blocktime": 1751296277,
"confirmations": 1685,
"hash": "b4ac21e75385b24d5b892686800c25a32544d9959985e2bb205a36906d0b0d9c",
"hex": "",
"locktime": 0,
"size": 392,
"time": 1751296277,
"txid": "b1ec43184ff57a3143e2ad5ed646916030324bf41fec7f41aaeba86125cea660",
"version": 1,
"vin": [{
"scriptSig": {
"asm": "",
"hex": ""
},
"sequence": 4294967295,
"txid": "db328bd0fb33da33203a53f2f0d5c50b7bb179e0127721d780aee37f0edc28ba",
"txinwitness": ["", "3044022061ba3963c95dbe0cc293d66c5683b231d50774284672404932e323c96b7fa0ca0220795b1cccf504d32c431090a8ff6c0232ced265b4dbfceb3ad9b39da33ee378c101", "3045022100e36cf32128c8c689de36cfb208514112aa2498678aa62643ccf5d2cbbe1cb5940220265e3620f2cf86d641522503fc679272ea2e37098e9540ec90d763b5101e898201", "522102c3743d41784a9b7fa7a12cfd1fd9e7f1f082025f6ce1678a039f8e3a8f272c01210370d354df8cebb3e683c5e4a2c112a79b7c9adb801240d71d4788d8bac253599521038955d013f9524ab7d5b862c7c1202f316322841c81297b1e354a54e5d66f536753ae"],
"vout": 0
}],
"vout": [{
"n": 0,
"scriptPubKey": {
"address": "bc1qc4vww3zys9mzkchmf5s57ejew7metj3n4m7tzycyzwt7mxpv5y8qh0fyg5",
"asm": "0 c558e7444481762b62fb4d214f665977b795ca33aefcb113041397ed982ca10e",
"hex": "0020c558e7444481762b62fb4d214f665977b795ca33aefcb113041397ed982ca10e",
"isTruncated": false,
"type": "witness_v0_scripthash"
},
"value": 0.75
}, {
"n": 1,
"scriptPubKey": {
"address": "bc1q7ka0q74ugkzvtaz9wd64klumrpavykg64qqlcewvaxcyfmm6xh7stvux9n",
"asm": "0 f5baf07abc4584c5f44573755b7f9b187ac2591aa801fc65cce9b044ef7a35fd",
"hex": "0020f5baf07abc4584c5f44573755b7f9b187ac2591aa801fc65cce9b044ef7a35fd",
"isTruncated": false,
"type": "witness_v0_scripthash"
},
"value": 0.7498965
}],
"vsize": 201,
"weight": 803
}
```
{% endtab %}
{% endtabs %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| chain | Desired blockchain: `bsv` or `btc`. |
| network | Selected network: `main` or `test`. |
| txid | Transaction ID. |
## Get by Transaction Index (BSV-only)
This endpoint retrieves the transaction details for a given block height and transaction index in that block. Works only for confirmed transactions.
{% hint style="info" %}
* In the response body, if any output's hex size `vout[x].scriptPubKey.hex` exceeds 100KB, then the data for `vout[x].scriptPubKey.hex` and `vout[x].scriptPubKey.asm` is truncated and a flag `vout[x].scriptPubKey.isTruncated` is set to `true`.
* A separate endpoint [Get Raw Transaction Output Data](#get-raw-transaction-output-data) can be used to fetch the full hex data, if required by the client application.
{% endhint %}
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv/main/block/height//txindex/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/block/height/892006/txindex/32891"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"txid": "522804f8b0c19cb51bd3c7d14a64b472bb9797f292393f1abd9d32b9a2946495",
"hash": "522804f8b0c19cb51bd3c7d14a64b472bb9797f292393f1abd9d32b9a2946495",
"version": 1,
"size": 410,
"locktime": 0,
"vin": [{
"coinbase": "",
"txid": "bc5c9aba8003aa0c0ccb64f077310bb945796f8b3aec6648672ddfa8eee1d7eb",
"vout": 0,
"scriptSig": {
"asm": "3045022100fee85b93b63e313950a3c100fb022e8c9990a7104032e7f678a4e36f791c52bd022001c6c022c03db168848a49a95de126cebd5160d4ac4a78277e08795a613cfafe[ALL|FORKID] 0326c692c95e73175795109d2fc90e852e7d725aa25d3d1b783d8c924d3c2be872",
"hex": "483045022100fee85b93b63e313950a3c100fb022e8c9990a7104032e7f678a4e36f791c52bd022001c6c022c03db168848a49a95de126cebd5160d4ac4a78277e08795a613cfafe41210326c692c95e73175795109d2fc90e852e7d725aa25d3d1b783d8c924d3c2be872"
},
"sequence": 4294967295
}, {
"coinbase": "",
"txid": "652d1235d1266d7ccdad981ade1b0169a6d8fdd690d3bac1e17e366935613dd4",
"vout": 2,
"scriptSig": {
"asm": "3045022100a71a7d18cd7c4d441a215a2bb2bfb00a87af17a9ae65a1434dac6c943a5d95ba02203329d2d667175d33f3f097975a5aa0309b43c58f470448a25ed22342616642b7[ALL|FORKID] 0326c692c95e73175795109d2fc90e852e7d725aa25d3d1b783d8c924d3c2be872",
"hex": "483045022100a71a7d18cd7c4d441a215a2bb2bfb00a87af17a9ae65a1434dac6c943a5d95ba02203329d2d667175d33f3f097975a5aa0309b43c58f470448a25ed22342616642b741210326c692c95e73175795109d2fc90e852e7d725aa25d3d1b783d8c924d3c2be872"
},
"sequence": 4294967295
}],
"vout": [{
"value": 0,
"n": 0,
"scriptPubKey": {
"asm": "OP_RETURN 6478732e617070 703a313539363436302c6d617267696e",
"hex": "6a076478732e61707010703a313539363436302c6d617267696e",
"type": "nulldata",
"opReturn": {
"type": "dxs",
"action": "",
"text": "",
"parts": ["\u0007dxs.app\u0010p:1596460,margin"]
},
"isTruncated": false
}
},
...
],
"blockhash": "00000000000000000c20becd473e985688ff2fcb2b234165acb11fbf1024c2bb",
"confirmations": 13062,
"time": 1744376748,
"blocktime": 1744376748,
"blockheight": 892006
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ------------------------------------------------- |
| network | Selected network: `main` or `test`. |
| height | Specified block height. |
| txindex | Index of the transaction in the associated block. |
## Get Transaction Propagation Status (BSV-only)
This endpoint returns the propagation status for a given transaction. It queries a random set of peers on the network and returns the number of peers that have the transaction in question.
{% hint style="warning" %}
This is an expensive call, so it's recommended only for critical or high-value transactions that might require checking the network propagation status. It is rate-limited to 10 requests per 10 seconds.
{% endhint %}
{% hint style="info" %}
If the transaction has been found on zero peers, possible reasons may include:
* Propagation is still in progress;
* The transaction fee rate, or that of a preceding transaction, is relatively low, making it invisible to peers that are configured to accept only higher fee rates.
{% endhint %}
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//tx/hash//propagation
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/tx/hash//propagation"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"queried_peers": 16,
"found_on_peers": 16
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| txid | Transaction ID. |
## Broadcast Transaction (BSV-only)
You can broadcast a transaction to the BSV network using this endpoint. Returns the `txid` in the response or an error message from the node, with header content-type: `text/plain`.
{% hint style="warning" %}
Keep in mind that this endpoint is meant for small-scale usage. For commercial or enterprise usage, please take a look at [ARC Endpoints](/core-products/transaction-processing/arc-endpoints), which are built for those types of use cases.
{% endhint %}
{% code title="HTTP Request" %}
```
POST https://api.whatsonchain.com/v1/bsv//tx/raw
```
{% endcode %}
{% code title="Request Data" %}
```json
{
"txhex": ""
}
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request POST "https://api.whatsonchain.com/v1/bsv/main/tx/raw" \
--header "Content-Type: application/json" \
--data "{\"txhex\": \"\" }"
```
{% endcode %}
**URL Parameters**
**URL Parameters**
| Parameter | Description |
| ------------ | ------------------------------------------------------------------------------------------- |
| network | Selected network: `main` or `test`. |
| originNumber | Origin number. More info [here](https://docs.1satordinals.com/readme/terms#inscription-id). |
## Get Token's Data Content
This endpoint retrieves the content of the token's file, in case it has one.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/1satordinals//content
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/1satordinals/b847a5c9aff596fb98435dd179fd7a6d541d54556518c357f53f54812d46f717_0/content"
```
{% endcode %}
{% code title="Example Response" %}
```
464400.bsvmap
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | -------------------------------------------------------------------------------------------- |
| network | The selected network: `main` or `test`. |
| outpoint | Inscription ID. More info [here](https://docs.1satordinals.com/readme/terms#inscription-id). |
## Get the Latest Token's Transfer
This endpoint retrieves the token's latest transfer with the origin token.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/1satordinals//latest
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/1satordinals/6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156/latest"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"token":{
"outpoint": "7e796f68d56b7b530b91ff551f402d8972aa3ea6ecf9eb7187616cb4bf75bcb9_0",
"scriptHash": "c34e301999f898cb3e8f50bc85b5f1c3a45ab3aee33f125c59784915a06d7b67",
"scriptLockType": "p2pkh",
"ownerAddress": "1N1QG9hdaMhaTwBDweVrrkbyrXxNeCBHst",
"origin":{
"number": "783989:21395:156",
"outpoint": "6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156",
"vout":156,
"scriptHash": "28110cffb0f31f2ea4d13cdb9a848ffd0e3cd912ebf3ab5239b63733d3fec3da",
"scriptLockType": "nonstandard",
"ownerAddress": "1J3CFrgrmqmHrEtqCiP6ybjedKBwA3tELN",
"spentTxid": "fda8480b34526ed3b5e780288b6b3851de94ef81018e3e752b561bf8324d7535",
"data":{
"insc":{
"file":{
"hash": "TeOqczWHftnhDJjMza6Z/siyzLOTN9QkZ7lhYVPW/mQ=",
"size": 1841,
"type": "image/png"
}
},
"map":{
"app": "BigBlockPunkz",
"collection": "BigBlockPunkz",
"type": "ord"
},
"types":[
"file"
]
}
},
"current":{
"txid": "7e796f68d56b7b530b91ff551f402d8972aa3ea6ecf9eb7187616cb4bf75bcb9",
"txIndex": 2553,
"blockHeight": 832795,
"blockTime": 1708693512
}
}
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | -------------------------------------------------------------------------------------------- |
| network | Selected network: `main` or `test`. |
| outpoint | Inscription ID. More info [here](https://docs.1satordinals.com/readme/terms#inscription-id). |
## Get the Token's Transfer History
This endpoint retrieves the token's history of transfers.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/1satordinals//history
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/1satordinals/6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156/history"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"tokens":[
{
"outpoint": "6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156",
"vout":156,
"scriptHash": "28110cffb0f31f2ea4d13cdb9a848ffd0e3cd912ebf3ab5239b63733d3fec3da",
"scriptLockType": "nonstandard",
"ownerAddress": "1J3CFrgrmqmHrEtqCiP6ybjedKBwA3tELN",
"spentTxid": "fda8480b34526ed3b5e780288b6b3851de94ef81018e3e752b561bf8324d7535",
"origin":{
"number": "783989:21395:156",
"outpoint": "6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156",
"vout": 156,
"scriptHash": "28110cffb0f31f2ea4d13cdb9a848ffd0e3cd912ebf3ab5239b63733d3fec3da",
"scriptLockType": "nonstandard",
"ownerAddress": "1J3CFrgrmqmHrEtqCiP6ybjedKBwA3tELN",
"spentTxid": "fda8480b34526ed3b5e780288b6b3851de94ef81018e3e752b561bf8324d7535",
"data":{
"insc":{
"file":{
"hash": "TeOqczWHftnhDJjMza6Z/siyzLOTN9QkZ7lhYVPW/mQ=",
"size": 1841,
"type": "image/png"
}
},
"map":{
"app": "BigBlockPunkz",
"collection": "BigBlockPunkz",
"type": "ord"
},
"types":[
"file"
]
}
},
"data":{
"insc":{
"file":{
"hash": "TeOqczWHftnhDJjMza6Z/siyzLOTN9QkZ7lhYVPW/mQ=",
"size": 1841,
"type": "image/png"
}
},
"map":{
"app": "BigBlockPunkz",
"collection": "BigBlockPunkz",
"type": "ord"
},
"types":[
"file"
]
},
"current":{
"txid": "6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603",
"txIndex": 21395,
"blockHeight": 783989,
"blockTime": 1679320103
}
},
//...
{
"outpoint": "7e796f68d56b7b530b91ff551f402d8972aa3ea6ecf9eb7187616cb4bf75bcb9_0",
"scriptHash": "c34e301999f898cb3e8f50bc85b5f1c3a45ab3aee33f125c59784915a06d7b67",
"scriptLockType": "p2pkh",
"ownerAddress": "1N1QG9hdaMhaTwBDweVrrkbyrXxNeCBHst",
"origin":{
"number": "783989:21395:156",
"outpoint": "6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156",
"vout":156,
"scriptHash": "28110cffb0f31f2ea4d13cdb9a848ffd0e3cd912ebf3ab5239b63733d3fec3da",
"scriptLockType": "nonstandard",
"ownerAddress": "1J3CFrgrmqmHrEtqCiP6ybjedKBwA3tELN",
"spentTxid": "fda8480b34526ed3b5e780288b6b3851de94ef81018e3e752b561bf8324d7535",
"data":{
"insc":{
"file":{
"hash": "TeOqczWHftnhDJjMza6Z/siyzLOTN9QkZ7lhYVPW/mQ=",
"size": 1841,
"type": "image/png"
}
},
"map":{
"app": "BigBlockPunkz",
"collection": "BigBlockPunkz",
"type": "ord"
},
"types":[
"file"
]
}
},
"current":{
"txid": "7e796f68d56b7b530b91ff551f402d8972aa3ea6ecf9eb7187616cb4bf75bcb9",
"txIndex": 2553,
"blockHeight": 832795,
"blockTime": 1708693512
}
}
],
"total_count": 9
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | -------------------------------------------------------------------------------------------- |
| network | Selected network: `main` or `test`. |
| outpoint | Inscription ID. More info [here](https://docs.1satordinals.com/readme/terms#inscription-id). |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get Transaction's Tokens
This endpoint retrieves tokens that a transaction contains.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/1satordinals/tx/
```
{% endcode %}
{% code title="Response Structure" %}
```json
{
"tokens":[
{
"outpoint": string,
"scriptHash": string,
"scriptLockType": string,
"ownerAddress": string,
"spentTxid": string,
"origin":{
"number": string,
"outpoint": string,
"vout": integer,
"scriptHash": string,
"scriptLockType": string,
"ownerAddress": string,
"spentTxid": string,
"data":{
"insc":{
"file":{
"hash": string,
"size": integer,
"type": string
}
},
"map":{
string: string
},
"types":[
string
]
}
},
"data":{
"insc":{
"file":{
"hash": string,
"size": integer,
"type": string
}
},
"map":{
string: string
},
"type": string
},
"sigma":[
{
"address": string,
"algorithm": string,
"signature": string,
"valid": boolean,
"vin": integer
}
],
"types":[
string
]
},
"current":{
"txid": string,
"txIndex": integer,
"blockHeight": integer,
"blockTime": integer
}
}
],
"total_count": integer
}
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/1satordinals/tx/9c59baa1944e93771379f110526f7c80a9c9627af583df3f760f1c01f8ea8d42"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"tokens":[
{
"outpoint": "9c59baa1944e93771379f110526f7c80a9c9627af583df3f760f1c01f8ea8d42_0",
"scriptHash": "435ef0918227553dec7539da2fd0faeb4dfda2405f46b12193035482a4164088",
"scriptLockType": "nonstandard",
"ownerAddress": "1PjgYHLBqkKhzddfhNN6A428irtAhDWZTN",
"spentTxid": "99995013a737ed4437d87a2fbaafeae89630cd8ea228afc71f0393fd2f4b8e2b",
"origin":{
"number": "783989:21395:156",
"outpoint": "6fecd063b0ee00489f79a0e9c0793e0bcb265f81faa43e36193833a849bf9603_156",
"vout":156,
"scriptHash": "28110cffb0f31f2ea4d13cdb9a848ffd0e3cd912ebf3ab5239b63733d3fec3da",
"scriptLockType": "nonstandard",
"ownerAddress": "1J3CFrgrmqmHrEtqCiP6ybjedKBwA3tELN",
"spentTxid": "fda8480b34526ed3b5e780288b6b3851de94ef81018e3e752b561bf8324d7535",
"data":{
"insc":{
"file":{
"hash": "TeOqczWHftnhDJjMza6Z/siyzLOTN9QkZ7lhYVPW/mQ=",
"size": 1841,
"type": "image/png"
}
},
"map":{
"app": "BigBlockPunkz",
"collection": "BigBlockPunkz",
"type": "ord"
},
"types":[
"file"
]
}
},
"data":{
"insc":{
"file":{
"hash": "hTBTPtJh/pEWUQnCmVFdu296UhaslM9q2ilDJtB74lM=",
"size": 785409,
"type": "image/png"
}
},
"map":{
"app": "ZoideNFT",
"subType": "collectionItem",
"subTypeData":{
"collectionId": "2a48f67ae1da8e679210b073d2e2cb5f0eb7bfcc68dc07f2f6b05e78fb407152_0",
"mintNumber": "6",
"name": "Reverb 6",
"rarityLabel": "COMMON"
},
"type": "ord"
},
"sigma":[
{
"address": "12KP5KzkBwtsc1UrTrsBCJzgqKn8UqaYQq",
"algorithm": "BSM",
"signature": "H6nlPVuBqlTsK2B/Sh+oevNRcZDmTtmkRVTZeRGjnZXZfVxVhV9nZ5x5GWDbLnfbWYEAPnngoiF30nv0PaCjF68=",
"valid":true,
"vin":0
}
],
"types":[
"file"
]
},
"current":{
"txid": "9c59baa1944e93771379f110526f7c80a9c9627af583df3f760f1c01f8ea8d42",
"txIndex": 829,
"blockHeight": 832677,
"blockTime": 1708617885
}
}
],
"total_count": 1
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ----------------------------------- |
| network | Selected network: `main` or `test`. |
| txid | Transaction ID. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
### Need an additional API endpoint?
If you want to make a request for an additional API endpoint that would help with your use case, please reach out to us using our [WoC Telegram channel](http://t.me/+SNmGhFqKVB9kf%E2%80%A6). Please provide as much detail on what you're trying to achieve as possible.
# BSV-21 (Beta)
{% hint style="info" %}
BSV-21 protocol was originally called BSV-20 v2 but was renamed for clarity.
{% endhint %}
Here is a brief intro from the [official documentation](https://docs.1satordinals.com/fungible-tokens/bsv-21):
*"This iteration of the BSV-20 protocol introduces a new* `tickerless` *mode functionality.* `Tickerless` *mode forgoes the* `first is first` *nature of BRC20-BTC, and allows the capabilities to have a smart contract, or an administrator, control distribution. Additionally, every transaction of a* `tickerless` *mode token forms part of a single on-chain DAG (Directed Acyclic Graph), such that the transaction can easily be tracked back to that token's genesis* `mint`*. "*
## Get Address Balance
This endpoint retrieves the amount of tokens that were not spent.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21//balance
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/1MMRcQnACaByFV6gYPoSzd9VPjemLeT57q/balance"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"tokens":[
{
"outpoint":"7ea4f03a1e3b9e2c0509a3bc523814e911d0306048ee73c435ba05b50d0d18a8_0",
"amount":"200",
"decimals":2,
"symbol":"YWT33"
},
{
"outpoint":"c5bea9ef8bd1bd9de47cef5179bee557c8e7ae5ed303338b925088c6cae3f4e2_1",
"amount":"10",
"decimals":1,
"symbol":"smtfg1",
"icon":"c5bea9ef8bd1bd9de47cef5179bee557c8e7ae5ed303338b925088c6cae3f4e2_0"
}
],
"total_count":2
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| id | Token identifier - `_`. |
**Query Parameters**
| Parameter | Description |
| ------------------------ | ---------------------------------------------- |
| filterMempool (optional) | Options: `both`, `mempool`, `mined` (default). |
## Get a Depth
This endpoint retrieves transfers inscribed by the provided address and where they are spent.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21//id//depth
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/1s2YXTRJce8k8VybXz4EmUnxC6jLyWPes/id/e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0/depth"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"branches":[
{
"txid":"02c7c1a574766b6755217df1d51219797ad9e68986669c761fe00210b3075898",
"txIndex":405,
"blockHeight":857818,
"spent":{
"outpoint":"a652c3d01b73d417d785c299cb397540de0474146c6e978fd20db31941157fcf_1",
"txIndex":388,
"blockHeight":861969
}
},
{
"txid":"22d79dd02b1b1c85b1119f800b5626b7f12645599098e2557b79ecb551e02b2a",
"txIndex":444,
"blockHeight":861969,
"spent":{
"outpoint":"f9ec4e4aee1bec1255108424a1c5b595151a35b1302be00ddb2d1c1503e010e7_1",
"txIndex":422,
"blockHeight":863272
}
}
],
"total_count":2
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| address | Address. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get a Token
This endpoint retrieves the token details given the token's identifier.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21/id/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/id/942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba_0"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"token": {
"outpoint": "942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba_0",
"scriptHash": "96e31317c9059acb339ee65be792de959b4aee32ee79d9bddfd4f7689091ae73",
"funderAddress": "1MxwReRMY53Y1G4rQN53w8DFZRYHTpHfYm",
"data": {
"bsv20": {
"amt": 21000000,
"icon": "ecb483eda58f26da1b1f8f15b782b1186abdf9c6399a1c3e63e0d429d5092a41_0",
"id": "942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba_0",
"op": "deploy+mint",
"protocol": "bsv-20",
"symbol": "27ff2993c1e873e286a8a6fcfd5639ccaed466467f5907d737f5f051eb11b520"
},
"insc": {
"file": {
"hash": "ZczVOfCd+PT0n7DbU2zSPH3gW31gkM4p8iN1bWUH7hU=",
"size": 199,
"type": "application/bsv-20"
},
"json": {
"amt": "21000000",
"icon": "ecb483eda58f26da1b1f8f15b782b1186abdf9c6399a1c3e63e0d429d5092a41_0",
"op": "deploy+mint",
"p": "bsv-20",
"sym": "27ff2993c1e873e286a8a6fcfd5639ccaed466467f5907d737f5f051eb11b520"
}
},
"types": [
"json"
]
},
"current": {
"txid": "942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba",
"txIndex": 69616,
"blockHeight": 880067,
"blockTime": 1737168515
}
}
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| address | Address. |
| id | Token identifier - `_`. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get a Transfer
This endpoint retrieves the token's transfer details given the inscription's outpoint.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21/outpoint/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/outpoint/6dc1a50dd6f18f5c55d60fa8532043e19cd91e9d2d9fbceee8166868e0263e65_1"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"inscription":{
"vout":1,
"scriptHash":"7df2cabb01151773b2484da0752ead2e86f0b0604b67d562b3cbec780af6b179",
"ownerAddress":"1Pp4sGru37gAfpbyLME6rVjamyJ9nd2ym",
"data":{
"bsv20":{
"amt":1000,
"id":"459f0e8bb038d55e3f732f11cc80af75c86b8f48dd17eac2bf92ebe9ac3a040c_0",
"op":"transfer",
"protocol":"bsv-20"
},
"insc":{
"file":{
"hash":"c6cYm2ltooXmDRSL6HOBF7gfuvgs5QEG5MXu4H4smbE=",
"size":117,
"type":"application/bsv-20"
},
"json":{
"amt":"1000",
"id":"459f0e8bb038d55e3f732f11cc80af75c86b8f48dd17eac2bf92ebe9ac3a040c_0",
"op":"transfer",
"p":"bsv-20"
}
},
"types":[
"json"
]
},
"current":{
"txid":"6dc1a50dd6f18f5c55d60fa8532043e19cd91e9d2d9fbceee8166868e0263e65",
"txIndex":40,
"blockHeight":841255,
"blockTime":1713795871
}
}
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| outpoint | Outpoint - `_`. |
## Get History by Address
This endpoint retrieves transfers history given the address and token's identifier.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21//id/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "1s2YXTRJce8k8VybXz4EmUnxC6jLyWPes/id/e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0/history?skip=3&limit=2"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"inscriptions":[
{
"vout":0,
"scriptHash":"1629429acdd3c8cd72738b292caa616830ef82546fc9a0f8ad742e8c32caddfb",
"ownerAddress":"1s2YXTRJce8k8VybXz4EmUnxC6jLyWPes",
"data":{
"bsv20":{
"amt":22222200000000,
"id":"e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0",
"op":"transfer",
"protocol":"bsv-20"
},
"insc":{
"file":{
"hash":"xM/dPLDlGFvpp/7113yjkqI/HkaaJjG8Cv3QznokKEo=",
"size":127,
"type":"application/bsv-20"
},
"json":{
"amt":"22222200000000",
"id":"e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0",
"op":"transfer",
"p":"bsv-20"
}
},
"types":[
"json"
]
},
"current":{
"txid":"22d79dd02b1b1c85b1119f800b5626b7f12645599098e2557b79ecb551e02b2a",
"txIndex":444,
"blockHeight":861969,
"blockTime":1726254528
}
},
{
"vout":1,
"scriptHash":"d931f30431274374fb8a0ee69cb0cfdb59555404089bf6a2d4627bc73adba192",
"ownerAddress":"1s2YXTRJce8k8VybXz4EmUnxC6jLyWPes",
"data":{
"bsv20":{
"amt":46666700000000,
"id":"e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0",
"op":"transfer",
"protocol":"bsv-20"
},
"insc":{
"file":{
"hash":"XK86+/JWmnz2rU3IdgYUMg519oFtWA5pk3T2BkNP1rY=",
"size":127,
"type":"application/bsv-20"
},
"json":{
"amt":"46666700000000",
"id":"e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0",
"op":"transfer",
"p":"bsv-20"
}
},
"types":[
"json"
]
},
"current":{
"txid":"22d79dd02b1b1c85b1119f800b5626b7f12645599098e2557b79ecb551e02b2a",
"txIndex":444,
"blockHeight":861969,
"blockTime":1726254528
}
}
],
"total_count":2
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| address | Address. |
| id | Token identifier - `_`. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get Spent Outputs
This endpoint retrieves spent inscriptions given the transaction's identifier.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21/txid//spent
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/txid/22d79dd02b1b1c85b1119f800b5626b7f12645599098e2557b79ecb551e02b2a/spent"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"inscriptions":[
{
"vout":0,
"scriptHash":"7bc83b8837be332181e7d8f098c3f9bcbf34a1fd8acb3a4e0114f261f014b955",
"ownerAddress":"1s2YXTRJce8k8VybXz4EmUnxC6jLyWPes",
"spentTxid":"22d79dd02b1b1c85b1119f800b5626b7f12645599098e2557b79ecb551e02b2a",
"data":{
"bsv20":{
"amt":10000000000000,
"id":"e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0",
"op":"transfer",
"protocol":"bsv-20"
},
"insc":{
"file":{
"hash":"YtnAMmnJcV0qk50dbdAUxGWz/QUkM+zl51OpLPWhoK0=",
"size":127,
"type":"application/bsv-20"
},
"json":{
"amt":"10000000000000",
"id":"e6d40ba206340aa94ed40fe1a8adcd722c08c9438b2c1dd16b4527d561e848a2_0",
"op":"transfer",
"p":"bsv-20"
}
},
"types":[
"json"
]
},
"current":{
"txid":"38f8a1e8d2953323cd3cace35341aaaffb46b0366c2d5eb1881ca0ec565a3867",
"txIndex":403,
"blockHeight":861969,
"blockTime":1726254528
}
}
],
"total_count":1
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| txid | Transaction ID. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get Tokens by Transaction ID
This endpoint retrieves tokens that a given transaction contains.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21/txid/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/txid/942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"tokens": [
{
"outpoint": "942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba_0",
"scriptHash": "96e31317c9059acb339ee65be792de959b4aee32ee79d9bddfd4f7689091ae73",
"funderAddress": "1MxwReRMY53Y1G4rQN53w8DFZRYHTpHfYm",
"data": {
"bsv20": {
"amt": 21000000,
"icon": "ecb483eda58f26da1b1f8f15b782b1186abdf9c6399a1c3e63e0d429d5092a41_0",
"id": "942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba_0",
"op": "deploy+mint",
"protocol": "bsv-20",
"symbol": "27ff2993c1e873e286a8a6fcfd5639ccaed466467f5907d737f5f051eb11b520"
},
"insc": {
"file": {
"hash": "ZczVOfCd+PT0n7DbU2zSPH3gW31gkM4p8iN1bWUH7hU=",
"size": 199,
"type": "application/bsv-20"
},
"json": {
"amt": "21000000",
"icon": "ecb483eda58f26da1b1f8f15b782b1186abdf9c6399a1c3e63e0d429d5092a41_0",
"op": "deploy+mint",
"p": "bsv-20",
"sym": "27ff2993c1e873e286a8a6fcfd5639ccaed466467f5907d737f5f051eb11b520"
}
},
"types": [
"json"
]
},
"current": {
"txid": "942fa8659a65cbcfaf979c4abef28a8f9c1454836cc3a9b42662f2bf784d92ba",
"txIndex": 69616,
"blockHeight": 880067,
"blockTime": 1737168515
}
}
],
"total_count": 1
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| txid | Transaction ID. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get Unspent Tokens by Address
This endpoint retrieves unspent BSV-21 inscriptions given an address.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21//unspent
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/14h6iBhUj2SBDtMkSiGxed9SyaWpFwCw4j/unspent"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"tokens": [
{
"scriptHash": "d5b8124a3cec0843ced890272b64c745fc1a311a9d9dc1453ba6d77c4a519305",
"data": {
"bsv20": {
"amt": 999000,
"id": "459f0e8bb038d55e3f732f11cc80af75c86b8f48dd17eac2bf92ebe9ac3a040c_0",
"op": "transfer",
"protocol": "bsv-20"
},
"insc": {
"file": {
"hash": "eXPedD7bUNMRNMu7a5zFX9GSMn1nyOwbI/5+Sa8CA4Y=",
"size": 119,
"type": "application/bsv-20"
},
"json": {
"amt": "999000",
"id": "459f0e8bb038d55e3f732f11cc80af75c86b8f48dd17eac2bf92ebe9ac3a040c_0",
"op": "transfer",
"p": "bsv-20"
}
},
"types": [
"json"
]
},
"current": {
"txid": "6dc1a50dd6f18f5c55d60fa8532043e19cd91e9d2d9fbceee8166868e0263e65",
"txIndex": 40,
"blockHeight": 841255,
"blockTime": 1713795871
}
}
],
"total_count": 1
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| address | Address. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
## Get Token Owners
This endpoint retrieves addresses that own a token or transfer(s) of the inscription.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/bsv21/id//owners
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/bsv21/id/cc7a38cfd087b9411b8533e6c5d30590a9e50ea9adc5ca3e3d947bb201a15ebd_0/owners"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"owners": [
{
"address": "1JwtQdKJM9GrARS5X9cNaGadqbNSfzSKwF"
},
{
"address": "1Gi1ahKC1Ybbi85RTMsyuifxHS754nd6Ni"
},
{
"address": "1G6CB3Ch4zFkPmuhZzEyChQmrQPfi86qk3"
}
],
"total_count": 3
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------- |
| network | The selected network: `main` or `test`. |
| id | Token identifier - `_`. |
**Query Parameters**
| Parameter | Description |
| ---------------- | -------------------------------------- |
| skip (optional) | Skip items. For pagination. |
| limit (optional) | Limit number of items. For pagination. |
### Need an additional API endpoint?
If you want to make a request for an additional API endpoint that would help with your use case, please reach out to us using our [WoC Telegram channel](http://t.me/+SNmGhFqKVB9kf%E2%80%A6). Please provide as much detail on what you're trying to achieve as possible.
# STAS Tokens (Beta)
STAS is a token protocol that consists of a bitcoin script for locking/unlocking bitcoin transaction outputs. Read more in the [official documentation](https://docs.stastoken.com/).
## Get All Tokens
This endpoint retrieves a list of supported tokens along with the relevant metadata.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//tokens
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/tokens"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"tokens": [
{
"description": "-",
"image": "https://firebasestorage.googleapis.com/v0/b/musicartstaging/o/nftAssets%2F3e75ba7e-fa51-4efb-a483-3b2c71bab180_250x250?alt=media",
"name": "fdsfs",
"properties": {
"issuer": {
"email": "info@musicart.io",
"governing_law": "England and Wales",
"issuer_country": "UK",
"jurisdiction": "UK",
"legal_form": "Limited",
"organisation": "Calekta Limited"
},
"legal": {
"terms": "\u00a9 2020 TAAL TECHNOLOGIES SEZC\nALL RIGHTS RESERVED. ANY USE OF THIS SOFTWARE IS SUBJECT TO TERMS AND CONDITIONS OF LICENSE. USE OF THIS SOFTWARE WITHOUT LICENSE CONSTITUTES INFRINGEMENT OF INTELLECTUAL PROPERTY. FOR LICENSE DETAILS OF THE SOFTWARE, PLEASE REFER TO: www.taal.com/stas-token-license-agreement"
}
},
"protocol": "STAS",
"schema_id": "NFT1.0/MA",
"symbol": "ujtVA5",
"token_id": "7bfb2ae7e878d107191259c1be72cf116da3f59d"
},
{
"token_id": "2",
"protocol": "STAS",
"ticker": "CIPS",
....
}
]
}
```
{% endcode %}
**URL Parameters**
Parameter
Description
network
Selected network: main.
## Get Token by ID
This endpoint retrieves the token metadata including contract and issuance details.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token//
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/c402bc341157265f5f8a747c11099847056a229a/test1124"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"token": {
"contract_txs": [
"72ae93f5fdc5a4fa5abfab780d7d1c8ad988d25ae34578b80dce5ff9e5c3db03"
],
"description": "generating stas token",
"image": "https://firebasestorage.googleapis.com/v0/b/nftdev/o/nftTemp%2FWL1DdD?alt=media",
"issuance_txs": [
"b00bcc9dfc7dd483ff989f3d1d3f091b23e88ca2207c9e15788e3e84a5b10c8b"
],
"name": "test",
"properties": {
"issuer": {
"email": "info@vaionex.com",
"governing_law": "US",
"issuer_country": "US",
"jurisdiction": "US",
"legal_form": "Limited",
"organisation": "vaionex corp."
},
"legal": {
"terms": "test"
}
},
"protocol": "STAS",
"schema_id": "NFT1.0/MA",
"symbol": "test1124",
"token_id": "c402bc341157265f5f8a747c11099847056a229a",
"tx_count": 3
}
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------------- |
| network | Selected network: `main`. |
| tokenId | Unique ID of the token. |
| symbol | Symbol used in the registration of the token. |
## Get Token UTXOs for Address
This endpoint retrieves the token UTXOs for a given address.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//address//tokens/unspent
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1GJ3x5bcEnKMnzNFPPELDfXUCwKEaLHM5H/tokens/unspent"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"address": "1JsQieDaYUg5pSRtpeEQhTv3buHvSX7WH4",
"utxos": [
{
"amount": 2000,
"index": 1,
"redeemAddr": "c402bc341157265f5f8a747c11099847056a229a",
"symbol": "test1124",
"txid": "cf3968e6950286cf94aa9efb7a1cc1b9c74190d159ff6d2a4dc7d9feb6e50c55"
}
]
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ------------------------- |
| network | Selected network: `main`. |
| address | Address. |
## Get Address Token Balance
This endpoint retrieves the token balances for a given address.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//address//tokens
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/address/1JsQieDaYUg5pSRtpeEQhTv3buHvSX7WH4/tokens"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"address": "1JsQieDaYUg5pSRtpeEQhTv3buHvSX7WH4",
"tokens": [
{
"balance": 0,
"image": "https://firebasestorage.googleapis.com/v0/b/nftdev/o/nftTemp%2FWL1DdD?alt=media",
"protocol": "STAS",
"redeemAddr": "c402bc341157265f5f8a747c11099847056a229a",
"symbol": "test2"
},
{
"balance": -2000,
"image": "https://firebasestorage.googleapis.com/v0/b/nftdev/o/nftTemp%2FWL1DdD?alt=media",
"protocol": "STAS",
"redeemAddr": "c402bc341157265f5f8a747c11099847056a229a",
"symbol": "test1124"
}
]
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ------------------------- |
| network | Selected network: `main`. |
| address | Address. |
## Get Token Transactions
This endpoint retrieves the transactions for a given token.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token///tx
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "https://api.whatsonchain.com/v1/bsv/main/token/c402bc341157265f5f8a747c11099847056a229a/test1124/tx"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"redeem_addr": "c402bc341157265f5f8a747c11099847056a229a",
"symbol": "test1124",
"txs": [
"cf3968e6950286cf94aa9efb7a1cc1b9c74190d159ff6d2a4dc7d9feb6e50c55",
"b00bcc9dfc7dd483ff989f3d1d3f091b23e88ca2207c9e15788e3e84a5b10c8b",
"72ae93f5fdc5a4fa5abfab780d7d1c8ad988d25ae34578b80dce5ff9e5c3db03"
]
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | --------------------------------------------- |
| network | Selected network: `main`. |
| tokenId | Unique ID of the token. |
| symbol | Symbol used in the registration of the token. |
## Get Token Output Details
This endpoint returns the details of a valid token output or *Not Found (404)* for an invalid token output.
{% code title="HTTP Request" %}
```
GET https://api.whatsonchain.com/v1/bsv//token/tx//out/
```
{% endcode %}
{% code title="Example Request" %}
```shell
curl --location --request GET "wget -O- https://api.whatsonchain.com/v1/bsv/main/token/tx/cf3968e6950286cf94aa9efb7a1cc1b9c74190d159ff6d2a4dc7d9feb6e50c55/out/1"
```
{% endcode %}
{% code title="Example Response" %}
```json
{
"has_data": true,
"icon_url": "https://firebasestorage.googleapis.com/v0/b/nftdev/o/nftTemp%2FWL1DdD?alt=media",
"index": 1,
"is_splittable": true,
"symbol": "test1124",
"token_id": "c402bc341157265f5f8a747c11099847056a229a",
"txid": "cf3968e6950286cf94aa9efb7a1cc1b9c74190d159ff6d2a4dc7d9feb6e50c55",
"value": 2000
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ------------------------- |
| network | Selected network: `main`. |
| txid | Transaction ID. |
| index | Output/Vout index. |
### Need an additional API endpoint?
If you want to make a request for an additional API endpoint that would help with your use case, please reach out to us using our [WoC Telegram channel](http://t.me/+SNmGhFqKVB9kf%E2%80%A6). Please provide as much detail on what you're trying to achieve as possible.
# Change Log
These are the most recent changes and additions to the API:
* 07/21/2025
* Removing deprecated endpoints:
* (Un)Spent Transaction Outputs - Get UTXOs by Address
* (Un)Spent Transaction Outputs - Bulk UTXOs by Address
* (Un)Spent Transaction Outputs - Get UTXOs by Script
* (Un)Spent Transaction Outputs - Bulk UTXOs by Script
* Address - Get Balance
* Address - Bulk Balance
* Address - Get History
* Script - Get Script History
* 07/14/2025
* Adding basic BTC support to existing endpoint groups:
* [Health](/core-products/whatsonchain/health)
* [Chain Info](/core-products/whatsonchain/chain-info)
* [Block](/core-products/whatsonchain/block)
* [Transaction](/core-products/whatsonchain/transaction)
* [Mempool](/core-products/whatsonchain/mempool)
* [(Un)Spent Transaction Outputs](/core-products/whatsonchain/un-spent-transaction-outputs)
* [Address](/core-products/whatsonchain/address)
* [Script](/core-products/whatsonchain/script)
* [Exchange Rate](/core-products/whatsonchain/exchange-rate)
* [Search](/core-products/whatsonchain/search)
* [Stats](/core-products/whatsonchain/stats)
* Removing
* Transaction - Download Receipt
* 04/25/2025
* New
* WebSockets - [WoC Sockets V2](/core-products/whatsonchain/websockets/woc-sockets-v2-beta)
* Changes
* Deprecated WebSockets - [WoC Sockets V1](/core-products/whatsonchain/websockets/woc-sockets-v1-deprecated)
* Removed the Confirmed Transactions endpoint in WoC Sockets V1
* 12/31/2024
* Changes
* Transaction - [Get Merkle Proof](/core-products/whatsonchain/transaction#get-merkle-proof)
* 12/02/2024
* New
* Tokens - [1Sat Ordinals (Beta)](/core-products/whatsonchain/tokens/1sat-ordinals-beta)
* 10/22/2024
* New
* Transaction - [Get a Transaction as Binary](/core-products/whatsonchain/transaction#get-a-transaction-as-binary)
* 09/09/2024
* Changes
* (Un)Spent Transaction Outputs - [Get Confirmed UTXOs by Address](/core-products/whatsonchain/un-spent-transaction-outputs#get-confirmed-utxos-by-address-beta)
* (Un)Spent Transaction Outputs - [Get Confirmed UTXOs by Script](/core-products/whatsonchain/un-spent-transaction-outputs#get-confirmed-utxos-by-script-beta)
* 10/05/2024
* Changes
* Block - [Get Header by Hash or Height](/core-products/whatsonchain/block#get-header-by-hash-or-height)
* 19/03/2024
* New
* Address - [Get Associated Scripthashes](/core-products/whatsonchain/address#get-associated-scripthashes)
* Address - [Bulk History (Beta)](/core-products/whatsonchain/address#bulk-history-beta)
* 21/11/2023
* New
* (Un)Spent Transaction Outputs - [Bulk Spent Transaction Outputs (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#bulk-spent-transaction-outputs-beta)
* 15/11/2023
* New
* (Un)Spent Transaction Outputs - [Bulk Unconfirmed UTXOs by Address (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#bulk-unconfirmed-utxos-by-address-beta)
* (Un)Spent Transaction Outputs - [Bulk Confirmed UTXOs by Address (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#bulk-confirmed-utxos-by-address-beta)
* (Un)Spent Transaction Outputs - [Bulk Unconfirmed UTXOs by Script (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#bulk-unconfirmed-utxos-by-script-beta)
* (Un)Spent Transaction Outputs - [Bulk Confirmed UTXOs by Script (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#bulk-confirmed-utxos-by-script-beta)
* Address - [Bulk Unconfirmed Balance (Beta)](/core-products/whatsonchain/address#bulk-unconfirmed-balance-beta)
* Address - [Bulk Confirmed Balance (Beta)](/core-products/whatsonchain/address#bulk-confirmed-balance-beta)
* Address - [Bulk Unconfirmed History (Beta)](/core-products/whatsonchain/address#bulk-unconfirmed-history-beta)
* Address - [Bulk Confirmed History (Beta)](/core-products/whatsonchain/address#bulk-confirmed-history-beta)
* Script - [Bulk Unconfirmed Script History (Beta)](/core-products/whatsonchain/script#bulk-unconfirmed-script-history-beta)
* Script - [Bulk Confirmed Script History (Beta)](/core-products/whatsonchain/script#bulk-confirmed-script-history-beta)
* 26/10/2023
* New
* (Un)Spent Transaction Outputs - [Get Confirmed UTXOs by Address (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#get-confirmed-utxos-by-address-beta)
* (Un)Spent Transaction Outputs - [Get Confirmed UTXOs by Script (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#get-confirmed-utxos-by-script-beta)
* (Un)Spent Transaction Outputs - [Get Unconfirmed Spent Tx Output (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#get-unconfirmed-spent-tx-output-beta)
* (Un)Spent Transaction Outputs - [Get Confirmed Spent Tx Output (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#get-confirmed-spent-tx-output-beta)
* (Un)Spent Transaction Outputs - [Get Spent Transaction Output (Beta)](/core-products/whatsonchain/un-spent-transaction-outputs#get-spent-transaction-output-beta)
* Address - [Get Confirmed Balance (Beta)](/core-products/whatsonchain/address#get-confirmed-balance-beta)
* Address - [Get Confirmed History (Beta)](/core-products/whatsonchain/address#get-confirmed-history-beta)
* Script - [Get Confirmed Script History (Beta)](/core-products/whatsonchain/script#get-confirmed-script-history-beta)
* 28/07/2023
* New
* Address - [Get Address Usage Status](/core-products/whatsonchain/address#get-address-usage-status)
* Script - [Get Script Usage Status](/core-products/whatsonchain/script#get-script-usage-status)
* 07/07/2023
* New
* Address - [Get Mempool Balance](/core-products/whatsonchain/address#get-mempool-balance-beta)
* Address - [Get Mempool History](/core-products/whatsonchain/address#get-mempool-history-beta)
* Address - [Get Unspent Mempool Transactions](/core-products/whatsonchain/address#get-unspent-mempool-transactions-beta)
* Script - [Get Mempool History](/core-products/whatsonchain/script#get-mempool-script-history-beta)
* Script - [Get Script Mempool Unspent Transactions](/core-products/whatsonchain/script#get-script-mempool-unspent-transactions-beta)
* 03/05/2023
* New
* On-Chain Data - [Get OP\_RETURN Data by Tx Hash](/core-products/whatsonchain/on-chain-data#get-op_return-data-by-tx-hash)
* 20/04/2023
* New
* Transaction - [Get Transaction Propagation Status](/core-products/whatsonchain/transaction#get-transaction-propagation-status)
* 16/03/2023
* New
* [Output Tags](/core-products/whatsonchain/output-tags) (documentation only)
* 21/02/2023
* New
* Block - [Get Header Byte File Links](/core-products/whatsonchain/block#get-header-bytes-file-links)
* Block - [Get Latest Header Bytes](/core-products/whatsonchain/block#get-latest-header-bytes)
* 20/10/2022
* New
* Stats - [Get tag count by height](/core-products/whatsonchain/stats#get-tag-count-by-height)
* 18/10/2022
* New
* Stats - [Get miner block stats](/core-products/whatsonchain/stats#get-miner-block-stats)
* Stats - [Get miner summary stats](/core-products/whatsonchain/stats#get-miner-summary-stats)
* 13/10/2022
* New
* Stats - [Get block stats by height](/core-products/whatsonchain/stats#get-block-stats-by-height)
* Stats - [Get block stats by hash](/core-products/whatsonchain/stats#get-block-stats-by-hash)
* 10/10/2022
* New
* Chain info - [Get peer info](/core-products/whatsonchain/chain-info#get-blockchain-info-1)
* Exchange rate - [Get historical exchange rate](/core-products/whatsonchain/exchange-rate#get-historical-exchange-rate)
* 19/07/2022
* New
* [WoC Plugins](/core-products/whatsonchain/woc-plugins)
* 11/05/2022
* New
* [STAS Token endpoints](broken://pages/lPGx1nDc1m6ZtKyZmaec)
* WebSockets - Options to filter [Mempool transactions](/core-products/whatsonchain/websockets#mempool-transactions) by the output type.
* WebSockets - Options to filter [Confirmed transactions](/core-products/whatsonchain/websockets#confirmed-transactions) by the output type.
* [WoC Widgets](/core-products/whatsonchain/woc-widgets)
* 02/03/2022
* New
* WebSockets - [Block transactions](/core-products/whatsonchain/websockets#block-transactions)
* 10/01/2022
* New
* [Get chain tips](/core-products/whatsonchain/chain-info#get-chain-tips)
* [Get block header by hash with block-headers-client response format](/core-products/whatsonchain/block#get-header-by-hash)
* 03/08/2021
* New
* [Bulk transactions status](/core-products/whatsonchain/transaction#bulk-transaction-status)
* [Bulk transactions raw data](/core-products/whatsonchain/transaction#bulk-raw-transaction-data)
* 17/06/2021
* New
* WebSockets - Adding testnet support
* 14/06/2021
* New
* WebSockets - [Chain Stats](/core-products/whatsonchain/websockets#chain-stats)
* WebSockets - Extending support for non-centrifuge [clients](/core-products/whatsonchain/websockets)
* 22/03/2021
* New
* WebSockets - [Mempool transactions](/core-products/whatsonchain/websockets#mempool-transactions)
* WebSockets - [Confirmed transactions](/core-products/whatsonchain/websockets#confirmed-transactions)
* WebSockets - [Customized events](/core-products/whatsonchain/websockets#customized-events)
* 02/03/2021
* Changes
* Deprecating WoC Merchant API. Recommended to switch to [TAAL Merchant API](broken://pages/SeU2SvmzgfcvVyV4F2HE).
* Deprecating WoC Bulk Broadcast. Recommended to switch to [TAAL Merchant AP](broken://pages/SeU2SvmzgfcvVyV4F2HE)I.
* New
* Adding [TAAL Merchant API](broken://pages/SeU2SvmzgfcvVyV4F2HE) details
* WebSockets - [New block header event](/core-products/whatsonchain/websockets#new-block-header-event)
* WebSockets - [Block headers history](/core-products/whatsonchain/websockets#block-headers-history)
* 26/11/2020
* New
* [Bulk script unspent transactions](/core-products/whatsonchain/script#bulk-script-unspent-transactions)
* [Bulk address unspent transactions](/core-products/whatsonchain/address#bulk-unspent-transactions)
* [Bulk address balance](/core-products/whatsonchain/address#bulk-balance)
* 13/07/2020
* New
* [Get block header by hash](/core-products/whatsonchain/block#get-header-by-hash)
* [Get last 10 block headers](/core-products/whatsonchain/block#get-headers)
* 25/05/2020
* New
* Merchant API - [Get Fee Quotes](broken://pages/SeU2SvmzgfcvVyV4F2HE#get-fee-quote) from multiple transaction processors
* Merchant API - [Submit tx](broken://pages/SeU2SvmzgfcvVyV4F2HE#submit-transaction) to a transaction processor
* Merchant API - [Request Transaction status](broken://pages/SeU2SvmzgfcvVyV4F2HE#query-transaction-status) from a transaction processor
* 08/03/2020
* New
* Enabled [Get raw transaction data (hex)](/core-products/whatsonchain/transaction#get-raw-transaction-data) for testnet
* Enabled [Get raw transaction output data by index (hex)](/core-products/whatsonchain/transaction#get-raw-transaction-output-data) for testnet
* [Get script history](/core-products/whatsonchain/script#get-script-history)
* [Get script unspent transactions](/core-products/whatsonchain/script#get-script-unspent-transactions)
* [Get exchange rate](/core-products/whatsonchain/exchange-rate#get-exchange-rate)
* 03/02/2020
* Changes
* Removing support of STN network from address balance, history and UTXOs endpoints
* Removing hex field from response body of [Get transaction by hash](/core-products/whatsonchain/transaction#get-by-tx-hash) request
* Limiting vout\[x].scriptPubKey.asm and vout\[x].scriptPubKey.hex size to return max 100KB in response body of [Get transaction by hash](/core-products/whatsonchain/transaction#get-by-tx-hash)
* Adding vout\[x].scriptPubKey.isTruncated flag, if data size is more than 100KB in vout\[x].scriptPubKey.hex
* Removing old merkle proof endpoint \*/tx/{txid}/merkleproof
* New
* [Get raw transaction data](/core-products/whatsonchain/transaction#get-raw-transaction-data)
* [Get raw transaction output data by index (hex)](/core-products/whatsonchain/transaction#get-raw-transaction-output-data)
* [Get Merkle Proof for transaction (Beta)](/core-products/whatsonchain/transaction#get-merkle-proof)
* 18/01/2020
* New
* [Bulk transaction details](/core-products/whatsonchain/transaction#bulk-transaction-details)
* [Get circulating supply](/core-products/whatsonchain/chain-info#get-circulating-supply)
* [Community Libraries](/core-products/whatsonchain/community-libraries)
* 18/11/2019
* New
* Bulk Broadcast transactions
* 09/11/2019
* New
* [Get merkle proof](/core-products/whatsonchain/transaction#get-merkle-proof)
* 21/10/2019
* New
* [Decode raw transaction](/core-products/whatsonchain/transaction#decode-transaction)
* 23/06/2019
* New
* [Download address statement](/core-products/whatsonchain/address#download-statement)
* [Download transaction receipt](/core-products/whatsonchain/transaction#download-receipt)
* Fixed
* [Broadcast transaction](/core-products/whatsonchain/transaction#broadcast-transaction) endpoint now returns txid on success or error msg from node on failure
* 19/05/2019
* New
* [Get address balance](/core-products/whatsonchain/address#get-balance)
* [Get address history](/core-products/whatsonchain/address#get-history)
* [Get address UTXOs](/core-products/whatsonchain/address#get-unspent-transactions)
* [Get explorer links](/core-products/whatsonchain/search#get-explorer-links)
* 22/04/2019
* New
* [Get chain info](/core-products/whatsonchain/chain-info#get-blockchain-info)
* [Get mempool info](/core-products/whatsonchain/mempool#get-mempool-info)
* [Get mempool transactions](/core-products/whatsonchain/mempool#get-mempool-transactions)
* [Get address info](/core-products/whatsonchain/address#get-address-info)
* 15/04/2019
* New
* Get Health
* [Get block by hash](/core-products/whatsonchain/block#get-by-hash)
* [Get block by height](/core-products/whatsonchain/block#get-by-height)
* [Get block pages](/core-products/whatsonchain/block#get-block-pages)
* [Get transactions by hash](/core-products/whatsonchain/transaction#get-by-tx-hash)
* [Broadcast transactions](/core-products/whatsonchain/transaction#broadcast-transaction)
# Community Libraries
Awesome community-maintained libraries
```
.---. .---.
.---|___| .-. |~~~|
.--|===| B |_ |_| |~~~|--.
| |===| I |'\ .---!~| .--| |--|
| | | T |.'\ |===| |--|%%| W | |
| | | C |\.'\ | S | |__| | O |py|
|go| | O | \ \ |===| |==| | C | |
| | | I | \.'\ | V |_|__| |~~~|__|
| |===| N | \.'\|===|~|--|%%|~~~|--|
^--^---'---^ `-'`---^-^--^--^---'--'
```
### Golang
| Description | Link |
| ---------------------------------------------- | ---------------------------------------------------- |
| Go Wrapper for WoC API by **MrZ** | [GitHub](https://github.com/mrz1836/go-whatsonchain) |
| Go Wrapper for bitcoin RPC by **Simon Ordish** | [GitHub](https://github.com/ordishs/go-bitcoin) |
### Python
| Description | Link |
| ------------------------------------------- | -------------------------------------------------- |
| Python3 Wrapper for WOC API by **AustEcon** | [GitHub](https://github.com/AustEcon/whatsonchain) |
### Node.js
| Description | Link |
| -------------------------------------------------------- | ------------------------------------------------------------------------ |
| JS Wrapper for WoC API by **baryon** | [npmjs](https://www.npmjs.com/package/whatsonchain) |
| Example: How to verify merkle proofs by **Simon Ordish** | [Gist](https://gist.github.com/ordishs/7c4d2bf77b9fe74eb044aaa5a6867fc2) |
# Transaction Processing
# TAAL Transaction Endpoints
The simplest way to broadcast transactions to BSV is to use the broadcast and the batchBroadcast endpoints. /api/v1/broadcast expects a single transaction whilst /api/v1/batchBroadcast expects a batch of them.
With both of these it is possible to send your request as text with the `application/json` mimetype or binary with the `application/octet-stream` mimetype (discussed below).
The binary format has 2 advantages:
1. The size of the request payload is half of the text equivalent.
2. Unlike with JSON, the 1st transaction in the binary stream can be processed before the entire payload has been received.
The endpoints are:
```
curl -X POST https://api.taal.com/api/v1/broadcast
curl -X POST https://api.taal.com/api/v1/batchBroadcast
```
**Please note that these endpoints require a Taal APIKey that can be obtained for free by registering at **
#### /api/v1/broadcast (`application/json`)
**Request body**
```json
{
"rawTx": "bitcoin transaction in hex..."
}
```
**Response, if successful:**
```
201 Created
text/plain
<32 byte TXID in 64 hexadecimal characters>
```
**Response, if not successful**
```json
400 Bad request
application/json
{
"status": number,
"code": number,
"error": "string"
}
```
These are the exact responses returned by the bitcoin node.
#### /api/v1/broadcast (`application/octet-stream`)
**Request body**
```
bitcoin transaction as a stream of bytes (binary)
```
**Response, if successful:**
```
201 Created
text/plain
<32 byte TXID in 64 hexadecimal characters>
```
#### /api/v1/batchBroadcast (`application/json`)
**Request body**
```json
[
{
"rawTx": "bitcoin transaction in hex..."
},
{
"rawTx": "bitcoin transaction in hex..."
},
....
]
```
#### /api/v1/batchBroadcast (`application/octet-stream`)
**Request body**
```
one or more bitcoin transactions as a stream of bytes (binary)
```
**Response for both text and binary requests:**
```json
200 OK
application/json
{
"txs": [
{
"txid": "<32 byte TXID in 64 hexadecimal characters>",
"returnResult": "success or failure",
"resultDescription": "string"
}
],
"failureCount": number
}
```
The resultDescription contains the exact responses returned by the bitcoin node for each transaction.
***
# MAPI Endpoints
### MAPI endpoints (as per )
```url
curl -X GET https://api.taal.com/mapi/policyQuote
curl -X GET https://api.taal.com/mapi/feeQuote
curl -X GET https://api.taal.com/mapi/tx/{hash:[0-9a-fA-F]+}
curl -X POST https://api.taal.com/mapi/tx
curl -X POST https://api.taal.com/mapi/txs
```
These endpoints will point to the current live MAPI reference implementation.
It is also possible to access endpoints for a specific MAPI specification:
### **MAPI 1.1 endpoints (as per )**
```
curl -X GET https://api.taal.com/mapi/v1.1/feeQuote
curl -X GET https://api.taal.com/mapi/v1.1/tx/{hash:[0-9a-fA-F]+}
curl -X POST https://api.taal.com/mapi/v1.1/tx
curl -X POST https://api.taal.com/mapi/v1.1/txs
```
# Bitcoin Endpoints
### Bitcoin endpoints (only with bitcoin-enabled APIKey)
```
curl -X POST https://api.taal.com/api/v1/bitcoin
```
The possible bitcoin RPC commands that are available are:
* getbestblockhash
* gettxout
* gettxouts
* decoderawtransaction
* getrawtransaction
* getmempoolancestors
* getmempooldescendants
Examples:
```
curl \
--header 'Authorization: {APIKey}' \
--header 'Content-Type: application/json' \
--data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getinfo", "params": [] }' \
https://api.taal.com/api/v1/bitcoin
curl \
--header 'Authorization: {APIKey}' \
--header 'Content-Type: application/json' \
```
# Electrum X Endpoints
### Electrum X endpoints (only with electrum-enabled APIKey)
```
curl -X GET https://api.taal.com/api/v1/address/{address}/info
curl -X GET https://api.taal.com/api/v1/address/{address}/balance
curl -X GET https://api.taal.com/api/v1/address/{address}/history
curl -X GET https://api.taal.com/api/v1/address/{address}/unspent
curl -X GET https://api.taal.com/api/v1/address/hash/{scriptHash}/balance
curl -X GET https://api.taal.com/api/v1/address/hash/{scriptHash}/history
curl -X GET https://api.taal.com/api/v1/address/hash/{scriptHash}/unspent
curl -X POST https://api.taal.com/api/v1/addresses/balance
curl -X POST https://api.taal.com/api/v1/addresses/history
curl -X POST https://api.taal.com/api/v1/addresses/unspent
```
Examples:
```
curl \
--header 'Authorization: {APIKey}' \
https://api.taal.com/api/v1/address/1HRADRLckTpFJJskkihZp16X6jR8JVRJcr/unspent
```
# ARC Endpoints
ARC is the successor of mAPI, the merchant API.
The URL of TAAL's mainnet ARC API is:
For instance the policy could be fetched using the following `curl` command
```powershell
curl --location 'https://arc.taal.com/v1/policy' \
--header 'Authorization: '
```
A complete description of ARC API endpoints can be found under the following link: .
It is recommended to use the BIP-239 transaction format for submitting transactions to ARC.
More information about ARC can be found under these links
* High-level documentation:
* Github repository:
* Description of BIP-239 standard:
### ARC Testnet
URL: [`https://arc-test.taal.com/v1`](https://arc-test.taal.com/v1)
# Transaction format and fee rate
### Fee rate
The current standard fee rate which applies to all transactions submitted to any of the TAAL transaction processing APIs is: 100 sat/kb
The minimum fee for any transaction is 100 sat/kB.
The fee required is rounded depending on size of the transaction. The following list exemplifies the logic:
* Transactions with 1.4999... kb > size > 0.0 kb => min absolute fee required = 1 sat.
* Transactions with 2.4999... kb > size > 1.5 kb => min absolute fee required = 2 sat
* Transactions with 3.4999... kb > size > 2.5 kb => min absolute fee required = 3 sat
* ...
### Transaction format
The format of transaction is bound to the standard of BSV transactions as described [here](https://wiki.bitcoinsv.io/index.php/Bitcoin_Transactions).
There is a number of libraries which allow to build BSV transactions. Here is a short list:
*
*
#### Javascript example using version 1 of bsv.js and request modules
1. Create a new Node.js project:
```bash
mkdir example
cd example
npm init -y
npm install bsv@1
npm install request
```
2. Save the following code to a main.js in your example folder:
```javascript
const fs = require('fs')
const bsv = require('bsv')
// Random key produced each time...
const newKey = bsv.PrivateKey()
console.log(`Private key: ${newKey.toString()}`)
console.log(`Mainnet address: ${newKey.toAddress('mainnet').toString()}`)
console.log(`
1. Create a funding transaction by sending 1000 satoshis (0.00001 BSV) to ${newKey.toAddress('mainnet').toString()}.
2. Add your Taal apiKey, and funding transaction txid and vout to 'generated.js'.
3. Execute the generated code:
node generated.js
`)
fs.writeFileSync('generated.js', `
const bsv = require('bsv')
var request = require('request')
const privKey = bsv.PrivateKey('${newKey}')
const apiKey = "" // Add Taal mainnet API Key
const fundingTxid = "" // Add the funding transaction txid
const fundingVout = -1 // Replace with funding transaction vout
const returnAddress = "" // The address to return the 1000 satoshis (less fees)
if (apiKey === "" || fundingTxid === "" || fundingVout === -1 || returnAddress === "") {
console.log('This generated file needs an apiKey, a fundingTxid, a fundingVout and a returnAddress')
process.exit(1)
}
const utxo1 = {
txId: fundingTxid,
outputIndex: fundingVout,
address: privKey.toAddress('mainnet').toString(),
script: bsv.Script.buildPublicKeyHashOut(privKey.publicKey).toHex(),
satoshis: 1000
}
const tx1 = bsv.Transaction()
.from(utxo1)
.to(privKey.toAddress('mainnet').toString(), 800)
.change(returnAddress)
.sign(privKey)
const utxo2 = {
txId: tx1.hash,
outputIndex: 0,
address: privKey.toAddress('mainnet').toString(),
script: bsv.Script.buildPublicKeyHashOut(privKey.publicKey).toHex(),
satoshis: 800
}
const tx2 = bsv.Transaction()
.from(utxo2)
.change(returnAddress)
.sign(privKey)
const txBuffer = Buffer.concat([
tx1.toBuffer(),
tx2.toBuffer()
])
// Send the transaction to Taal API...
request.post({
url: 'https://api.taal.com/api/v1/batchBroadcast',
headers: {
'Authorization': apiKey,
'Content-Type': 'application/octet-stream'
},
body: txBuffer
}, function(error, response, body) {
console.log(error, response.statusCode, body)
})
`)
```
3. Execute the code and follow the onscreen instructions:
```bash
node main.js
```
# TAAL Wallet
# Introduction
TAAL Wallet is a non-custodial chrome extension for managing native BSV and tokens.
The following are the features of TAAL Wallet:
* Ability to connect a wallet to a web application.
* Manage and store your keys locally.
* Send and receive native BSV transactions
* Sign token transactions
### System Requirements
The following are the system requirements for the TAAL Wallet:
* TAAL Wallet works only with Google Chrome web browser.
# Architecture
List of tech stack used
TAAL Wallet Chrome extension is built using React and Typescript.
## **Features**
* [React 18](https://reactjs.org/)
* [Redux Toolkit](https://redux-toolkit.js.org/)
* [BSV Javascript library](https://github.com/moneybutton/bsv)
* [TypeScript](https://www.typescriptlang.org/)
* [Webpack](https://webpack.js.org/)
* [ESLint](https://eslint.org/)
* [Prettier](https://prettier.io/)
* [Chrome Extension Manifest Version 3](https://developer.chrome.com/docs/extensions/mv3/intro/)
## Chrome Extension Documentation
* [ChromeExtension](https://developer.chrome.com/docs/extensions/mv3/)
## Communication
### Long lived connection
#### In background.js
```
chrome.runtime.onConnectExternal.addListener(port => {
console.log('Client connected', port);
port.onMessage.addListener(msg => {
console.log('onExternalMessage', msg);
});
});
```
#### In web page
```
const port = chrome.runtime.connect(extensionId, { name: 'some-name' });
port.onMessage.addListener(console.log);
port.postMessage({ payload: 'anything' })
```
#### In content script
```
const port = chrome.runtime.connect({ name: 'some-name' });
port.postMessage({ payload: 'anything' });
port.onMessage.addListener(msg => {
console.log('onMessage', msg);
});
```
### One time communication (web -> background.js)
#### In background.js
```
chrome.runtime.onMessageExternal.addListener((payload, data, cb) => {
console.log('onMessageExternal', { payload, data });
if (typeof cb === 'function') {
cb('response from background.js');
}
return true;
});
```
#### In web page
```
chrome.runtime.sendMessage(extensionId, { payload: 'anything' }, console.log)
```
#### In content script
```
chrome.runtime.sendMessage({ payload: 'anything' }, console.log);
```
# Terminology
#### Send BSV
Ability for the user to send satoshis to a valid address on the network.
#### Receive BSV
reveals a BSV address or QR code.
#### History
It shows the history of transaction with transaction ID and block height.
#### Add account
Ability for the user to add new account by creating new wallet with password, network selection and mnemonics .
#### Satoshis
The smallest indivisible unit is a bitcoin. 1E8 Satoshis = 1 bitcoin
#### Recovery phrase (also called seed phrase or mnemonic phrase)
A recovery phrase is a group of words, usually 12 or more that are generated when a new crypto wallet is created. You can use the recovery phrase to retrieve your crypto accounts, using any compatible wallet.
#### Passphrase
The Passphrase is an advanced feature that adds a 13th word of your choosing to your recovery phrase.
Using a Passphrase will cause an entirely different set of addresses to be created which cannot be accessed via the 12-word recovery phrase alone.
Aside of adding another layer, the Passphrase grants you plausible deniability when under duress.
If using a Passphrase, it’s key to store it securely and remember it perfectly, character for character.
#### Get Balance
Enables user to get the latest balance reflected in the account.
#### Airdrop
Testnet only. Will send a small amount of BSV test coins to your account.
# UI Elements
## Welcome to TAAL Wallet window
This is the welcome window of the TAAL Wallet.
Start by creating a new wallet or recovering an existing one
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| CREATE A WALLET button | Displays the *Create a new Wallet* window, where you can create a new wallet. |
| IMPORT WALLET button | Displays the *Import your Wallet* window, where you can import an existing wallet if you have the secret recovery phrase. |
## Create a new wallet window
You can use this window to create a new wallet.
**To reach this window**: On the *Welcome to TAAL Wallet* window, click **CREATE A WALLET** or on the *Wallet* window, click on **Add new account**.
Step 1
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Account name field | The name of the account. This field is mandatory. |
| Password field | The 8 characters password for the account. This field is mandatory. |
| Repeat password field | The password for the account same as provided in the previous field. This field is mandatory. |
| Network drop-down list |
The available networks, and the options are:
Testnet
Mainnet
This field is mandatory.
|
| Recovery phrase |
It is a group of words, usually 12 or more that are generated when a new crypto wallet is created. Note: Here is your 12 words recovery phrase. It is incredibly important to take a note of this and keep it safe as without you may lose access to your wallet and the funds contained within.
|
## Import your Wallet window
You can use this window to import an existing wallet.
**To reach this window**: On the *Welcome to TAAL Wallet* window, click **IMPORT WALLET** or on the *Wallet* window, click > **Import account**.
Recover an account secured with a standard recovery phrase
Recover an account secured with a standard recovery phrase and a passphrase
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| create a new one button | Displays the *Create a new Wallet* window, where you can create a new wallet. |
| Account name field | The name of an existing account. This field is mandatory. |
| Password field | The 8 characters password for the account. This field is mandatory. |
| Repeat password field | The password for the account same as provided in the previous field. This field is mandatory. |
| Network drop-down list |
The available networks, and the options are:
Testnet
Mainnet
This field is mandatory.
|
| Recovery phrase field | It is a group of words, usually 12 or more that are generated when a new crypto wallet is created. |
| Passphrase | The Passphrase is an advanced feature that adds a 13th word of your choosing to your recovery phrase. |
## Wallet main window
The main window of the TAAL Wallet.
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| button | Displays the wallets and selected network. |
| Add new account button | Displays the *Create a new Wallet* window, where you can create a new wallet. |
| Import account button | Displays the *Import your Wallet* window, where you can import an existing wallet. |
| button | Displays all the menu options available. |
| Home button | Displays *Home* window. |
| Select Wallet button | Displays the *Your Wallets* window, where you can select the Wallet you want. |
| Send BSV button | Displays the *Send BSV* window, where you can send satoshis to a valid address on the network. |
| Receive BSV button | Displays the *Receive BSV* window, where you can view the BSV address or QR code of the account. |
| History button | Displays the *Your Wallet's history* window, where you can view the history of transaction with transaction ID and block height. |
| Tokens button | Displays the *Your Tokens* window, where you can view the tokens. |
| Options button | Display the Access Control List window, where you can view and delete the Websites with access to TAAL Wallet. |
| Airdrop button | Testnet only. Will send a small amount of BSV test coins to your account. |
| Lock Wallet button | Locks the wallet. |
## Home window
This window displays the current account, wallets details, and balance.
**To reach this window**: on the *Wallet* main window, click > **Home**.
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Current account | The name of the current account. |
|  | Edits the name of the current account. |
| Name field | The name of the wallet. |
| Path field | The path of the wallet |
| Address field | The address of the wallet. |
| Balance field | The balance in satoshis available in the wallet. |
| Updated at field | The date and time when the wallet was last updated. |
| SELECT ANOTHER WALLET button | Displays the *Your Wallets* window, where you can view the wallets available in your current account, and you can select the wallet you want. |
| Balance |
The balance in
satoshis available in the current account.
|
| Refresh balance or refresh button | Refreshes the balance. |
| SEND BSV button | Displays the *Send BSV* window, where you can send satoshis to a valid address on the network. |
| RECEIVE BSV button | Displays the *Receive BSV* window, where you can view the BSV address or QR code of the account. |
| HISTORY button | Displays the *Your Wallet's history* window, where you can view the history of transaction with transaction ID and block height. |
| TOKENS button | Displays the *Your Tokens* window, where you can view the tokens. |
## Your Wallets window
This window displays the wallets available in your current account, and you can select the wallet you want.
**To reach this window**: On the *Wallet* main window, click > **Select Wallet**, or on the *Home* window, click **SELECT ANOTHER WALLET**.
The following table describes the UI elements available on this window.
| UI Elements | Description |
| -------------------------- | --------------------------------------------------------------------------------- |
| CREATE A NEW WALLET button | Display the *Create a New Wallet* window, where you can create a new wallet. |
| Wallet section | Display the wallet details, such as Name, address, Path, Balance, and Updated at. |
| SELECT button | Enables you to select the wallet you want. |
## Send BSV window
You can use this window to send satoshis to a valid address on the network.
**To reach this window**: On the *Wallet* main window, click > **Send BSV** or on the *Home* window, click **SEND BSV**.
The following table describes the UI elements available on this window.
| UI Elements | Description |
| -------------------------------------- | ------------------------------------------------------------------------ |
| Destination address field | The address to which you want to send satoshis. This field is mandatory. |
| Amount in satoshis (max 1002500) field | The amount in satoshis you want to send. This field is mandatory. |
| CANCEL button | Cancels the transaction. |
| SEND button | Sends satoshis to a valid address on the network. |
## Receive BSV
This window displays the BSV address or QR code of the account.
{% hint style="info" %}
It works only with BSV. If you send any other cryptos, it will result in the loss of funds.
{% endhint %}
**To reach this window**: On the *Wallet* main window, click > **Receive BSV** or on the *Home* window, click **RECEIVE BSV**.
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ------------------------------------------------------------------------------------------- | -------------------------------------- |
| Your BSV address: field | The BSV address of the account. |
| Click to copy button | Copies the BSV address of the account. |
| QR code | The QR code of the account. |
## Your Wallet's history window
This window displays the history of transaction with transaction ID and block height.
**To reach this window**: On the *Wallet* main window, click > **History** or on the *Home* window, click **HISTORY**.
The following table describes the UI elements available on this window.
| UI Elements | Description |
| ---------------------- | ------------------------------------- |
| Refetch history button | Retrieves the history of the wallets. |
| TX ID field | The ID of the transaction. |
## Your token window
This view displays the tokens.
**To reach this window**: On the *Wallet* main window, click > **Tokens** or on the *Home* window, click **TOKENS**.
## Access Control List window
This window displays the Websites with access to TAAL Wallet, and you can also delete them.
**To reach this window**: On the *Wallet* main window, click > **Options**.
# Tutorial
## Install TAAL Wallet from Chrome Web Store
The following are the steps to install TAAL Wallet in your system from Chrome Web Store:
1. Go to [Chrome Web Store](https://chrome.google.com/webstore). \
The *chrome web store* window is displayed.
2. In the **Search the store** field, search for TAAL Web3 Wallet.
3. Click **Add to Chrome**. \
You can see the TAAL Wallet in your extensions.
4. Click TAAL Wallet. \
The *Terms of Service agreement* window is displayed.
5. Click **ACCEPT**. \
The *Welcome to TAAL Wallet* window is displayed and you are ready to use the TAAL Wallet.
{% hint style="info" %}
TAAL Wallet works only with Google Chrome web browser.
{% endhint %}
## Install TAAL Wallet using the code from GitHub
The following are the steps to install TAAL Wallet using the code from GitHub:
1. Clone the code available at: .
2. In your **Command Prompt**, go to the working directory.
3. Run `yarn.`
4. Run`yarn dev.`
5. Go to the Google Chrome web browser.
6. Click **Extensions** > **Manage Extensions**.\
The *Extensions* window is displayed.
7. In the *Extensions* window, enable **Developer mode**.
8. Click **Load unpacked**.\
The **Select the extension directory.** dialog box is displayed.
9. In the **Select the extension directory.** dialog box, select the **dist** folder from the project.\
The TAAL Wallet extension is available in your **Extensions**.
10. Click TAAL Wallet. \
The *Terms of Service agreement* window is displayed.
11. Click **ACCEPT**. \
The *Welcome to TAAL Wallet* window is displayed and you are ready to use the TAAL Wallet.
### Customise the password length
Copy `sample.env` to `.env` and customise it with your requirements, Eg. PASSWORD\_MIN\_LENGTH=1
## Create a new Wallet
The following are the steps to create a wallet:
1. On the *Welcome to TAAL Wallet* window, click **CREATE A WALLET** or on the *Wallet* window, click > **Add new account**. \
The *Create a new wallet* window is displayed.
2. In the **Account name** field, enter the account name.
3. In the **Password** field, enter the 8 characters password.
4. In the **Repeat password** field, repeat the password.
5. In the **Network** list, select the network, such as Taalnet, Testnet, and Mainnet.
6. In the **Secret phase** field, you are provided with the 12 words seen phrase.
7. Click **NEXT**. \
A new wallet is created.
## Import an existing Wallet
The following are the steps to import an existing wallet:
1. On the *Welcome to TAAL Wallet* window, click **IMPORT WALLET** or on the *Wallet* window, click > **Import account**. \
The *Import your Wallet* window is displayed.
2. In the **Account name** field, enter the name of an existing account.
3. In the **Password** field, enter the 8 characters password.
4. In the **Repeat password** field, repeat the password.
5. In the **Network** list, select the network, such as Taalnet, Testnet, and Mainnet.
6. In the **Secret phase** field, enter the 12 words seen phrase provided when you created the this account.
7. Click **NEXT**. \
An existing wallet is imported.
## Create a new Wallet in the current account
The following are the steps to create a new wallet in the current account:
1. On the **Wallet** main window, click > **Select Wallet**.\
The *Your Wallets* window is displayed.
2. On the *Your Wallets* window, click **CREATE A NEW WALLET**. \
The *Create a New Wallet* window is displayed.
3. In the **Name** field, enter the name of the wallet.
4. Click **NEXT**. \
A new wallet is created
## Send BSV
The following are the steps to send BSV:
1. On the *Wallet* main window, click > **Send BSV** or on the *Home* window, click **SEND BSV**. \
The *Send BSV* window is displayed.
2. In the **Destination address** field, enter the address to which you want to send satoshis.
3. In the **Amount in satoshis (max 1002500)** field, enter the amount in satoshis you want to send.
4. Click **SEND**. \
The satoshis is sent to a valid address on the network.
## Receive BSV
1. On the *Wallet* main window, click > **Receive BSV** or on the *Home* window, click **RECEIVE BSV**. \
The *Receive BSV* window is displayed.
2. Click to copy the BSV address of the account or scan the QR code.
## View History
**To view History**: On the *Wallet* main window, click > **History** or on the *Home* window, click **HISTORY**. \
The *Your Wallet's history* window is displayed in which you can view the history of transaction with transaction ID and block height.
## Airdrop
**To airdrop**: On the *Wallet* main window, click > **Airdrop**. \
**Testnet** only. Will send a small amount of BSV test coins to your account.
# 1Sat Ordinals tokens API
# Introduction
1SatOrdinals in an implementation of Ordinals running on the BSV blockchain.
See the [Protocol Specification | 1Sat Ordinals](https://docs.1satordinals.com/) for more information on 1Sat Ordinals and the [Ordinals Docs](https://docs.ordinals.com/) for more information on Ordinals and ordinal theory.
# Terminology
**Satoshis**
The smallest indivisible unit of a bitcoin. 1E8 Satoshis = 1 bitcoin
**Script**
Low level bitcoin script.
**SDK**
Software Developer Kit is a software library to make certain tasks easier for a software developer.
**UTXO**
An Unspent Transaction Output is an amount of bitcoin that can be spent by the recipient.
**Inscription ID**
An outpoint representing a particular inscription, comprised of a transaction ID and output index with the following formatting: \`txid\_vout\`
**Inscription Number**
This is an auto-incrementing id given to each inscription as they appear in mined blocks, starting with inscription #0. Because inscription numbers are dependent on the order of transactions in a block, inscription numbers are not assigned until a transaction is confirmed. This also makes inscription number sensitive to reorgs.
**Origin**
This is like a "low resolution" ordinal number. It represents the last time a particular ordinal became a 1 satoshi output. Since utxos can be split and joined over time, an ordinal can have more than one origin. This is a 1Sat protocol specific concept, not present in the original ordinals protocol.
**Ordinal Number**
An ordinal is an identifier given to a specific satoshi. It is given when the sat comes into existence during a coinbase transaction. To learn more about this concept read the original "ordinal theory" documentation.
# Flow Diagram
# Basic Tutorial - Node
**Github Repository**
[**https://github.com/TAAL-GmbH/1sat-tutorial**](https://github.com/TAAL-GmbH/1sat-tutorial)
`mkdir 1sat-tutorial`
cd `1sat-tutorial`
Demo code using our 1Sat Token Studio API can be found on Github so you can clone our repository or if you want to do it manually, we need to make now a node project
`npm init`
and answer in the questions.
Let’s add the dependencies\
`npm install bsv@1.5.4` \
`npm install axios`
Make sure your package.json looks like this (you might need to change the type to “module” and add a new entry to run the tutorial- `"tutorial": "node index.js"`\
`{ "name": "1sat-tutorial",` \
`"version": "1.0.0",` \
`"description": "1sat-tutorial",` \
`"type": "module",` \
`"main": "index.js",` \
`"scripts": { "test": "echo \"Error: no test specified\" && exit 1",` \
`"tutorial": "node index.js"` \
`},`\
`"author": "TAAL",`\
`"license": "ISC",` \
`"dependencies": {` \
`"dependencies": { "axios": "^1.7.2",` \
`"bsv": "^1.5.4"` \
`}` \
`}`
Now we are ready to start coding. Create the main file you specified during the setup e.g. `index.js`in the root of the `1sat-tutorial` folder as well as the helping file 1sat\_utils.cjs using your editor or IDE of choice.
1. Copy the code from our files and paste.
2. in index.js you will need to replace the sample API key from your TAAL API Key
3. You can also tune which steps to run, only the creation of a single/standalone token, the inscription of a collection with one item or individual steps you may want to debug in depth e.g.\
`const STEPS_TO_TEST =[ 'single', 'collection'];` \
`///const STEPS_TO_TEST =['1.1','1.2','1.3','1.4','1.5', '1.6', '1.7']; //const STEPS_TO_TEST =['2.1','2.2','2.3','2.4','2.5', '2.6', '2.7', '2.8', '2.9'];`
You can test now. If all was properly configured you should see something like this:
Add label
# Basic Tutorial - Postman
You can download our Postman Collection from here:
Once imported you will need to type in your personal values in the 1.1 Create Project Pre-request script
Once done, you can go through the steps one by one to create:
1.- A Standalone token (HTML token)
2.- A Collection (Image Token) with one collectionItem (Text token)
# API
This API will allow you to create 1SatOrdinals Single and Collection Tokens.
## Common
#### An Api Key must be passed in the header of all requests see [Authentication](broken://pages/sscPhAYRcbx6gUatghiE#authentication)
## Create a Token Studio Project for your Standalone - Collection
{% code title="HTTP Request" %}
```
POST https://platform.taal.com/token-studio/api/v1/project/create
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location 'https://platform.taal.com/token-studio/api/v1/project/create' \
--header 'Apikey: ## VALID_API_KEY ##' \
--header 'Content-Type: application/json' \
--data '{
"name": "1satcol project 1718100516565",
"isFungible": false,
"type": "single", //"collection"
"tokenProtocol": "OneSatOrdinal"
}'
```
{% endcode %}
{% code title="Response JSON structure" %}
```json
{
"success": boolean,
"data": {
"projectUid":
}
}
```
{% endcode %}
## Get a list of your Token Studio projects
It will return all projects associated with your API Key.
{% code title="HTTP Request" %}
```
GET https://platform.taal.com/token-studio/api/v1/project/
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location 'https://platform.taal.com/token-studio/api/v1/project/' \
--header 'Apikey: ## VALID_API_KEY ##'
```
{% endcode %}
{% code title="Response JSON structure" %}
```json
{
"success": boolean,
"data": {
"projectList": [
{
"uid": ,
"name": string,
"network": string,
"offChainData": {
"isFungible": boolean
},
"tokenProtocol": string
}
]
}
}
```
{% endcode %}
## Get details for a specific project id
Returns a project for a valid project id.
{% code title="HTTP Request" %}
```
GET https://platform.taal.com/token-studio/api/v1/project/
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location 'https://platform.taal.com/token-studio/api/v1/project/' \
--header "Apikey: ## VALID_API_KEY ##"
```
{% endcode %}
{% code title="Response JSON structure" %}
```json
{
"success": true,
"data": {
"uid": ,
"name": string,
"tokenProtocol": string,
"network": string,
"isFungible": boolean,
"type": string
}
}
```
{% endcode %}
**URL Parameters**
| Parameter | Description |
| --------- | ------------------ |
| projectId | A valid project Id |
## Output creation
Creates an output (single, collection, collectinItem) in the project.
Single projects can only contain single/standalone outputs
Collection projects need first a collection output created and then one or several collectionItems linked to the initial collection output
{% code title="HTTP Request" %}
```
POST https://platform.taal.com/token-studio/api/v1/token/one-sat-ord/create-output
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location 'https://platform.taal.com/token-studio/api/v1/token/one-sat-ord/create-output' \
--header "Apikey: ## VALID_API_KEY ##" \
--header 'Content-Type: application/json' \
--data '{
"projectUid": "",
"contentType":"text/html;charset=utf8",
"b64File":"PGh0bWw+PGJvZHk+SGVsbG8gV29ybGQ8L2JvZHk+PC9odG1sPg==",
"metadata": {
"name": "My single token 1718101145907",
"subType": "single",
"subTypeData": "{\"description\": \"this is description\" }",
"type": "ord",
"description": "this is a standalone token description",
"info": "anything",
"eyes": "green"
}
}'
```
{% endcode %}
{% code title="Response JSON structure" %}
```json
{
"success": true,
"data": {
"uid": ,
"type": string,
"tokenProtocol": string
}
}
```
{% endcode %}
**Body Parameters**
Parameter
Description
subType
'single' for standalone tokens in single projects
'collection' for the seed token in collection projects
'collectionItem' for each element linked to the collection
projectUid
projectUid
contentType
contentType depending on the desired output type (text, html or image)
b64File
Raw content formatted in b64
metadata
Mandatory:
"name": NFT name
"type": "ord"
"subType": "single" //"collection" or "collectionItem",
"subTypeData": stringified JSON,
"description": string,
Other e.g. traits:
"info": "anything",
"eyes": "green"
## Output deletion
Deletes an output (single, collection, collectinItem) in the project.
{% code title="HTTP Request" %}
```
DELETE https://platform.taal.com/token-studio/api/v1/output/{{outputUid}}
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location --request DELETE 'https://platform.taal.com/token-studio/api/v1/output/{{outputUid}}' \
--header "Apikey: ## VALID_API_KEY ##" \
--header 'Content-Type: application/json'
```
{% endcode %}
{% code title="Response JSON structure" %}
````json
```json
"success": true,
"data": {
"uid": "",
"createdAt": "",
"type": "token",
"tokenProtocol": "OneSatOrdinal",
"projectUid": "",
"transactionUid": null,
"txId": null,
"identityUid": "",
"address": null,
"metadata": {
},
"offChainData": {
}
}
}
```
````
{% endcode %}
**Query Parameters**
| Parameter | Description |
| --------- | ----------------- |
| outputUid | A valid output Id |
## Output List
Returns all outputs for a valid project id.
{% code title="HTTP Request" %}
```
GET https://platform.taal.com/token-studio/api/v1/output/by-project/{{projectUid}}?on-chain=0&type=collectionItem
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location 'https://platform.taal.com/token-studio/api/v1/' \
--header "Apikey: ## VALID_API_KEY ##"
```
{% endcode %}
{% code title="Response JSON structure" %}
```json
{
"success": boolean,
"data": {
"outputList": [
{
"createdAt": ,
"uid": ,
"projectUid": ,
"transactionUid": (null if has not been used in a transaction yet),
"type": string,
"tokenProtocol": string,
"metadata": { //Key / value pairs e.g.
"app": string,
"eyes": string,
"info": string,
"name": string,
"type": string,
"subType": string,
"description": string,
"subTypeData": stringified JSON
},
"offChainData": {
"b64FileHash": string,
"b64FileSize": int,
"contentType": string
}
}
]
}
}
```
{% endcode %}
**Query Parameters**
| Parameter | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------ |
| projectUid | A valid project Id |
| on-chain | Optional. If provided, the accepted values are 0/1 (false / true) to filter by outputs already broadcast |
| type | Optional. If provided, the accepted values are collection / collectionItem, to filter by a specific type of output |
## Unsigned Transaction creation
Creates an unsigned transaction ready to sign and then be broadcast.
Unsigned transactions can refer to different outputs as well as different UTXO to be used for funding it
{% code title="HTTP Request" %}
```
POST https://platform.taal.com/token-studio/api/v1/token/one-sat-ord/create-transaction
```
{% endcode %}
{% code title="cURL" %}
```shell
curl --location 'https://platform.taal.com/token-studio/api/v1/token/one-sat-ord/create-transaction' \
--header "Apikey: ## VALID_API_KEY ##" \
--header 'Content-Type: application/json' \
--data '{
"projectUid": "",
"publicKey": ,
"dstAddress": ,
"outputList": [],
"utxoList": [
{
"outputIndex": num,
"txId": ""
}
]
}'
```
{% endcode %}
Response JSON structure
```postman_json
{
"success": boolean,
"data": {
"transactionUid": ,
"txObj": {
}
}
}
```
**Body Parameters**
Transaction Uid returned by the create transaction endpoint
txObjSigned
Signed transaction ready to be broadcast
# FAQ
#### 1. **How can I cancel a subscription?**
Subscriptions last for a month and they are automatically renewed unless you specify it. If you don’t want to renew one of your subscriptions:
* Go to “My Account”
* Unselect “Auto Renewal” for that subscription
**2. What can I do when I can’t find the subscription that I want to cancel?**
* Go to “Support”
* Create a ticket for Taal Support team.
#### 3. **How can I view my purchase history?**
* Go to “My Account”
* Click on “Invoicing & Billing”
**4. How can I change my payment method?**
* Go to “My Account”
* Click on “Invoicing & Billing” - “View More”
* Click on “Payment methods” - “Add payment method”
* Edit the desired subscription to use the new payment method.
**5. How can I request a refund?**
* Go to “Support”
* Create a ticket for Taal Support team.
**6. How can I check the status of my refund request?**
* Status of refund requests will be updated on the ticket
**7. When will I get the money back?**
* It takes about 10 business days for those valid refund cases. You will be kept informed on the ticket you raised for refund.
#### 8. **How can I get the invoice?**
* Go to “My Account”
* Click on “Invoicing & Billing”
#### 9. **What happens if I don't pay TAAL Client subscription?**
Subscription will be terminated and the corresponding API Key revoked.
**10. Will TAAL charge me after free trial?**
TAAL will only charge for the paid plans. To avoid limitations on Free keys, you will need to upgrade that specific key.
**11. Can I upgrade my account?**
In the circumstance where you change your subscription pursuant to the Transaction Processing Agreement, you must cancel your previous subscription directly with Stripe. Subscriptions through the TAAL services will continue to accrue automatic renewal charges via Stripe until such cancellation is received by Stripe.
**12. When will I be billed for my subscription?**
Billing happens at the time of subscription or renewal
**13. When will my subscription be renewed?**
Same day next month.
**14. Can I pay with PayPal?**
At the moment it is only possible to pay with Credit Card
**15. What will happen if the remaining allowance for my plan is 0?**
The usage exceeding the allowance will be billed apart
# Support
### TAAL Community
Join our [TAAL Blockchain Discord](https://discord.com/invite/rAYtUfpuhx) community for support on the Transaction Processing and STAS services.
Join our WhatsOnchain Telegram channel for support on the WhatsOnchain services:
###
# Glossary
**Blockchain**
It is a form of distributed database (or ledger) that acts as a record of all the valid transactions which are transmitted to the blockchain network.
#### Contract
An on-chain document representing the contract between token issuer and user.
#### Issue
Mint a token from an on-chain contract transaction.
#### P2PKH (Pay to public key hash)
The most common locking script used by default to send bitcoin.
#### Redeem
Destroy the token and return the locked Satoshis to the issuer.
#### Satoshis
The smallest indivisible unit of a bitcoin. 1E8 Satoshis = 1 bitcoin.
#### Script
Low level bitcoin script.
#### SDK
Software Developer Kit is a software library to make certain tasks easier for a software developer.
#### STAS
A token script named after its creator Stas. Also a reverse acronym: Substantiated Tokens from Actualized Satoshis.
#### Token
It is a type of digital property or control element that can be transferred using a blockchain.
#### UTXO
An Unspent Transaction Output is an amount of bitcoin that can be spent by the recipient.
# Acronyms and Abbreviations
| Acronym | Abbreviation |
| ------- | --------------------------------------------- |
| API | Application Programming Interface |
| BSV | Bitcoin Satoshi Vision |
| JSON | JavaScript Object Notation |
| MIME | Multipurpose Internet Mail Extensions |
| P2P | Peer-to-peer transactions |
| P2PKH | Pay to public key hash |
| SDK | Software Developer Kit |
| SPV | Simplified Payment Verification |
| STAS | Substantiated Tokens from Actualized Satoshis |
| TXID | Transaction ID |
| UTXO | Unspent Transaction Output |
***.***
## **What is TAAL?**
TAAL delivers value-added blockchain services, providing professional-grade, highly scalable blockchain infrastructure, and transactional solutions to support builders and businesses building on the BitcoinSV protocol.
## **TAAL Services**
### Transaction Processing
As a Transaction processor (or miner) TAAL validates clients transactions and time stamps them by sequencing and encoding them into blocks, which are then published and added to the BSV blockchain.
TAAL API is an easy to integrate, open communication channel to the blockchain. By connecting an application to this endpoint data, in the form of transactions, can be processed, instantly verified, and once settled this data can be viewed anytime. Creating great value to applications that require real time blockchain data at scale, now and into the future.
### Digital Asset Tokenization with the 1Sat Ordinals protocol
1SatOrdinals in an implementation of Ordinals running on the BSV blockchain. The tokens represent individual satoshis (the smallest unit of Bitcoin) that are "inscribed" with specific data, such as images or text. 1Sat Ordinals on BSV are fast, inexpensive, and fully scriptable via native Bitcoin Script.
{% content-ref url="/pages/yVYDNz3FO6mrbJNNwhec" %}
[1Sat Ordinals tokens API](/core-products/1sat-ordinals-tokens-api)
{% endcontent-ref %}
### Other benefits
* The ability to have low-cost transactions (less than a penny), which make a difference when issuers are dropping millions of NFTs, for example. This attribute means more margin for the issuers on primary and secondary markets.
* Interoperability with ecosystem wallets and other blockchain platforms.
* Transparency allows the token to be tracked throughout its lifecycle, which makes a difference in a regulatory environment.
* No network congestion — as the tokens are issued at the network level on a blockchain that scales unbounded.
You can license this technology from TAAL, download the SDK, and start building their next game-changing NFT or digital asset platform today!
{% hint style="info" %}
[Whitepaper](https://www.taal.com/wp-content/uploads/2022/01/STAS_White-Paper_20211214_1.0_Finalweb4.pdf)
{% endhint %}
{% hint style="info" %}
[TAAL Website](https://www.taal.com/)
{% endhint %}
{% hint style="info" %}
[Blog Post](https://www.taal.com/blog/)
{% endhint %}
# Get an API Key
The following are the steps to get an API key from TAAL:
1. Enter the URL 
.png?alt=media&token=0f8f2be0-7862-4009-8503-d4b75ba1577c)
.png?alt=media&token=d8125f91-d377-46e6-8d7c-fe245ae2b40a)
Protocol Specification | 1Sat Ordinals](https://docs.1satordinals.com/) for more information on 1Sat Ordinals and the [Ordinals Docs](https://docs.ordinals.com/) for more information on Ordinals and ordinal theory.
# Terminology
**Satoshis**
The smallest indivisible unit of a bitcoin. 1E8 Satoshis = 1 bitcoin
**Script**
Low level bitcoin script.
**SDK**
Software Developer Kit is a software library to make certain tasks easier for a software developer.
**UTXO**
An Unspent Transaction Output is an amount of bitcoin that can be spent by the recipient.
**Inscription ID**
An outpoint representing a particular inscription, comprised of a transaction ID and output index with the following formatting: \`txid\_vout\`
**Inscription Number**
This is an auto-incrementing id given to each inscription as they appear in mined blocks, starting with inscription #0. Because inscription numbers are dependent on the order of transactions in a block, inscription numbers are not assigned until a transaction is confirmed. This also makes inscription number sensitive to reorgs.
**Origin**
This is like a "low resolution" ordinal number. It represents the last time a particular ordinal became a 1 satoshi output. Since utxos can be split and joined over time, an ordinal can have more than one origin. This is a 1Sat protocol specific concept, not present in the original ordinals protocol.
**Ordinal Number**
An ordinal is an identifier given to a specific satoshi. It is given when the sat comes into existence during a coinbase transaction. To learn more about this concept read the original "ordinal theory" documentation.
# Flow Diagram
