OrdinalDomains.io Resolver API

Welcome to the definitive guide for utilizing the API provided by OrdinalDomains.io.

Overview

OrdinalDomains.io Resolver is a free-to-use, open-source resolver service implemented in Rust, tailored specifically to resolve OrdinalDomains.io names. This service empowers users to confirm the uniqueness and validity of a domain while providing private resolving services for their projects. The following documentation will serve as your roadmap for utilizing the OrdinalDomains.io Resolver API.

API Methods

Attention: This service will solely select information that is presently valid! Any expired or invalid domains will be disregarded!

Take the leap and construct your personalized resolver, providing API services using the source code accessible here [TBC]

On the other hand, leverage our preconfigured server by navigating the following endpoints:

• GET https://api.ordinaldomains.io/open_api/domain/{domain_name}

• GET https://api.ordinaldomains.io/open_api/domain_detail/{domain_name}

• GET https://api.ordinaldomains.io/open_api/address/{address}

Get Domain Address

Endpoint: GET https://api.ordinaldomains.io/open_api/domain/{domain_name}

Description: Returns the wallet address of the domain owner.

Example usage: GET https://api.ordinaldomains.io/open_api/domain/game.btc

Example response: json { "code": 0, "data": { "address": "bc1p3pn9degqgcf4gdtly75ce9zgxdykzsvdmtv8jdqy5ay29f53wvdq9jrlgz" }, "message": "" }

Variables

Type	Name	Description
string	address	Owner's address (the domain name will resolve to this address).

Get Domain Info

Endpoint: GET https://api.ordinaldomains.io/open_api/domain_detail/{domain_name}

Description: Retrieve comprehensive information about a specific domain.

Example usage: GET https://api.ordinaldomains.io/open_api/domain_detail/game.btc

Example response: json { "code": 0, "data": { "address": "bc1p3pn9degqgcf4gdtly75ce9zgxdykzsvdmtv8jdqy5ay29f53wvdq9jrlgz", "create_date": 1678872452676, "domain_name": "game.btc", "expire_date": 1710408452676, "img_url": "https://ordinaldomains.io/images/domain/game.jpeg", "inscribe_id": "612eefa7774714217c05331d325ec3d876c6348172e07df905ccda42ead7c0f6i0", "inscribe_num": 485202, "register_date": 1678872452676 }, "message": "" }

Variables Explanation

Type	Name	Description
number	inscribe_num	Inscription number
string	inscribe_id	Inscription ID
string	domain_name	Domain name
string	address	Owner's address (the domain name will be resolved to this address)
string	expire_date	Date of domain name registration expiry
string	register_date	Date of domain name registration
string	img_url	Image URL of the domain
string	create_date	Date of domain name creation

In the meantime, we are manually adding domains

to the collection, updating it every week. Your domain should be visible in the collection within a few days. As for the photo issue, it is related to the collection feature as well. Once your domain is added to the collection, the photo will display correctly.

Img_url

Description: The image that could be displayed on wallets or exchanges should have the following format: If the domain_name is game.btc, the relative img_url would be: https://api.ordinaldomains.io/images/domain/game.jpeg

Get All Domains' Info through Address

Endpoint: GET https://api.ordinaldomains.io/open_api/address/{address}

Description: Retrieve all domain names associated with a specific address.

Example usage: GET https://api.ordinaldomains.io/open_api/address/bc1p3pn9degqgcf4gdtly75ce9zgxdykzsvdmtv8jdqy5ay29f53wvdq9jrlgz

Example response: json { "code": 0, "data": [{ "address": "bc1p3pn9degqgcf4gdtly75ce9zgxdykzsvdmtv8jdqy5ay29f53wvdq9jrlgz", "create_date": 1678871463968, "domain_name": "london.btc", "expire_date": 1710407463968,"inscribe_id": "1a933636c10dfab87a0baf0b8c7abdb4590a0c5c874d63b87fd91f2f3e8b4d5ei0", "inscribe_num": 485194, "register_date": 1678871463968 }, // more data... ], "message": "" }

These comprise the primary API methods available for the OrdinalDomains.io Resolver. By incorporating these methods into your project, you can effectively administer and resolve OrdinalDomains.io names.

For more information and updates, please visit our GitHub repository here [TBC]