v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-107095124.5 KB
Profile data endpoints

Retrieves publicly accessible domain profile

Retrieves public domain profile accessible to anyone on the internet. All domain profile data is considered private, unless explicitly authorized by the domain owner. In other words, data shown on the public API is controlled by the domain owner.

get/public/{domain}

Path parameters

domainstring required

The domain name to query profile data

Query parameters

fieldsstring

Comma separated list of fields to retrieve. Defaults to cryptoVerifications,profile,socialAccounts,referralCode.

Response

Domain profile

referralCodestring

Referral code of domain owner

isListedForSaleboolean

Indicates if the domain is listed for sale on the secondary marketplace

Example response

{
  "profile": {
    "displayName": "John Doe",
    "description": "This is my domain",
    "location": "Metaverse",
    "imagePath": "https://ipfs.io/ipfs/path/to/pfp",
    "imageType": "onChain",
    "coverPath": "https://ipfs.io/ipfs/path/to/banner",
    "web2Url": "https://www.mywebsite.com",
    "phoneNumber": "555-555-5555",
    "publicDomainSellerEmail": "seller@email.com",
    "tokenGalleryEnabled": true,
    "showDomainSuggestion": true,
    "showFeaturedCommunity": true,
    "showFeaturedPartner": true
  },
  "social": {
    "followerCount": 100,
    "followingCount": 50
  },
  "humanityCheck": {
    "verified": true
  },
  "cryptoVerifications": [
    {
      "symbol": "ETH, MATIC, SOL, ADA, etc",
      "type": "hybrid",
      "address": "8DyNeQYMWY6NLpPN7S1nTcDy2WXLnm5rzrtdWA2H2t6Y"
    }
  ],
  "records": {
    "onChainRecordKey": "onChainRecordValue"
  },
  "metadata": {
    "metadataKey": "metadataValue"
  },
  "walletBalances": {
    "firstTx": "2023-05-08T20:04:47.000Z",
    "lastTx": "2023-09-06T13:28:47.000Z",
    "symbol": "MATIC",
    "type": "native",
    "name": "Polygon",
    "logoUrl": "http://host.io/path/to/logo",
    "tokens": [
      {
        "symbol": "MATIC",
        "type": "erc20",
        "name": "Polygon",
        "logoUrl": "http://host.io/path/to/logo",
        "balanceAmt": 10,
        "value": {
          "marketUsd": "$2534.12",
          "marketPctChange24Hr": -1.74,
          "history": [
            {
              "timestamp": "2024-02-14T13:00:00.000Z",
              "value": 123
            }
          ],
          "walletUsd": "$100",
          "walletUsdAmt": 100
        }
      }
    ],
    "nfts": [
      {
        "category": "art",
        "collectionImageUrl": "https://path/to/collection/image",
        "description": "Collection description",
        "floorPrice": [
          {
            "marketPlaceName": "OpenSea",
            "marketPctChange24Hr": -1.74,
            "history": [
              {
                "timestamp": "2024-02-14T13:00:00.000Z",
                "value": 123
              }
            ],
            "valueUsd": "$25.00",
            "valueUsdAmt": 25
          }
        ],
        "latestAcquiredDate": "native",
        "name": "Unstoppable Domains",
        "nftIds": [
          "0x1234/1"
        ],
        "ownedCount": 10,
        "totalOwners": 10,
        "totalSupply": 200,
        "totalValueUsd": "$50.00",
        "totalValueUsdAmt": 50
      }
    ],
    "txns": {
      "data": [
        {
          "value": 10,
          "gas": 1,
          "method": "Transfer",
          "link": "https://path/to/scanner",
          "success": true,
          "type": "native",
          "imageUrl": "https://path/to/image",
          "symbol": "ETH",
          "description": "Transfer of 10 ETH to address 0x123",
          "from": {
            "address": "address1",
            "label": "label1",
            "link": "https://path/to/scanner"
          },
          "to": {
            "address": "address1",
            "label": "label1",
            "link": "https://path/to/scanner"
          }
        }
      ]
    },
    "totalValueUsd": 200,
    "totalValueUsdAmd": 200,
    "walletType": "external",
    "value": {
      "marketUsd": "$2534.12",
      "walletUsd": "$100",
      "walletUsdAmt": 100
    }
  },
  "market": {
    "primary": {
      "type": "purchase",
      "date": "2024-01-03T08:37:00.000Z",
      "cost": 25,
      "payment": {
        "collected": 20,
        "promoCredits": 5,
        "method": "stripe"
      }
    },
    "secondary": [
      {
        "date": "2024-01-03T08:37:00.000Z",
        "marketPlace": "Magic Eden",
        "payment": {
          "symbol": "ETH",
          "valueUsd": 100,
          "valueNative": 0.1
        }
      }
    ]
  },
  "portfolio": {
    "wallet": {
      "primaryDomain": "primary.x",
      "domainCount": 5
    },
    "account": {
      "domainCount": 10,
      "valueAmt": 100
    }
  },
  "socialAccounts": {
    "discord": {
      "location": "mysocialhandle"
    },
    "reddit": {
      "location": "mysocialhandle"
    },
    "twitter": {
      "location": "mysocialhandle"
    },
    "telegram": {
      "location": "mysocialhandle"
    },
    "lens": {
      "location": "mysocialhandle"
    },
    "youtube": {
      "location": "mysocialhandle"
    }
  },
  "referralCode": "d83b1155f85f4fc",
  "isListedForSale": true,
  "display": {
    "mode": "web3"
  }
}