OPI API

OPI API endpoints are available to use with an API Key or from allow-listed domains.

Mainnet: https://api.ordinalsbot.com/opi

Testnet: https://testnet-api.ordinalsbot.com/opi

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

OPI/modules/brc20_api/api.js at main · bestinslot-xyz/OPIGitHub

Get BRC20 Ticker Info

GET https://api.ordinalsbot.com/opi/v1/brc20/ticker_info

Query Parameters

Name	Type	Description
ticker*	String	Ticker to get information for

Headers

Name	Type	Description
x-api-key*	String	API Key

200: OK

{
    "error": null,
    "result": {
        "id": "10228",
        "original_tick": "TRIO",
        "tick": "trio",
        "max_supply": "21000000000000000000000000",
        "decimals": 18,
        "limit_per_mint": "10000000000000000000000",
        "remaining_supply": "0",
        "burned_supply": "0",
        "is_self_mint": false,
        "deploy_inscription_id": "c409d95ec5d858dcac9ef2e7b6bb57752b2e213f4e5443a252bdcc74625ec674i0",
        "block_height": 788143
    }
}

Get BRC20 Wallet Balance

GET https://api.ordinalsbot.com/opi/v1/brc20/get_current_balance_of_wallet

Query Parameters

Name	Type	Description
address*	String	Bitcoin address to check balance
ticker	String	Ticker to get balance

Headers

Name	Type	Description
x-api-key*	String	API Key

200: OK

{
    "error": null,
    "result": [
        {
            "overall_balance": "550000000000000000000",
            "available_balance": "50000000000000000000",
            "block_height": 840857,
            "tick": "trio"
        }
    ]
}

Get BRC20 Index Block Height

GET https://api.ordinalsbot.com/opi/v1/brc20/block_height

Headers

Name	Type	Description
x-api-key*	String	API Key

200: OK

838346

500: Internal Server Error

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