NFD API
  • NFDomains API
  • Quick Start
  • Reference
    • On-Chain Reference
      • On-Chain Diagram V3+
        • On-Chain Diagram V2+
        • V1 On-Chain Diagram
      • Registry Application IDs
      • Contract methods
      • Name & Address Lookup
        • V1 Resolution example (go)
          • Example PyTeal name/ID validity check
      • NFDs owned by Address
      • Reading of NFD metadata
      • Properties
      • Contract Changelog
    • NFDomains REST API Reference
    • Integrators Guide
      • Using an NFD for sending assets to Algorand accounts
      • Using an NFD to sending to non-Algorand chains.
      • Resolving an Algorand address to an NFD name / avatar
      • Interactive NFD lookup
      • Discord / Telegram bots
      • Linking an Application to an NFD
      • Using Vaults (2.x+)
      • Expirations / MBR liquidation
    • API Changelog
    • Status Page
  • Community
Powered by GitBook
On this page
  • Getting started
  • Interactive Swagger
  • Generating SDKs
  • Want to jump right in?
  • Want to deep dive?
  • Integrators

NFDomains API

NextQuick Start

Last updated 8 months ago

Getting started

Welcome to an overview, and detailed description of the public API for .

NFDomains .algo names are controlled by the NFD Registry Contract which controls pricing, and the minting of new NFDs. Each NFD is a standalone contract instance, with its own Algorand account (Vault) it controls. The registry acts as a contract factory, creating the NFDs and acting as the registrar and registry of record. Creation and resolving of names and addresses to names is via the registry. See On-Chain Reference for more details.

The UI for NFDomains uses the very same public API being discussed here.

The NFDomains REST API is a public API that is for integrators and the community to use. It provides read-only methods, as well as methods that modify the NFD contract states (minting / claiming / updating / selling, etc.) which require the caller to sign returned transactions.

The latest full Swagger spec will always be provided by the API itself, and is available from every API endpoint (per environment):

  • mainnet:

  • testnet:

While we don't want to break the API, there are currently no guarantees the API won't change in the future.

Significant changes will either receive new endpoints, or /v2/ path.

High level changes will be described in API Changelog

Interactive Swagger

The specifications listed above can be loaded directly into Swagger for viewing, and executing, and generating SDKs.

Below are direct links, which load the specific specs into an interactive page:

  • mainnet:

  • testnet:

Generating SDKs

Use the above links to go to the Swagger editor, and you can generate SDKs for 20+ languages.

TxnLab may provide more formal SDKs at some point (perhaps the generated Typescript bindings which our UI uses for example), but given the simplicity of the API, Swagger's rich generation capabilities, and our small team, it seems unnecessary.

Want to jump right in?

Start with the quick start for an important API overview and get making your first request:

Want to deep dive?

Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:

Perhaps you want to understand how some of the on-chain mechanics work, or prefer to trust only the chain, using your own nodes ?

Integrators

Are you an integrator looking to use NFD, see:

NFDomains
https://api.nf.domains/info/openapi3.yaml
https://api.testnet.nf.domains/info/openapi3.yaml
https://editor.swagger.io/?url=https://api.nf.domains/info/openapi3.yaml
https://editor.swagger.io/?url=https://api.testnet.nf.domains/info/openapi3.yaml
Quick Start
NFDomains REST API Reference
On-Chain Reference
Integrators Guide
SDK Generation