search

Quick Start

circle-info

For local testing, we highly recommend something like HTTPIE. It's much nicer to use than CURL, provides clean json body creation and automatically displays json responses in a clean format.

See: https://httpie.io/cliarrow-up-right

The examples will reference using httpie via the 'http' command.

hashtag
VIEWS in GET requests

First, a quick note about the 'view' property in many of the APIs. For efficiency, many API requests have a default 'view' that returns a focused amount of data more appropriate for certain requestors. This view is what will be returned if no view parameter is explicitly set. Typically this is the 'brief' view. Some queries return a special 'thumbnail' view that is meant to to be very simple - often used for interactive 'search by name' types of queries. Thumbnail is basically 'tiny' + avatar links and is only available via some endpoints.

Example views differences for an NFD (nfdomains.algo in this example):

{
    "caAlgo": [
        "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I"
    ],
    "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I",
    "name": "nfdomains.algo",
    "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI",
    "properties": {},
    "unverifiedCaAlgo": [
        "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ"
    ]
}

hashtag
GET an NFD by NAME

To fetch an NFD by explicit name, make an HTTP GET call to the /nfd/{name} endpoint.

No parameters are required. Fetching a name will return the 'brief' view by default which is sufficient for most fetches a wallet would use for example.

hashtag
Get a specific NFD by name or by its application ID

get
/nfd/{nameOrID}

Get a specific NFD by name or by its application ID

Path parameters
nameOrIDstring · min: 1 · max: 120Required

Name of a NFD (alphanumeric only or emojis/alphanumeric), or an NFD Application ID

Example: silvio.algoPattern: ^(.+\.algo)|(\d+)$
Query parameters
viewstring · enumOptional

View of data to return, tiny, brief (default), or full

Default: briefPossible values:
pollbooleanOptional

Use if polling waiting for state change - causes notFound to return as 204 instead of 404. Should only be used when waiting for an NFD to transition from not-existing to being reserved for user to claim

Default: false
nocachebooleanOptional

Set to true to return a never-cached result. Use sparingly and only during certain 'NFD already exists' UX state transitions.

Default: false
Header parameters
if-none-matchstringOptional

etag

Responses
get
/nfd/{nameOrID}
circle-exclamation

Please don't use the 'poll' or 'nocache' query parameters, except for specific UI/UX transitions as part of a minting process. Ask in the dev channels for details.

hashtag
Get examples

chevron-rightGet name using defaults (brief view)hashtag
chevron-rightGet name using "full" viewhashtag

hashtag

hashtag
GET NFDs for an Algorand Account Address (reverse lookup)

To fetch NFDs that an an address points to, make an HTTP GET call to the /nfd/lookup?address=xxxxx[&address=yyyyy] endpoint.

Multiple addresses can be passed to the endpoint, with each address specified as an additional address=xxx query parameter.

If nothing is matched, a 404 (Not Found) is returned. This is a valid return status, and also helps performance due to CDN negative caching.

circle-info

For more detailed information on this endpoint, please see some of the details described in Resolving an Algorand address to an NFD name / avatar

hashtag
Reverse Address lookup with results returned per address

get
/nfd/lookup

Get the primary NFD for an address. Must be verified address, or if allowUnverified is set, it may match against an unverified address

Query parameters
addressstring[] · min: 1 · max: 20Required

one or more addresses (algo or otherwise) to look up, maximum of 20 can be defined. Specify the same query parameter multiple times for each address, ie: address=xxx&address=yyy&address=zzz

Example: ["abc123","abc123"]
viewstring · enumOptional

View of data to return, tiny (name, owner, caAlgo, unverifiedCaAlgo only [default]), thumbnail (tiny + avatar), brief, or full

Default: tinyPossible values:
allowUnverifiedbooleanOptional

Whether to allow unverified addresses to match (and only if its only match). Defaults to false

Default: falseExample: false
Header parameters
if-none-matchstringOptional

etag

Responses
get
/nfd/lookup
PreviousNFDomains APINextOn-Chain Reference

Last updated