Quick Start
Last updated
Last updated
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):
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.
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.
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.
Get a specific NFD by name or by its application ID
Name of a NFD (alphanumeric only or emojis/alphanumeric), or an NFD Application ID
silvio.algoPattern: ^(.+\.algo)|(\d+)$View of data to return, tiny, brief (default), or full
briefPossible values: 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
falseSet to true to return a never-cached result. Use sparingly and only during certain 'NFD already exists' UX state transitions.
falseetag
Get the primary NFD for an address. Must be verified address, or if allowUnverified is set, it may match against an unverified address
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
["abc123","abc123"]View of data to return, tiny (name, owner, caAlgo, unverifiedCaAlgo only [default]), thumbnail (tiny + avatar), brief, or full
tinyPossible values: Whether to allow unverified addresses to match (and only if its only match). Defaults to false
falseExample: falseetag