Skip to content
/Search endpoints

Profile API (1.0.0)

Feature Overview

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.

Public endpoint overview

These endpoints are available without any authentication.

  • Retrieve public profile data associated with a domain
    • Domain owner controls which fields are public or private
    • Private data is always the default
  • Retrieve NFTs for addresses associated with domain
    • Domain can have any number of blockchain addresses associated for resolution services
    • Resolution addresses are stored on-chain
    • Query on-chain data for NFTs
  • Retrieve badges data for addresses associated with domain
  • Retrieve the following status of two domains

Authenticated endpoint overview

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.

How to authenticate

  • Determine the message that must be signed through the message generator endpoint
    • Request GET /api/user/{domain}/signature?device=true&expiry={timestamp}
      • Replace '{domain}' with desired domain
      • Replace '{expiry}' with desired Unix epoch timestamp
    • Response contains the message that must be signed
      • Message is a unique hash value
      • Represents combination of provided request parameters
      • Includes an expiration timestamp
  • User must sign the message returned by the message generator API
    • For example, the Metamask wallet could be used to sign the message
    • Generated signature is used in header of subsequent GET or POST request
  • Construct a request to the desired endpoint that requires user authentication
    • Must include headers
      • x-auth-domain - Must equal the {domain} in context
      • x-auth-expiration - Must equal the {expiry} timestamp in the signed message
      • x-auth-signature - Must be set to the value of the user generated signature
Languages
Servers
Production
https://api.unstoppabledomains.com/profile/
Staging
https://api.ud-staging.com/profile/

Badge endpoints

Operations

Follower endpoints

Operations

Profile data endpoints

Operations

Swap endpoints

Operations

Search endpoints

Operations

Retrieves reverse resolution details for an address

Request

Retrieves reverse resolution details for an address

Path
addressstringrequired

Address to resolve

Example: 291
Query
resolutionOrderstring

Comma separated list of naming system resolution preferences

Example: resolutionOrder=ud,ens,lens
curl -i -X GET \
  'https://api.unstoppabledomains.com/profile/resolve/291?resolutionOrder=ud%2Cens%2Clens'

Responses

Resolution successful

Retrieves a list of all supported resolver keys

Request

Retrieves a list of all supported resolver keys

curl -i -X GET \
  https://api.unstoppabledomains.com/profile/resolve/keys

Responses

Retrieved resolver keys

Retrieves list of domains based on query

Request

This route retrieves a list of domains that match the query

Query
namestring

Search by domain name

Example: name=matt
profile-requiredboolean

Whether domains need have a profile configured

reverse-resolution-requiredboolean

Whether domains need to have reverse resolution configured

curl -i -X GET \
  'https://api.unstoppabledomains.com/profile/search?name=matt&profile-required=true&reverse-resolution-required=true'

Responses

Search result values

Bodyapplication/jsonArray [
addressstring

Wallet address that owns the domain

Example: 7.917046959778566e+47
namestring

The domain name

Example: "brad.crypto"
avatarUrlstring

Path to the profile image

Example: "https://api.unstoppabledomains.com/metadata/image-src/brad.crypto?withOverlay=false&ref=1/erc1155:0xc7e5e9434f4a71e6db978bd65b4d61d3593e5f27/14317"
imageUrlstring

Direct path to profile image metadata URL, if available

Example: "https://path.to/image"
imageTypestring

Defines the type of image represented by the URL - default, onChain, offChain

Example: "onChain"
imagePathstring

Path to the profile image

Example: "https://api.unstoppabledomains.com/metadata/image-src/brad.crypto?withOverlay=false&ref=1/erc1155:0xc7e5e9434f4a71e6db978bd65b4d61d3593e5f27/14317"
linkUrlstring

Link to the domain resource

Example: "https://ud.me/brad.crypto"
ownerAddressstring

Wallet address that owns the domain

Example: 7.917046959778566e+47
marketobject

Market availability info

]
Response
application/json
[
  {
    "address": 7.917046959778566e+47,
    "name": "brad.crypto",
    "avatarUrl": "https://api.unstoppabledomains.com/metadata/image-src/brad.crypto?withOverlay=false&ref=1/erc1155:0xc7e5e9434f4a71e6db978bd65b4d61d3593e5f27/14317",
    "imageUrl": "https://path.to/image",
    "imageType": "onChain",
    "imagePath": "https://api.unstoppabledomains.com/metadata/image-src/brad.crypto?withOverlay=false&ref=1/erc1155:0xc7e5e9434f4a71e6db978bd65b4d61d3593e5f27/14317",
    "linkUrl": "https://ud.me/brad.crypto",
    "ownerAddress": 7.917046959778566e+47,
    "market": { … }
  }
]

Status

Operations

Profile management endpoints

Operations

Message generator endpoints

Operations

Wallet data endpoints

Operations

Market data endpoints

Operations

Wallet management endpoints

Operations

Solana wallet endpoints

Operations

Wallet storage endpoints

Operations

Identity management endpoints

Operations