Fetching all NFDs owned by an address

In order to fetch all NFDs owned by a particular account, use the v2/search api on the account, searching on owner. eg: Showing all NFDs owned by the nfdomains account.

https://api.nf.domains/nfd/v2/search?owner=RSV2YCHXA7MWGFTX3WYI7TVGAS5W5XH5M7ZQVXPPRQ7DNTNW36OW2TRR6I&state=owned

This will return the first 50 (by default) NFDs owned (not expired or for-sale) by this NFD. The limit parameter can be changed to a maximum of 200. To iterate, set offset accordingly to walk the results.

Search NFDs via various filters

get

Search NFDs via various filters

Query parameters
namestringOptional

name or partial match of NFD name to filter on

parentAppIDinteger · int64Optional

The parent NFD Application ID to find. Used for fetching segments of an NFD

Example: 1000000
ownerstringOptional

An Algorand Account address

Example: 4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZUPattern: ^[A-Z2-7]{57}[AEIMQUY4]$
reservedForstringOptional

An Algorand Account address

Example: 4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZUPattern: ^[A-Z2-7]{57}[AEIMQUY4]$
excludeUserReservedbooleanOptional

Should NFDs reserved for an account (transfers for example or unclaimed winning auctions) be excluded

prefixstring · min: 1 · max: 32Optional

The start of an NFD name, fetching multiple NFDs that have that prefix

substringstring · min: 3 · max: 32Optional

Part of an NFD name, fetching multiple NFDs that have that substring (minimum 3 characters)

vpropertystring · enumOptional

Verified property name to search on - specify value with vvalue

Example: discordPossible values:
vvaluestringOptional

Value to find in the vproperty field specified with the vproperty parameter

Example: abc123
segmentLockedbooleanOptional

Whether to explicitly filter on segments being locked or unlocked. Typically only valuable when filtering on unlocked

Example: false
segmentRootbooleanOptional

Whether to explicitly filter on NFD roots or segments. True to only see roots, False to only see segments.

Example: false
minPriceinteger · int64Optional

Minimum price of NFD

maxPriceinteger · int64Optional

Maximum price of NFD

minPriceUsdinteger · int64Optional

Minimum price of NFD Segment in USD (cents)

maxPriceUsdinteger · int64Optional

Maximum price of NFD Segment in USD (cents)

changedAfterstring · date-timeOptional

Fetch NFDs that changed after the specified timestamp

Example: 1970-01-01T00:00:01Z
expiresBeforestring · date-timeOptional

Return only NFDs with an expiration time at or before the specified timestamp

Example: 1970-01-01T00:00:01Z
limitinteger · int64 · min: 1 · max: 200Optional

Limit the number of results returned - max 200

Default: 50
offsetinteger · int64Optional

Starting document in large list. Fetch 1-100 [limit 100], pass offset 100 to fetch 100-200

Default: 0
sortstring · enumOptional

What to sort on

Default: createdDescPossible values:
viewstring · enumOptional

View of data to return, tiny (name, owner, caAlgo, unverifiedCaAlgo only), brief (default), or full

Default: briefPossible values:
Header parameters
if-none-matchstringOptional

etag

Responses
200

OK response.

application/json
get
GET /nfd/v2/search HTTP/1.1
Host: api.nf.domains
Accept: */*

{
  "match-check": "abc123",
  "nfds": [
    {
      "appID": 1000000,
      "asaID": 1,
      "avatarOutdated": false,
      "caAlgo": [
        "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU"
      ],
      "cache-control": "abc123",
      "category": "abc123",
      "currentAsOfBlock": 1,
      "depositAccount": "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU",
      "etag": "abc123",
      "expired": false,
      "match-check": "abc123",
      "metaTags": [
        "abc123"
      ],
      "name": "abc123",
      "nfdAccount": "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU",
      "owner": "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU",
      "parentAppID": 1000000,
      "properties": {
        "internal": {
          "abc123": "abc123"
        },
        "userDefined": {
          "ca:b": "abc123"
        },
        "verified": {
          "caAlgo": "abc123"
        }
      },
      "reservedFor": "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU",
      "saleType": "abc123",
      "sellAmount": 1,
      "seller": "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU",
      "sigNameAddress": "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU",
      "state": "abc123",
      "tags": [
        "abc123"
      ],
      "timeChanged": "1970-01-01T00:00:01Z",
      "timeCreated": "1970-01-01T00:00:01Z",
      "timeExpires": "1970-01-01T00:00:01Z",
      "timePurchased": "1970-01-01T00:00:01Z",
      "unverifiedCa": {
        "btc": [
          "12KKDt4Mj7N5UAkQMN7LtPZMayenXHa8KL"
        ]
      },
      "unverifiedCaAlgo": [
        "4F5OA5OQC5TBHMCUDJWGKMUZAQE7BGWCKSJJSJEMJO5PURIFT5RW3VHNZU"
      ]
    }
  ],
  "total": 1
}
PreviousResolving an Algorand address to an NFD name / avatarNextInteractive NFD lookup

Last updated