SNS API

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

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

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

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

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

Get SNS Info

GET https://api.ordinalsbot.com/sns/v1/sns/get_info_of_sns

Query Parameters

Name	Type	Description
name*	String	SNS to get info for (e.g. satoshi.sats)

Headers

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

200: OK

{
    "error": null,
    "result": {
        "inscription_id": "26d5ad9f79aeb7f787e040e40f193e0d4f4e4bbf12fb5f7977bade6cb910ab5di0",
        "inscription_number": 207,
        "domain": "sats",
        "sns_name": "satoshi.sats"
    }
}

Get SNS Owned by Address

GET https://api.ordinalsbot.com/sns/v1/sns/get_sns_of_address

Query Parameters

Name	Type	Description
address*	String	Bitcoin address to check balance

Headers

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

200: OK

{
    "error": null,
    "result": [
        {
            "inscription_id": "26d5ad9f79aeb7f787e040e40f193e0d4f4e4bbf12fb5f7977bade6cb910ab5di0",
            "inscription_number": 207,
            "sns_name": "satoshi.sats"
        },
         ...
        {
            "inscription_id": "d2e34bd00eb1bf7d0f88acfccc31e8ca68a45097279ad07eafd06910bd1fa8a6i0",
            "inscription_number": 391,
            "sns_name": "d.sats"
        }
    ]
}

Get SNS Count of Address

GET https://api.ordinalsbot.com/sns/v1/sns/get_sns_count_of_address

Query Parameters

Name	Type	Description
address*	String	Bitcoin address to check balance

Headers

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

200: OK

{
    "error": null,
    "result": [
        {
            "count": "16"
        }
    ]
}

500: Internal Server Error

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