The Profile API allows clients to retrieve and update domain profile details. There are both public and authenticated endpoints available for domain profiles. For authenticated endpoints, the API requires request signatures generated using the domain owner's private key.
These endpoints are available without any authentication.
The owner of a domain may use this API to view or edit their private profile data. When managing profile data, authentication headers must be provided using the approach described below.
Retrieves details about a badge, including definition and usage statistics.
Badge details
Badge not found
{- "badge": {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": "purchase",
- "date": "2024-01-03T08:37:00.000Z",
- "cost": 25,
- "payment": {
- "collected": null,
- "promoCredits": null,
- "method": null
}
}, - "secondary": [
- {
- "date": null,
- "txHash": null,
- "marketPlace": null,
- "payment": { }
}
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}, - "sponsorship": {
- "max": 10,
- "count": 5,
- "latest": "latest.crypto",
- "authorizedAddresses": [
- "string"
], - "domains": [
- {
- "name": "sponsor.crypto",
- "count": 1
}
]
}, - "usage": {
- "holders": 10000,
- "domains": 10000,
- "featured": [
- "matt.crypto"
], - "rank": 1
}
}
Creates a badge based on a provided marketplace link, such as OpenSea, Zuse.market, etc. The badge must be purchased to be activated before it can be claimed by other domains.
Badge pending payment
Invalid marketplace link
Collection not found
Badge already claimed
{- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "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",
- "txHash": 4660,
- "marketPlace": "Magic Eden",
- "payment": {
- "symbol": null,
- "valueUsd": null,
- "valueNative": null
}
}
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}
Generates a list of badges ordered by number of holders
Badge rankings
[- {
- "badge": {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": null,
- "date": null,
- "cost": null,
- "payment": { }
}, - "secondary": [
- { }
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}, - "sponsorship": {
- "max": 10,
- "count": 5,
- "latest": "latest.crypto",
- "authorizedAddresses": [
- "string"
], - "domains": [
- {
- "name": "sponsor.crypto",
- "count": 1
}
]
}, - "usage": {
- "holders": 10000,
- "domains": 10000,
- "featured": [
- "matt.crypto"
], - "rank": 1
}
}
]
Generates a list of sponsors ordered by largest number of sponsored badges
Sponsor rankings
[- {
- "domain": "matt.crypto",
- "rank": 1,
- "count": 100
}
]
Update specific badge visibility if provided in request body. If body has no elements, requests badge refresh for a wallet address. Authentication is required using domain owner signature.
List of badges
Invalid address
Address not found
Badges already recently collected
Too many collection requests
[- {
- "code": "badge1",
- "active": true
}
]
[- {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": "purchase",
- "date": "2024-01-03T08:37:00.000Z",
- "cost": 25,
- "payment": {
- "collected": null,
- "promoCredits": null,
- "method": null
}
}, - "secondary": [
- {
- "date": null,
- "txHash": null,
- "marketPlace": null,
- "payment": { }
}
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}
]
Follow a domain
Follow successful
Domain not found
{- "domain": "follow.x"
}
Unfollows a domain
Unfollow successful
Domain not found
{- "domain": "follow.x"
}
Returns a list of followers or following for a domain
Follower list
Domain not found
{- "data": [
- {
- "domain": "string"
}
], - "meta": {
- "total_count": 0,
- "pagination": {
- "cursor": 0,
- "take": 0
}
}, - "relationship_type": "followers",
- "domain": "string"
}
Retrieves badge data associated with requested domain.
Domain badge data
Domain not found
{- "badges": [
- {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": null,
- "date": null,
- "cost": null,
- "payment": { }
}, - "secondary": [
- { }
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}
], - "partners": [
- {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": null,
- "date": null,
- "cost": null,
- "payment": { }
}, - "secondary": [
- { }
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}
], - "refresh": {
- "last": "2022-11-28 00:00:00",
- "next": "2022-12-01 00:00:00"
}
}
Retrieves recommended connections for a given domain, using an on-chain social graph.
User connections
Domain not found
[- {
- "address": 291,
- "domain": "matt.crypto",
- "imageType": "onChain",
- "reasons": [
- {
- "id": "poap",
- "description": "Holds the same POAP"
}
], - "score": 75,
- "xmtpEnabled": true
}
]
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.
Domain profile
Domain not found
{- "profile": {
- "displayName": "John Doe",
- "description": "This is my domain",
- "location": "Metaverse",
- "imageType": "onChain",
- "phoneNumber": "555-555-5555",
- "publicDomainSellerEmail": "seller@email.com",
- "tokenGalleryEnabled": true,
- "showDomainSuggestion": true,
- "showFeaturedCommunity": true,
- "showFeaturedPartner": true,
- "udBlue": true
}, - "social": {
- "followerCount": 100,
- "followingCount": 50
}, - "humanityCheck": {
- "verified": true
}, - "cryptoVerifications": [
- {
- "symbol": "ETH, MATIC, SOL, ADA, etc",
- "type": "hybrid",
- "address": "8DyNeQYMWY6NLpPN7S1nTcDy2WXLnm5rzrtdWA2H2t6Y",
- "plaintextMessage": "string",
- "signedMessage": "string"
}
], - "records": {
- "onChainRecordKey": "onChainRecordValue"
}, - "metadata": {
- "metadataKey": "metadataValue"
}, - "walletBalances": {
- "firstTx": "2023-05-08T20:04:47.000Z",
- "lastTx": "2023-09-06T13:28:47.000Z",
- "symbol": "MATIC",
- "address": 1.1706481464129065e+48,
- "type": "native",
- "name": "Polygon",
- "balance": 10,
- "tokens": [
- {
- "symbol": "MATIC",
- "address": 1.1706481464129065e+48,
- "type": "erc20",
- "name": "Polygon",
- "balance": 10,
- "balanceAmt": 10,
- "value": {
- "marketUsd": "$2534.12",
- "marketUsdAmt": "$2534.12",
- "marketPctChange24Hr": -1.74,
- "history": [
- {
- "timestamp": "2024-02-14T13:00:00.000Z",
- "value": 123
}
], - "walletUsd": "$100",
- "walletUsdAmt": 100
}
}
], - "nfts": [
- {
- "category": "art",
- "contractAddresses": [
- 4660
], - "description": "Collection description",
- "floorPrice": [
- {
- "marketPlaceName": "OpenSea",
- "marketPctChange24Hr": -1.74,
- "history": [
- {
- "timestamp": null,
- "value": null
}
], - "value": "$25.00",
- "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": [
- {
- "hash": 123,
- "block": 123,
- "value": 10,
- "gas": 1,
- "method": "Transfer",
- "success": true,
- "type": "native",
- "symbol": "ETH",
}
], - "cursor": 123
}, - "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",
- "txHash": 4660,
- "marketPlace": "Magic Eden",
- "payment": {
- "symbol": "ETH",
- "valueUsd": 100,
- "valueNative": 0.1
}
}
]
}, - "portfolio": {
- "wallet": {
- "address": 10,
- "primaryDomain": "primary.x",
- "domainCount": 5
}, - "account": {
- "domainCount": 10,
- "value": 100,
- "valueAmt": 100
}
}, - "socialAccounts": {
- "discord": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "reddit": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "twitter": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "telegram": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "lens": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "youtube": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}
}, - "referralCode": "d83b1155f85f4fc"
}
Retrieves NFT data associated with requested domain. Paging is supported using the limit and cursor query string parameters.
Domain NFT data
Domain not found
{- "property1": {
- "address": "8DyNeQYMWY6NLpPN7S1nTcDy2WXLnm5rzrtdWA2H2t6Y",
- "cursor": "nextPage",
- "verified": true,
- "enabled": true,
- "showAllItems": true,
- "totalCount": 0,
- "nfts": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "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",
- "txHash": 4660,
- "marketPlace": "Magic Eden",
- "payment": {
- "symbol": null,
- "valueUsd": null,
- "valueNative": null
}
}
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
]
}, - "property2": {
- "address": "8DyNeQYMWY6NLpPN7S1nTcDy2WXLnm5rzrtdWA2H2t6Y",
- "cursor": "nextPage",
- "verified": true,
- "enabled": true,
- "showAllItems": true,
- "totalCount": 0,
- "nfts": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "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",
- "txHash": 4660,
- "marketPlace": "Magic Eden",
- "payment": {
- "symbol": null,
- "valueUsd": null,
- "valueNative": null
}
}
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
]
}
}
Retrieves transaction data associated with requested domain. Paging is supported using the cursor query string parameter.
Transaction data
Domain not found
[- {
- "data": [
- {
- "hash": 123,
- "block": 123,
- "value": 10,
- "gas": 1,
- "method": "Transfer",
- "success": true,
- "type": "native",
- "symbol": "ETH",
}
], - "cursor": 123
}
]
Retrieves badge data associated with a list of requested domains.
Domain bulk badge data
Domain bulk data not found
{- "domains": [
- "string"
]
}
{- "badges": [
- {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": null,
- "date": null,
- "cost": null,
- "payment": { }
}, - "secondary": [
- { }
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}
], - "partners": [
- {
- "name": "World of Women",
- "code": "WoWHolder",
- "active": true,
- "type": "default",
- "count": 3,
- "description": "Holds World of Women NFT.",
- "gallery": {
- "enabled": true,
- "featured": [
- "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/6776"
], - "tier": 1
}, - "marketplace": {
- "listings": [
- {
- "name": "My NFT",
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true,
- "pfp_uri": "137/erc721:0xa429b85fD3458E8d89b0181A6AF93b577AE040DB/181",
- "tags": [
- "string"
], - "collection": "Bored Ape Yaught Club",
- "collectionOwners": 562,
- "description": "NFT collection description",
- "createdDate": "2023-12-06T13:43:33",
- "acquiredDate": "2023-12-06T13:43:33",
- "supply": 999,
- "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "saleDetails": {
- "primary": {
- "type": null,
- "date": null,
- "cost": null,
- "payment": { }
}, - "secondary": [
- { }
]
}, - "traits": {
- "key": "value"
}, - "rarity": {
- "rank": 1,
- "score": 1.05
}
}
], - "avgPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "floorPrice": {
- "currency": "ETH",
- "price": 0.25
}, - "supply": 10000,
- "holders": 1000,
- "sales": 3,
- "volume": 3
}
}
], - "refresh": {
- "last": "2022-11-28 00:00:00",
- "next": "2022-12-01 00:00:00"
}
}
This route retrieves a list of domains that match the query
Search result values
[- {
- "address": 7.917046959778566e+47,
- "name": "brad.crypto",
- "imageType": "onChain",
- "ownerAddress": 7.917046959778566e+47,
- "market": {
- "price": 1000,
- "location": "primary"
}
}
]
Verify ownership of a blockchain address by signing a message with your private key.
Address verification successful
Request contained invalid parameters
Domain not found
{- "message": "Unique message to sign",
- "signature": "cd0dadab45baf9a06ce1279d1342ecc3f44845af"
}
Upload an XMTP or Push Protocol attachment. Quota enforced per user. Authentication is required using domain owner signature.
object (SerializedDomainProfileImageData) |
Public URL to access the uploaded attachment
Invalid attachment
Domain not found
User quota exceeded
{- "attachment": {
- "base64": "aGVsbG8gd29ybGQK",
- "type": "image/png"
}
}
{
}
While the public API retrieves only the data identified as shareable by the domain owner, this API returns both public and private data. Authentication is required using domain owner signature.
Domain profile
Domain not found
{- "profile": {
- "id": 0,
- "domainId": 0,
- "privateEmail": "string",
- "displayName": "John Doe",
- "description": "This is my domain",
- "location": "Metaverse",
- "imageType": "onChain",
- "phoneNumber": "555-555-5555",
- "publicDomainSellerEmail": "seller@email.com",
- "tokenGalleryEnabled": true,
- "showDomainSuggestion": true,
- "showFeaturedCommunity": true,
- "showFeaturedPartner": true,
- "udBlue": true,
- "displayNamePublic": true,
- "descriptionPublic": true,
- "locationPublic": true,
- "imagePathPublic": true,
- "coverPathPublic": true,
- "web2UrlPublic": true,
- "phoneNumberPublic": true
}, - "social": {
- "followerCount": 100,
- "followingCount": 50
}, - "messaging": {
- "disabled": true,
- "thirdPartyMessagingEnabled": true,
- "thirdPartyMessagingConfigType": "Skiff",
- "hasSkiffAlias": true,
- "rules": [
- {
- "id": 0,
- "type": "ALLOW or BLOCK",
- "rule": "Email matching rule with wildcards",
- "name": "My first rule"
}
]
}, - "humanityCheck": {
- "verified": true
}, - "cryptoVerifications": [
- {
- "symbol": "ETH, MATIC, SOL, ADA, etc",
- "type": "hybrid",
- "address": "8DyNeQYMWY6NLpPN7S1nTcDy2WXLnm5rzrtdWA2H2t6Y",
- "plaintextMessage": "string",
- "signedMessage": "string"
}
], - "records": {
- "onChainRecordKey": "onChainRecordValue"
}, - "storage": {
- "apiKey": "storage-api-key",
- "type": "ipfs"
}, - "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",
- "txHash": 4660,
- "marketPlace": "Magic Eden",
- "payment": {
- "symbol": "ETH",
- "valueUsd": 100,
- "valueNative": 0.1
}
}
]
}, - "portfolio": {
- "wallet": {
- "address": 10,
- "primaryDomain": "primary.x",
- "domainCount": 5
}, - "account": {
- "domainCount": 10,
- "value": 100,
- "valueAmt": 100
}
}, - "walletBalances": {
- "firstTx": "2023-05-08T20:04:47.000Z",
- "lastTx": "2023-09-06T13:28:47.000Z",
- "symbol": "MATIC",
- "address": 1.1706481464129065e+48,
- "type": "native",
- "name": "Polygon",
- "balance": 10,
- "tokens": [
- {
- "symbol": "MATIC",
- "address": 1.1706481464129065e+48,
- "type": "erc20",
- "name": "Polygon",
- "balance": 10,
- "balanceAmt": 10,
- "value": {
- "marketUsd": "$2534.12",
- "marketUsdAmt": "$2534.12",
- "marketPctChange24Hr": -1.74,
- "history": [
- {
- "timestamp": "2024-02-14T13:00:00.000Z",
- "value": 123
}
], - "walletUsd": "$100",
- "walletUsdAmt": 100
}
}
], - "nfts": [
- {
- "category": "art",
- "contractAddresses": [
- 4660
], - "description": "Collection description",
- "floorPrice": [
- {
- "marketPlaceName": "OpenSea",
- "marketPctChange24Hr": -1.74,
- "history": [
- {
- "timestamp": null,
- "value": null
}
], - "value": "$25.00",
- "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": [
- {
- "hash": 123,
- "block": 123,
- "value": 10,
- "gas": 1,
- "method": "Transfer",
- "success": true,
- "type": "native",
- "symbol": "ETH",
}
], - "cursor": 123
}, - "totalValueUsd": 200,
- "totalValueUsdAmd": 200,
- "walletType": "external",
- "value": {
- "marketUsd": "$2534.12",
- "walletUsd": "$100",
- "walletUsdAmt": 100
}
}, - "socialAccounts": {
- "discord": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "reddit": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "twitter": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "telegram": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "lens": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "youtube": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}
}, - "referralCode": "d83b1155f85f4fc"
}
The POST call can be used to create a new domain profile or make updates to an existing profile. Authentication is required using domain owner signature.
Domain profile
Domain not found
{- "displayName": "John Doe",
- "displayNamePublic": true,
- "description": "This is my domain",
- "descriptionPublic": true,
- "location": "Metaverse",
- "locationPublic": true,
- "imagePathPublic": true,
- "coverPathPublic": true,
- "publicDomainSellerEmail": "seller@gmail.com",
- "web2UrlPublic": true,
- "showDomainSuggestion": true,
- "showFeaturedCommunity": true,
- "showFeaturedPartner": true,
- "phoneNumber": "555-555-5555",
- "phoneNumberPublic": true,
- "privateEmail": "me@email.com",
- "messagingDisabled": true,
- "thirdPartyMessagingEnabled": true,
- "thirdPartyMessagingConfigType": "Skiff",
- "data": {
- "image": {
- "base64": "aGVsbG8gd29ybGQK",
- "type": "image/png"
}, - "cover": {
- "base64": "aGVsbG8gd29ybGQK",
- "type": "image/png"
}
}, - "socialAccounts": {
- "discord": "discorduser",
- "reddit": "reddituser",
- "twitter": "twitteruser",
- "telegram": "telegramuser",
- "youtube": "youtubeuser"
}
}
{- "profile": {
- "id": 0,
- "domainId": 0,
- "privateEmail": "string",
- "displayName": "John Doe",
- "description": "This is my domain",
- "location": "Metaverse",
- "imageType": "onChain",
- "phoneNumber": "555-555-5555",
- "publicDomainSellerEmail": "seller@email.com",
- "tokenGalleryEnabled": true,
- "showDomainSuggestion": true,
- "showFeaturedCommunity": true,
- "showFeaturedPartner": true,
- "udBlue": true,
- "displayNamePublic": true,
- "descriptionPublic": true,
- "locationPublic": true,
- "imagePathPublic": true,
- "coverPathPublic": true,
- "web2UrlPublic": true,
- "phoneNumberPublic": true
}, - "social": {
- "followerCount": 100,
- "followingCount": 50
}, - "messaging": {
- "disabled": true,
- "thirdPartyMessagingEnabled": true,
- "thirdPartyMessagingConfigType": "Skiff",
- "hasSkiffAlias": true,
- "rules": [
- {
- "id": 0,
- "type": "ALLOW or BLOCK",
- "rule": "Email matching rule with wildcards",
- "name": "My first rule"
}
]
}, - "humanityCheck": {
- "verified": true
}, - "cryptoVerifications": [
- {
- "symbol": "ETH, MATIC, SOL, ADA, etc",
- "type": "hybrid",
- "address": "8DyNeQYMWY6NLpPN7S1nTcDy2WXLnm5rzrtdWA2H2t6Y",
- "plaintextMessage": "string",
- "signedMessage": "string"
}
], - "records": {
- "onChainRecordKey": "onChainRecordValue"
}, - "storage": {
- "apiKey": "storage-api-key",
- "type": "ipfs"
}, - "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",
- "txHash": 4660,
- "marketPlace": "Magic Eden",
- "payment": {
- "symbol": "ETH",
- "valueUsd": 100,
- "valueNative": 0.1
}
}
]
}, - "portfolio": {
- "wallet": {
- "address": 10,
- "primaryDomain": "primary.x",
- "domainCount": 5
}, - "account": {
- "domainCount": 10,
- "value": 100,
- "valueAmt": 100
}
}, - "walletBalances": {
- "firstTx": "2023-05-08T20:04:47.000Z",
- "lastTx": "2023-09-06T13:28:47.000Z",
- "symbol": "MATIC",
- "address": 1.1706481464129065e+48,
- "type": "native",
- "name": "Polygon",
- "balance": 10,
- "tokens": [
- {
- "symbol": "MATIC",
- "address": 1.1706481464129065e+48,
- "type": "erc20",
- "name": "Polygon",
- "balance": 10,
- "balanceAmt": 10,
- "value": {
- "marketUsd": "$2534.12",
- "marketUsdAmt": "$2534.12",
- "marketPctChange24Hr": -1.74,
- "history": [
- {
- "timestamp": "2024-02-14T13:00:00.000Z",
- "value": 123
}
], - "walletUsd": "$100",
- "walletUsdAmt": 100
}
}
], - "nfts": [
- {
- "category": "art",
- "contractAddresses": [
- 4660
], - "description": "Collection description",
- "floorPrice": [
- {
- "marketPlaceName": "OpenSea",
- "marketPctChange24Hr": -1.74,
- "history": [
- {
- "timestamp": null,
- "value": null
}
], - "value": "$25.00",
- "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": [
- {
- "hash": 123,
- "block": 123,
- "value": 10,
- "gas": 1,
- "method": "Transfer",
- "success": true,
- "type": "native",
- "symbol": "ETH",
}
], - "cursor": 123
}, - "totalValueUsd": 200,
- "totalValueUsdAmd": 200,
- "walletType": "external",
- "value": {
- "marketUsd": "$2534.12",
- "walletUsd": "$100",
- "walletUsdAmt": 100
}
}, - "socialAccounts": {
- "discord": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "reddit": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "twitter": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "telegram": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "lens": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}, - "youtube": {
- "location": "mysocialhandle",
- "verified": true,
- "public": true
}
}, - "referralCode": "d83b1155f85f4fc"
}
The POST call can be used to update NFT gallery preferences for addresses resolving to the domain. Authentication is required using domain owner signature.
Update successful
Request contained invalid parameters
Domain not found
[- {
- "symbol": "ETH",
- "address": "cd0dadab45baf9a06ce1279d1342ecc3f44845af",
- "public": true,
- "showAllItems": true,
- "order": 10,
- "items": [
- {
- "mint": "a9a6a3626993d487d2dbda3173cf58ca1a9d9e9f",
- "public": true
}
]
}
]
Modify notifications preferences related to the domain, such as mobile push notifications and email.
Update successful
Request contained invalid parameters
Domain not found
{- "WEB_NOTIFICATION": true,
- "MOBILE_NOTIFICATION": true
}
Get notifications preferences related to the domain, such as mobile push notifications and email.
Update successful
Request contained invalid parameters
Domain not found
The POST call can be used to complete the process of modifying a domain's on-chain records by submitting a signed transaction hash to confirm an operation. Authentication is required using domain owner signature.
Successful confirmation of domain record update. The domain records will be updated on the blockchain.
Domain not found
{- "operationId": 1234,
- "dependencyId": 5678,
- "signature": 4660,
- "txHash": 4660
}
{- "type": "unstoppabledomains.com/partner.v3.OperationType",
- "operation": {
- "id": 123,
- "dependencies": [
- {
- "id": 456,
- "transaction": {
- "hash": 291,
- "messageToSign": 1110
}
}
]
}
}
Retrieves a list of pending on-chain record operations for this domain. Authentication is required using domain owner signature.
List of pending on-chain operations
Request contained invalid parameters
Domain not found
{- "type": "unstoppabledomains.com/partner.v3.OperationType",
- "items": [
- {
- "id": 123,
- "dependencies": [
- {
- "id": 456,
- "transaction": {
- "hash": 291,
- "messageToSign": 1110
}
}
]
}
]
}
The POST call can be used to start the process of modifying a domain's on-chain records. Authentication is required using domain owner signature.
Successful request of domain record update. The transaction hash must be signed and submitted to confirm the record update.
Domain not found
{- "address": 4660,
- "primaryDomain": true,
- "transferToAddress": 291,
- "clearRecords": true,
- "records": {
- "key": "An arbitrary on-chain record value"
}
}
{- "type": "unstoppabledomains.com/partner.v3.OperationType",
- "operation": {
- "id": 123,
- "dependencies": [
- {
- "id": 456,
- "transaction": {
- "hash": 291,
- "messageToSign": 1110
}
}
]
}
}
The POST call can be used to create new domain profiles or make updates to existing profiles. All domains in the bulk update list must belong to the same wallet address. Authentication is required using the domain owner signature from one of the domains in the bulk update list.
Domain profile
Invalid request
Bulk update not authorized
Domain not found
{- "domains": [
- "bulk.crypto"
], - "profile": {
- "displayName": "John Doe",
- "displayNamePublic": true,
- "description": "This is my domain",
- "descriptionPublic": true,
- "location": "Metaverse",
- "locationPublic": true,
- "imagePathPublic": true,
- "coverPathPublic": true,
- "publicDomainSellerEmail": "seller@gmail.com",
- "web2UrlPublic": true,
- "showDomainSuggestion": true,
- "showFeaturedCommunity": true,
- "showFeaturedPartner": true,
- "phoneNumber": "555-555-5555",
- "phoneNumberPublic": true,
- "privateEmail": "me@email.com",
- "messagingDisabled": true,
- "thirdPartyMessagingEnabled": true,
- "thirdPartyMessagingConfigType": "Skiff",
- "data": {
- "image": {
- "base64": "aGVsbG8gd29ybGQK",
- "type": "image/png"
}, - "cover": {
- "base64": "aGVsbG8gd29ybGQK",
- "type": "image/png"
}
}, - "socialAccounts": {
- "discord": "discorduser",
- "reddit": "reddituser",
- "twitter": "twitteruser",
- "telegram": "telegramuser",
- "youtube": "youtubeuser"
}
}
}
{- "success": true,
- "domains": [
- "updated.crypto"
]
}
Retrieves the message that must be signed to verify ownership of a blockchain address. The message must be signed with the blockchain address private key and submitted using the POST call for verification.
Message to be signed
Address not defined for domain
Domain not found