# Quick Start {% hint style="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: The examples will reference using httpie via the 'http' command. {% endhint %} ## 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): {% tabs %} {% tab title="Tiny" %} ```json { "caAlgo": [ "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I" ], "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "name": "nfdomains.algo", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "properties": {}, "unverifiedCaAlgo": [ "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ" ] } ``` {% endtab %} {% tab title="Thumbnail" %} ```json { "name": "nfdomains.algo", "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "properties": { "userDefined": { "avatar": "https://images.nf.domains/avatar/9f1940b9-2cf5-43cb-96e5-f3b36385fc90" } }, "unverifiedCaAlgo": [ "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ", "OMXLQTI5ZSMWTCIZA3O3YBW74BTCOI67SZTOEDHK3ZEDZ34Z3DEOQD4PW4" ] } ``` {% endtab %} {% tab title="Brief" %} ```json { "appID": 763844423, "asaID": 763844429, "caAlgo": [ "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I" ], "category": "common", "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "metaTags": [ "9_letters", "pristine" ], "name": "nfdomains.algo", "nfdAccount": "FQDCZYHSK6CHLESEN76AGMSZ4JMT2H5BKWSV6NN2YAKDF22NUAJAOZ4ZIY", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "properties": { "userDefined": { "avatar": "https://images.nf.domains/avatar/9f1940b9-2cf5-43cb-96e5-f3b36385fc90" } }, "saleType": "buyItNow", "state": "owned", "unverifiedCaAlgo": [ "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ" ] } ``` {% endtab %} {% tab title="Full" %} ```json { "appID": 763844423, "asaID": 763844429, "caAlgo": [ "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I" ], "category": "common", "currentAsOfBlock": 22754901, "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "metaTags": [ "9_letters", "pristine" ], "name": "nfdomains.algo", "nfdAccount": "FQDCZYHSK6CHLESEN76AGMSZ4JMT2H5BKWSV6NN2YAKDF22NUAJAOZ4ZIY", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "properties": { "internal": { "asaid": "763844429", "category": "common", "commission1": "50", "commission1Agent": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "contractLocked": "0", "highestSoldAmt": "1000000", "name": "nfdomains.algo", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "saleType": "buyItNow", "seller": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "timeChanged": "1660161129", "timeCreated": "1654229863", "timePurchased": "1654233465", "ver": "1.08" }, "userDefined": { "avatar": "https://images.nf.domains/avatar/9f1940b9-2cf5-43cb-96e5-f3b36385fc90", "banner": "https://images.nf.domains/banner/da11c55f-8b85-416d-9361-612082d26f03", "bio": "Discord: https://discord.gg/7XcuMTfeZP", "caalgo": "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ", "github": "https://github.com/TxnLab", "name": "NFDomains", "website": "https://app.nf.domains" }, "verified": { "caAlgo": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "twitter": "@nfdomains" } }, "saleType": "buyItNow", "seller": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "state": "owned", "timeChanged": "2022-08-10T19:52:09Z", "timeCreated": "2022-06-03T04:17:43Z", "timePurchased": "2022-06-03T05:17:45Z", "unverifiedCaAlgo": [ "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ" ] } ``` {% endtab %} {% endtabs %} ## 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. {% openapi src="/files/LUX7Ji30E1eiEMcVZkUr" path="/nfd/{nameOrID}" method="get" %} [openapi3.yaml](https://248579615-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMrFth5XKC1eo3nu9xVre%2Fuploads%2FW7CFlA4K7snWCT3liMou%2Fopenapi3.yaml?alt=media\&token=0490decf-f3b6-4911-88c6-ed5a87e7872d) {% endopenapi %} {% hint style="warning" %} 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. {% endhint %} ### Get examples
Get name using defaults (brief view) ```json http https://api.nf.domains/nfd/nfdomains.algo { "appID": 763844423, "category": "common", "metaTags": [ "9_letters" ], "name": "nfdomains.algo", "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "nfdAccount": "FQDCZYHSK6CHLESEN76AGMSZ4JMT2H5BKWSV6NN2YAKDF22NUAJAOZ4ZIY", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "properties": { "userDefined": { "avatar": "https://images.nf.domains/avatar/9f1940b9-2cf5-43cb-96e5-f3b36385fc90" } }, "saleType": "buyItNow", "state": "owned", "unverifiedCaAlgo": [ "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ", "OMXLQTI5ZSMWTCIZA3O3YBW74BTCOI67SZTOEDHK3ZEDZ34Z3DEOQD4PW4" ] } ```
Get name using "full" view ```json http 'https://api.nf.domains/nfd/nfdomains.algo?view=full' { "appID": 763844423, "asaID": 763844429, "category": "common", "currentAsOfBlock": 21686682, "metaTags": [ "9_letters" ], "name": "nfdomains.algo", "depositAccount": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "nfdAccount": "FQDCZYHSK6CHLESEN76AGMSZ4JMT2H5BKWSV6NN2YAKDF22NUAJAOZ4ZIY", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "properties": { "internal": { "asaid": "763844429", "category": "common", "commission1": "50", "commission1Agent": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "contractLocked": "0", "highestSoldAmt": "1000000", "name": "nfdomains.algo", "owner": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "saleType": "buyItNow", "seller": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "timeChanged": "1655530642", "timeCreated": "1654229863", "timePurchased": "1654233465", "ver": "1.08" }, "userDefined": { "avatar": "https://images.nf.domains/avatar/9f1940b9-2cf5-43cb-96e5-f3b36385fc90", "banner": "https://images.nf.domains/banner/da11c55f-8b85-416d-9361-612082d26f03", "bio": "Discord: https://discord.gg/7XcuMTfeZP", "caalgo": "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I,ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ,OMXLQTI5ZSMWTCIZA3O3YBW74BTCOI67SZTOEDHK3ZEDZ34Z3DEOQD4PW4", "github": "https://github.com/TxnLab", "website": "https://app.nf.domains" }, "verified": { "twitter": "@nfdomains" } }, "saleType": "buyItNow", "seller": "NRLA7VZ2YV6WOS2LBS3UK25DB463XRSNG63BYNQI6CSGGROFWVQ2EKBQSI", "state": "owned", "timeChanged": "2022-06-18T05:37:22Z", "timeCreated": "2022-06-03T04:17:43Z", "timePurchased": "2022-06-03T05:17:45Z", "unverifiedCaAlgo": [ "RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I", "ABHE544MXL2CWMIZONAIUBNVELWYMKYKWBDNRLOEFQJN3LNF2ZWSMDEKBQ", "OMXLQTI5ZSMWTCIZA3O3YBW74BTCOI67SZTOEDHK3ZEDZ34Z3DEOQD4PW4" ] } ``` ##
## 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. {% hint style="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](/reference/integrators-guide/resolving-an-algorand-address-to-an-nfd-name-avatar.md) {% endhint %} {% openapi src="/files/LUX7Ji30E1eiEMcVZkUr" path="/nfd/lookup" method="get" %} [openapi3.yaml](https://248579615-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMrFth5XKC1eo3nu9xVre%2Fuploads%2FW7CFlA4K7snWCT3liMou%2Fopenapi3.yaml?alt=media\&token=0490decf-f3b6-4911-88c6-ed5a87e7872d) {% endopenapi %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api-docs.nf.domains/quick-start.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.