metadata.ens.domains Open in urlscan Pro
104.18.20.234  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * getENS NFT metadata
 * getENS NFT image
 * getENS NFT image rasterization
 * getENS avatar metadata
 * getENS avatar image
 * getQuery endpoint for NFT URIs
 * getENS NFT preview

API docs by Redocly





ENS METADATA SERVICE (0.0.1-ALPHA.1)

Download OpenAPI specification:Download

License:


Set of endpoints to query ENS metadata and more


ENS NFT METADATA

ENS NFT metadata

PATH PARAMETERS

networkName
required
string (networkName)
Enum: "mainnet" "rinkeby" "ropsten" "goerli"

Name of the chain to query for.

contractAddress
required
string (contractAddress)
Example: 0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85

tokenId
required
string (tokenId)
Example: 4221908525551133525058944220830153...

Labelhash(v1) /Namehash(v2) of your ENS name.

More:
https://docs.ens.domains/contract-api-reference/name-processing#hashing-names


RESPONSES

200

Metadata object

404

No results found

500

Internal Server Error

501

Unsupported network

504

Gateway Timeout

get/{networkName}/{contractAddress(0x[a-fA-F0-9]{40})}/{tokenId}
https://metadata.ens.domains/{networkName}/{contractAddress(0x[a-fA-F0-9]{40})}/{tokenId}


RESPONSE SAMPLES

 * 200

Content type
application/jsonapplication/xmlapplication/json
Copy
{
 * "name": "ENS name",
 * "description": "Short ENS name description",
 * "attributes": "Custom traits about ENS",
 * "name_length": "Character length of ens name",
 * "url": "ENS App URL of the name",
 * "version": "ENS NFT version",
 * "background_image": "Origin URL of avatar image",
 * "image_url": "URL of ENS NFT image"

}


ENS NFT IMAGE

ENS NFT image

PATH PARAMETERS

networkName
required
string (networkName)
Enum: "mainnet" "rinkeby" "ropsten" "goerli"

Name of the chain to query for.

contractAddress
required
string (contractAddress)
Example: 0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85

tokenId
required
string (tokenId)
Example: 4221908525551133525058944220830153...

Labelhash(v1) /Namehash(v2) of your ENS name.

More:
https://docs.ens.domains/contract-api-reference/name-processing#hashing-names


RESPONSES

200

Image file

404

No results found

501

Unsupported network

504

Gateway Timeout

get/{networkName}/{contractAddress(0x[a-fA-F0-9]{40})}/{tokenId}/image
https://metadata.ens.domains/{networkName}/{contractAddress(0x[a-fA-F0-9]{40})}/{tokenId}/image


ENS NFT IMAGE RASTERIZATION

ENS NFT image rasterization

PATH PARAMETERS

networkName
required
string (networkName)
Enum: "mainnet" "rinkeby" "ropsten" "goerli"

Name of the chain to query for.

contractAddress
required
string (contractAddress)
Example: 0x57f1887a8BF19b14fC0dF6Fd9B2acc9Af147eA85

tokenId
required
string (tokenId)
Example: 4221908525551133525058944220830153...

Labelhash(v1) /Namehash(v2) of your ENS name.

More:
https://docs.ens.domains/contract-api-reference/name-processing#hashing-names


RESPONSES

200

Image file

500

Internal Server Error

501

Unsupported network

get/{networkName}/{contractAddress(0x[a-fA-F0-9]{40})}/{tokenId}/rasterize
https://metadata.ens.domains/{networkName}/{contractAddress(0x[a-fA-F0-9]{40})}/{tokenId}/rasterize


ENS AVATAR METADATA

ENS avatar metadata

PATH PARAMETERS

networkName
required
string (networkName)
Enum: "mainnet" "rinkeby" "ropsten" "goerli"

Name of the chain to query for.

name
required
string (ensName)
Example: nick.eth

ENS name


RESPONSES

200

Metadata object

404

No results found

501

Unsupported network

504

Gateway Timeout

get/{networkName}/avatar/{name}/meta
https://metadata.ens.domains/{networkName}/avatar/{name}/meta


RESPONSE SAMPLES

 * 200

Content type
application/jsonapplication/xmlapplication/json
Copy
Expand all Collapse all
{
 * "uri": "ENS name of avatar holder",
 * "is_owner": "Ownership verification of NFT",
 * "host_meta": {
    * "chain_id": "Chain ID where NFT resides",
    * "namespace": "Type of NFT contract",
    * "contract_address": "Contract address of NFT",
    * "token_id": "Token ID of NFT",
    * "reference_url": "Marketplace URL of NFT"
   
   },
 * "name": "Name of NFT",
 * "description": "Description of NFT",
 * "attributes": "Attributes of NFT",
 * "image": "Image data/URL of NFT",
 * "image_url": "Image data/URL of NFT",
 * "image_data": "Image data of NFT",
 * "background_color": "Background color of NFT",
 * "youtube_url": "Youtube URL of NFT"

}


ENS AVATAR IMAGE

ENS avatar image

PATH PARAMETERS

networkName
required
string (networkName)
Enum: "mainnet" "rinkeby" "ropsten" "goerli"

Name of the chain to query for.

name
required
string (ensName)
Example: nick.eth

ENS name


RESPONSES

200

Image file

404

No results found

501

Unsupported network

504

Gateway Timeout

get/{networkName}/avatar/{name}
https://metadata.ens.domains/{networkName}/avatar/{name}


QUERY ENDPOINT FOR NFT URIS

Query endpoint for NFT URIs

QUERY PARAMETERS

uri
string

NFT URI as defined under CAIP-22 for erc721 assets and CAIP-29 for erc1155
assets.


RESPONSES

200

NFT metadata

500

Internal Server Error

get/queryNFT
https://metadata.ens.domains/queryNFT


ENS NFT PREVIEW

ENS NFT preview

PATH PARAMETERS

name
required
string

ENS name.


RESPONSES

200

Image file

404

No results found

504

Gateway Timeout

get/preview/{name}
https://metadata.ens.domains/preview/{name}