Web3.bio Profile API
Web3 Identity Resolver ยท Web3 DID Resolver ยท Web3 Domain Name Service Resolver
Web3.bio Profile API enables developers to easily and quickly integrate Web3 universal profiles from Ethereum (ENS), Farcaster, Lens Protocol, Unstoppable Domains, Solana (SNS), .bit and Next.ID into their applications. These APIs are already integrated into Web3.bio search and profile services.
This documentation describes the publicly available endpoints of the Web3.bio Profile API, which is a set of RESTful JSON APIs. It explains how to use them and what they return. Currently, the APIs are offered for free to assist developers in getting started with Web3 profiles. We will do our best to maintain uptime.
API Endpoints
The main public API endpoint domain for Web3.bio Profile API is api.web3.bio, and the staging domain is api-staging.web3.bio.
Web3.bio Profile API also provides basic profiles for name service resolution under api.web3.bio/ns (Replace profile with ns).
Universal Profile API
Retrieve Universal profiles or name service resolution across platforms
Endpoints
Parameters
- identity string
An Ethereum address, an ENS domain, a Lens handle, a Farcaster username (ends with .farcaster), a Next.ID address, or an Unstoppable Domains domain.
Examples
- Ethereum /profile/0xd8da...6045OR/ns/0xd8da...6045
- ENS /profile/vitalik.ethOR/ns/vitalik.eth
- Farcaster /profile/dwr.eth.farcasterOR/ns/dwr.eth.farcaster
- Lens /profile/stani.lensOR/ns/stani.lens
- Unstoppable Domains /profile/sandy.nftOR/ns/sandy.nft
- Next.ID /profile/0x028f......3e50OR/ns/0x028f......3e50
Responses
// https://api.web3.bio/profile/0xd8da6bf26964af9d7eed9e03e53415d37aa96045
// https://api.web3.bio/profile/vitalik.eth
[
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vitalik.eth",
"platform": "ens",
"displayName": "vitalik.eth",
"avatar": "https://cdn.simplehash.com/assets/db17eebeede377614b156126590d5e4c521a80fef6bdce78e8e6563b4526b417.gif",
"description": null,
"email": null,
"location": null,
"header": null,
"contenthash": "ipfs://bafybeifkprcu4gotrr7tftkdlnmhgi6cxz5rj3mmawzujez2hixqmx52vi",
"links": {
"website": {
"link": "https://vitalik.ca",
"handle": "vitalik.ca"
}
}
"social": {}
},
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vbuterin",
"platform": "farcaster",
"displayName": "Vitalik Buterin",
"avatar": "https://i.imgur.com/gF9Yaeg.jpg",
"description": "hullo",
"email": null,
"location": null,
"header": null,
"contenthash": null,
"links": {
"farcaster": {
"link": "https://warpcast.com/vbuterin",
"handle": "vbuterin"
}
},
"social": {
"uid": 5650,
"follower": 312547,
"following": 72
}
},
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vitalik.lens",
"platform": "lens",
"displayName": "Vitalik Buterin",
"avatar": "https://ik.imagekit.io/lens/media-snapshot/d2762e3b5f2532c648feec96bf590923ea6c3783fee428cbb694936ce62962e0.jpg",
"description": "Ethereum Fable of the Dragon Tyrant (not mine but it's important): https://www.youtube.com/watch?v=cZYNADOHhVY Abolish daylight savings time and leap seconds",
"email": null,
"header": null,
"contenthash": null,
"links": {
"lens": {
"link": "https://www.lensfrens.xyz/vitalik",
"handle": "vitalik"
}
},
"social": {
"uid": 100275,
"follower": 33500,
"following": 7
}
}
]
// https://api.web3.bio/ns/0xd8da6bf26964af9d7eed9e03e53415d37aa96045
// https://api.web3.bio/ns/vitalik.eth
[
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vitalik.eth",
"platform": "ens",
"displayName": "vitalik.eth",
"avatar": "https://cdn.simplehash.com/assets/db17eebeede377614b156126590d5e4c521a80fef6bdce78e8e6563b4526b417.gif",
"description": null
},
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vbuterin",
"platform": "farcaster",
"displayName": "Vitalik Buterin",
"avatar": "https://i.imgur.com/gF9Yaeg.jpg",
"description": "hullo"
},
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vitalik.lens",
"platform": "lens",
"displayName": "Vitalik Buterin",
"avatar": "https://ik.imagekit.io/lens/media-snapshot/d2762e3b5f2532c648feec96bf590923ea6c3783fee428cbb694936ce62962e0.jpg",
"description": "Ethereum Fable of the Dragon Tyrant (not mine but it's important): https://www.youtube.com/watch?v=cZYNADOHhVY Abolish daylight savings time and leap seconds"
}
]
ENS Profile API
Retrieve an ENS profile or name service resolution
Endpoints
Parameters
- identity string
An Ethereum address or an ENS domain.
Examples
- Ethereum profile/ens/0xd8da...6045OR/ns/ens/0xd8da...6045
- ENS /profile/ens/vitalik.ethOR/ns/ens/vitalik.eth
Responses
// https://api.web3.bio/profile/ens/0xd8da6bf26964af9d7eed9e03e53415d37aa96045
// https://api.web3.bio/profile/ens/vitalik.eth
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vitalik.eth",
"platform": "ens",
"displayName": "vitalik.eth",
"avatar": "https://cdn.simplehash.com/assets/db17eebeede377614b156126590d5e4c521a80fef6bdce78e8e6563b4526b417.gif",
"description": null,
"email": null,
"location": null,
"header": null,
"contenthash": "ipfs://bafybeifkprcu4gotrr7tftkdlnmhgi6cxz5rj3mmawzujez2hixqmx52vi",
"links": {
"website": {
"link": "https://vitalik.ca",
"handle": "vitalik.ca"
}
},
"social": {}
}
// https://api.web3.bio/ns/ens/0xd8da6bf26964af9d7eed9e03e53415d37aa96045
// https://api.web3.bio/ns/ens/vitalik.eth
{
"address": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
"identity": "vitalik.eth",
"platform": "ens",
"displayName": "vitalik.eth",
"avatar": "https://cdn.simplehash.com/assets/db17eebeede377614b156126590d5e4c521a80fef6bdce78e8e6563b4526b417.gif",
"description": null
}
Farcaster Profile API
Retrieve a Farcaster profile or name service resolution
Endpoints
Parameters
- identity string
An Ethereum address or a Farcaster username/fname or a Farcaster FID (with fid:).
Examples
- Ethereum /profile/farcaster/0x8fc5...a2eaOR/ns/farcaster/0x8fc5...a2ea
- Farcaster /profile/farcaster/dwr.ethOR/ns/farcaster/dwr.eth
- Farcaster /profile/farcaster/fid:3OR/ns/farcaster/fid:3
// https://api.web3.bio/profile/farcaster/0x8fc5d6afe572fefc4ec153587b63ce543f6fa2ea
// https://api.web3.bio/profile/farcaster/dwr.eth
// https://api.web3.bio/profile/farcaster/fid:3
{
"address": "0x8fc5d6afe572fefc4ec153587b63ce543f6fa2ea",
"identity": "dwr.eth",
"platform": "farcaster",
"displayName": "Dan Romero",
"avatar": "https://res.cloudinary.com/merkle-manufactory/image/fetch/c_fill,f_png,w_256/https://lh3.googleusercontent.com/MyUBL0xHzMeBu7DXQAqv0bM9y6s4i4qjnhcXz5fxZKS3gwWgtamxxmxzCJX7m2cuYeGalyseCA2Y6OBKDMR06TWg2uwknnhdkDA1AA",
"description": "Working on Farcaster and Warpcast.",
"email": null,
"location": "Los Angeles, CA, USA",
"header": null,
"contenthash": null,
"links": {
"farcaster": {
"link": "https://warpcast.com/dwr.eth",
"handle": "dwr.eth"
}
},
"social": {
"uid": 3,
"follower": 385189,
"following": 3111
}
}
// https://api.web3.bio/ns/farcaster/0x8fc5d6afe572fefc4ec153587b63ce543f6fa2ea
// https://api.web3.bio/ns/farcaster/dwr.eth
// https://api.web3.bio/ns/farcaster/fid:3
{
"address": "0x8fc5d6afe572fefc4ec153587b63ce543f6fa2ea",
"identity": "dwr.eth",
"platform": "farcaster",
"displayName": "Dan Romero",
"avatar": "https://res.cloudinary.com/merkle-manufactory/image/fetch/c_fill,f_png,w_256/https://lh3.googleusercontent.com/MyUBL0xHzMeBu7DXQAqv0bM9y6s4i4qjnhcXz5fxZKS3gwWgtamxxmxzCJX7m2cuYeGalyseCA2Y6OBKDMR06TWg2uwknnhdkDA1AA",
"description": "Working on Farcaster and Warpcast."
}
Lens Profile API
Retrieve a Lens profile or name service resolution
Endpoints
Parameters
- identity string
An Ethereum/Polygon address or a Lens handle.
Examples
- Ethereum / Polygon /profile/lens/0x7241...9dffOR/ns/lens/0x7241...9dff
- Lens /profile/lens/stani.lensOR/ns/lens/stani.lens
// https://api.web3.bio/profile/lens/0x7241dddec3a6af367882eaf9651b87e1c7549dff
// https://api.web3.bio/profile/lens/stani.lens
{
"address": "0x7241dddec3a6af367882eaf9651b87e1c7549dff",
"identity": "stani.lens",
"platform": "lens",
"displayName": "Stani",
"avatar": "https://ik.imagekit.io/lens/media-snapshot/e3adfb7046a549480a92c63de2d431f1ced8e516ea285970267c4dc24f941856.png",
"description": "Building @LensProtocol & @AaveAave",
"email": null,
"location": null,
"header": "https://ik.imagekit.io/lens/media-snapshot/692020434413dd88dd96a93f9df08cfefd0a3b84abba5772c14a2f56ac01b0cd.jpg",
"contenthash": null,
"links": {
"lens": {
"link": "https://www.lensfrens.xyz/stani",
"handle": "stani"
},
"website": {
"link": "https://lens.xyz",
"handle": "lens.xyz"
}
},
"social": {
"uid": 5,
"follower": 92157,
"following": 1139
}
}
// https://api.web3.bio/ns/lens/0x7241dddec3a6af367882eaf9651b87e1c7549dff
// https://api.web3.bio/ns/lens/stani.lens
{
"address": "0x7241dddec3a6af367882eaf9651b87e1c7549dff",
"identity": "stani.lens",
"platform": "lens",
"displayName": "Stani",
"avatar": "https://ik.imagekit.io/lens/media-snapshot/e3adfb7046a549480a92c63de2d431f1ced8e516ea285970267c4dc24f941856.png",
"description": "Building @LensProtocol & @AaveAave"
}
Unstoppable Domains Profile API
Retrieve an Unstoppable Domains profile or name service resolution
Endpoints
Parameters
- identity string
An Ethereum address or an Unstoppable Domains domain.
Examples
- Ethereum /profile/unstoppabledomains/0x94ef...ab23OR/ns/unstoppabledomains/0x94ef...ab23
- Unstoppable Domains /profile/unstoppabledomains/sandy.nftOR/ns/unstoppabledomains/sandy.nft
// https://api.web3.bio/profile/unstoppabledomains/0x94ef5300cbc0aa600a821ccbc561b057e456ab23
// https://api.web3.bio/profile/unstoppabledomains/sandy.nft
{
"address": "0x94ef5300cbc0aa600a821ccbc561b057e456ab23",
"identity": "sandy.nft",
"platform": "unstoppabledomains",
"displayName": "Pink Mamba",
"avatar": "https://storage.googleapis.com/unstoppable-client-assets/images/user/1092584/f259e49c-a3d3-429f-a703-2e9d35d8da21.png",
"description": "COO of Unstoppable and Founder of Unstoppable Women of Web3 Sandy Carter is a leading voice in technology, social media, and web3/metaverse being recognized as TOP10 most powerful women in tech.",
"email": null,
"location": "Metaverse",
"header": "https://storage.googleapis.com/unstoppable-client-assets/images/user/1092584/4d3f4608-6b29-4847-95d3-e7484b255278.png",
"contenthash": "ipfs://Qmar8DH5xBihbGU449zKAg4sx7ahHbFZgksYHKBFFhfVq7",
"links": {
"url": {
"link": "https://gateway.pinata.cloud/ipfs/Qmar8DH5xBihbGU449zKAg4sx7ahHbFZgksYHKBFFhfVq7",
"handle": "sandy.nft"
},
"twitter": {
"link": "https://x.com/Sandy_carter",
"handle": "Sandy_carter"
},
"discord": {
"link": "",
"handle": "SandyCarter#6286"
},
"lens": {
"link": "https://www.lensfrens.xyz/sandracarter",
"handle": "sandracarter.lens"
},
"telegram": {
"link": "https://t.me/sandycarter",
"handle": "sandycarter"
},
"youtube": {
"link": "https://www.youtube.com/@sandycarter3993",
"handle": "@sandycarter3993"
}
},
"social": {
"uid": "sandy.nft",
"follower": 137,
"following": 0
}
}
// https://api.web3.bio/ns/unstoppabledomains/0x94ef5300cbc0aa600a821ccbc561b057e456ab23
// https://api.web3.bio/ns/unstoppabledomains/sandy.nft
{
"address": "0x94ef5300cbc0aa600a821ccbc561b057e456ab23",
"identity": "sandy.nft",
"platform": "unstoppabledomains",
"displayName": "Pink Mamba",
"avatar": "https://storage.googleapis.com/unstoppable-client-assets/images/user/1092584/f259e49c-a3d3-429f-a703-2e9d35d8da21.png",
"description": "COO of Unstoppable and Founder of Unstoppable Women of Web3 Sandy Carter is a leading voice in technology, social media, and web3/metaverse being recognized as TOP10 most powerful women in tech."
}
Solana (SNS) Profile API
Retrieve a Solana Name Service profile or name service resolution
Endpoints
Parameters
- identity string
A Solana address or a Solana Name Service domain.
Examples
- Solana /profile/solana/HKKp49qGWXd6...OR/ns/solana/HKKp49qGWXd6...
- Solana Name Service /profile/solana/bonfida.solOR/ns/solana/bonfida.sol
// https://api.web3.bio/profile/solana/HKKp49qGWXd639QsuH7JiLijfVW5UtCVY4s1n2HANwEA
// https://api.web3.bio/profile/solana/bonfida.sol
{
"address": "HKKp49qGWXd639QsuH7JiLijfVW5UtCVY4s1n2HANwEA",
"identity": "bonfida.sol",
"platform": "sns",
"displayName": "bonfida.sol",
"avatar": null,
"description": null,
"email": null,
"location": null,
"header": null,
"contenthash": null,
"links": {},
"social": {}
}
// https://api.web3.bio/ns/solana/HKKp49qGWXd639QsuH7JiLijfVW5UtCVY4s1n2HANwEA
// https://api.web3.bio/ns/solana/bonfida.sol
{
"address": "HKKp49qGWXd639QsuH7JiLijfVW5UtCVY4s1n2HANwEA",
"identity": "bonfida.sol",
"platform": "sns",
"displayName": "bonfida.sol",
"avatar": null,
"description": null,
}
.bit Profile API
Retrieve a .bit profile or name service resolution
Endpoints
Parameters
- identity string
An Ethereum address or a .bit username.
Examples
- Ethereum /profile/dotbit/0xfa8f...7f1dOR/ns/dotbit/0xfa8f...7f1d
- .bit /profile/dotbit/bestcase.bitOR/ns/dotbit/bestcase.bit
// https://api.web3.bio/profile/dotbit/0xfa8fa9cf58eaff86aa208366a14d69de87867f1d
// https://api.web3.bio/profile/dotbit/bestcase.bit
{
"address": "0xfa8fa9cf58eaff86aa208366a14d69de87867f1d",
"identity": "bestcase.bit",
"platform": "dotbit",
"displayName": "bestcase.bit",
"avatar": "https://uploads-ssl.webflow.com/621ed3ca24af847de76a2dae/635cf43497c26382c70e1c15_bestcase.jpg",
"description": ".bit is a brand dedicated to assist every single individual and community to unleash their potential and discover more possibilities through the development of self-sovereign identity. .bit (https://did.id) is also a product which is the only cross-chain unified DID protocol, based on the unique technical architecture, .bit provides services for more than Web3 users. .bit is able to verify signatures by different asymmetric cryptographic algorithms, which allow users to manage and control their .bit accounts with public chain addresses, email addresses, even customized passcodes and biometric data from mobile devices. .bit determines to build the most practical and applicable suite of infrastructural tools, safeguarding the endowed right of identity sovereignty for each bit of the world.",
"email": null,
"location": null,
"header": null,
"contenthash": "ipns://libp2p.io",
"links": {
"twitter": {
"link": "https://x.com/dotbitHQ",
"handle": "dotbitHQ"
},
"github": {
"link": "https://github.com/dotbitHQ",
"handle": "dotbitHQ"
},
"discord": {
"link": "https://discord.com/invite/did",
"handle": "did"
},
"website": {
"link": "https://www.did.id/",
"handle": "www.did.id"
},
"nostr": {
"link": "https://snort.social/p/npub1y0epuwrv23vcue2g5ft8armwdsjfd4dy6frzwmw72y847d3v2ahq7vh2ag",
"handle": "npub1y0epuwrv23vcue2g5ft8armwdsjfd4dy6frzwmw72y847d3v2ahq7vh2ag"
}
},
"social": {}
}
// https://api.web3.bio/ns/dotbit/0xfa8fa9cf58eaff86aa208366a14d69de87867f1d
// https://api.web3.bio/ns/dotbit/bestcase.bit
{
"address": "0xfa8fa9cf58eaff86aa208366a14d69de87867f1d",
"identity": "bestcase.bit",
"platform": "dotbit",
"displayName": "bestcase.bit",
"avatar": "https://uploads-ssl.webflow.com/621ed3ca24af847de76a2dae/635cf43497c26382c70e1c15_bestcase.jpg",
"description": ".bit is a brand dedicated to assist every single individual and community to unleash their potential and discover more possibilities through the development of self-sovereign identity. .bit (https://did.id) is also a product which is the only cross-chain unified DID protocol, based on the unique technical architecture, .bit provides services for more than Web3 users. .bit is able to verify signatures by different asymmetric cryptographic algorithms, which allow users to manage and control their .bit accounts with public chain addresses, email addresses, even customized passcodes and biometric data from mobile devices. .bit determines to build the most practical and applicable suite of infrastructural tools, safeguarding the endowed right of identity sovereignty for each bit of the world."
}
Status and Errors
Successful responses are indicated with a 200
HTTP status code.
Error responses are served with a non-200-series HTTP code, specifically 404
or 500
. Typical error responses contain an error
node indicating a human-readable description of the error.
// https://api.web3.bio/profile/web3bio_example.eth
{
"address": null,
"identity": "web3bio_example.eth",
"platform": "ens",
"error": "Not Found"
}
Release Notes
We are gradually making updates to Web3.bio Profile API. You may expect new features, improvements and bug fixes. If you have any feedback on the features or want to report a bug, please reach out to us on Web3.bio Twitter or Telegram group.
๐๏ธ March Update
- Feature Added Solana Name Service (Bonfida) query support to the Profile API.
๐ ๏ธ January Update
- Update Added
contenthash
field for more complete ENS, Unstoppable Domains and .bit Profile API queries. - Update Added offchain query support for ENS Profile API.
๐ December Update
- Feature Added
ns
basic profile resolution query support to the Profile APIs.
๐ November Update
- Feature Added Unstoppable Domains query support to the Profile APIs.
- Update Added Ethereum address query support to all Profile APIs.
๐ ๏ธ October Update
- Change Deprecated
addresses
field for faster ENS API queries.
๐ฎ August Update
- Feature Added .bit query support to the Profile APIs.
- Update Added ENS username support in the Farcaster Profile API.
๐ July Update
- Feature Added Next.ID query support to the Profile APIs.
๐ June Update
- Feature Added Universal Profile API. Developers can retrieve universal profiles across supported platforms with a single query.
๐ May Update
- Feature Added Ethereum Name Service (ENS), Lens, and Farcaster support to the Profile APIs.