> For the complete documentation index, see [llms.txt](https://ratspro.gitbook.io/white-paper/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ratspro.gitbook.io/white-paper/guides/explorer.md).

# Explorer

The RatsPro binary includes a block explorer. We host a instance of the block explorer on mainnet, and on signet .

#### Running The Explorer <a href="#running-the-explorer" id="running-the-explorer"></a>

The server can be run locally with:

RatsPro `server`

To specify a port add the `--http-port` flag:

RatsPro `server --http-port 8080`

To enable the JSON-API endpoints add the `--enable-json-api` or `-j` flag:

RatsPro `server --enable-json-api`

To test how your inscriptions will look you can run:

RatsPro `preview <FILE1> <FILE2> ...`

### Search <a href="#search" id="search"></a>

The search box accepts a variety of object representations.

#### Blocks <a href="#blocks" id="blocks"></a>

Blocks can be searched by hash, for example

#### Transactions <a href="#transactions" id="transactions"></a>

Transactions can be searched by hash, for example

#### Outputs <a href="#outputs" id="outputs"></a>

Transaction outputs can searched by outpoint

### Rats

Rats can be searched by integer, their position within the entire bitcoin supply:

2099994106992659

By decimal, their block and offset within that block:

481824.0

By degree, their cycle, blocks since the last halving, blocks since the last difficulty adjustment, and offset within their block:

1°0′0″0‴

By name, their base 26 representation using the letters "a" through "z":

ahistorical

Or by percentile, the percentage of bitcoin's supply that has been or will have been issued when they are mined:

100%

### JSON-API <a href="#json-api" id="json-api"></a>

You can run RatsPro `server` with the `--enable-json-api` flag to access endpoints that return JSON instead of HTML if you set the HTTP `Accept: application/json` header. The structure of theses objects closely follows what is shown in the HTML. These endpoints are:

* `/inscription/<INSCRIPTION_ID>`
* `/inscriptions`
* `/inscriptions/block/<BLOCK_HEIGHT>`
* `/inscriptions/block/<BLOCK_HEIGHT>/<PAGE_INDEX>`
* `/inscriptions/<FROM>`
* `/inscriptions/<FROM>/<N>`
* `/output/<OUTPOINT>`
* `/output/<OUTPOINT>`
* `/sat/<SAT>`

To get a list of the latest 100 inscriptions you would do:

```
curl -s -H "Accept: application/json" 'http://0.0.0.0:80/inscriptions'
```

To see information about a UTXO, which includes inscriptions inside it, do:

```
curl -s -H "Accept: application/json" 'http://0.0.0.0:80/output/bc4c30829a9564c0d58e6287195622b53ced54a25711d1b86be7cd3a70ef61ed:0'
```

Which returns:

```
{
  "value": 10000,
  "script_pubkey": "OP_PUSHNUM_1 OP_PUSHBYTES_32 156cc4878306157720607cdcb4b32afa4cc6853868458d7258b907112e5a434b",
  "address": "bc1pz4kvfpurqc2hwgrq0nwtfve2lfxvdpfcdpzc6ujchyr3ztj6gd9sfr6ayf",
  "transaction": "bc4c30829a9564c0d58e6287195622b53ced54a25711d1b86be7cd3a70ef61ed",
  "sat_ranges": null,
  "inscriptions": [
    "6fb976ab49dcec017f1e201e84395983204ae1a7c2abf7ced0a85d692e442799i0"
  ]
}
```
