# Tap Reader API

**Mainnet:** <https://api.ordinalsbot.com/tapreader>

**Testnet:** <https://testnet-api.ordinalsbot.com/tapreader>

You can refer to official TAP documentation for all available endpoints.

{% embed url="<https://github.com/Trac-Systems/tap-reader/tree/main?tab=readme-ov-file#tap-protocol-api>" %}

## Get TAP Token Deployment

<mark style="color:green;">`POST`</mark> `https://api.ordinalsbot.com/tapreader/getDeployment/:ticker`

#### Path Parameters

| Name                                     | Type   | Description                              |
| ---------------------------------------- | ------ | ---------------------------------------- |
| ticker<mark style="color:red;">\*</mark> | String | Ticker to get deployment inscription for |

#### Headers

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| x-api-key<mark style="color:red;">\*</mark> | String | API Key     |

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "result": {
        "tick": "tap",
        "max": "21000000000000000000000000",
        "lim": "21000000000000000000000000",
        "dec": 18,
        "blck": 801996,
        "tx": "cbc1900b8b0f02fdf481137c587896781a721a35369d4eae47c7445622ecb671",
        "ins": "cbc1900b8b0f02fdf481137c587896781a721a35369d4eae47c7445622ecb671i0",
        "num": 21953432,
        "ts": 1691356378,
        "addr": "bc1pcf4jawvk9gjhjske5mch045szhtgsgpt4df5ftnqpxlc27qtaxyqxxmjsf",
        "crsd": false,
        "dmt": false,
        "elem": null,
        "prj": null,
        "dim": null,
        "dt": null
    }
```

{% endtab %}

{% tab title="500: Internal Server Error " %}

```
{
    status: 'error',
    error: 'error reason'
}
```

{% endtab %}
{% endtabs %}