Skip to content

Simple API to get the records of an ENS name. The link below is just an example. Please clone and run your own endpoint.

Notifications You must be signed in to change notification settings

arikchakma/ens-records

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ENS Records API

⚠️ If you plan to use this in production, please deploy your own endpoint (it's free until heavy traffic).

Request /name.eth or /0x... and the API will return the following ENS records:

  • description
  • avatar (append ?avatar query to URL)
  • url
  • telegram
  • twitter
  • github
  • email

It works with ENS names and Ethereum addresses, but is slightly faster with ENS names.

This is probably not the fastest way to fetch the records of an ENS name, but certainly the easiest that I've come across.

Deploy your own

You don't need any coding experience to deploy your own API endpoint, but you will need a few accounts:

Once you've created those accounts, Deploy to Vercel via the button below and follow the deployment flow.

Deploy with Vercel

Under "Configure Project", add the Project ID and Project Secret from Infura.

Once Vercel is done deploying your project, press "Go to Dashboard" then "Visit". That is your API endpoint!

Run locally

You will need Node.js and npm installed on your machine.

  1. Install dependencides with npm install
  2. Rename .env.example to .env and add your Infura project credentials
  3. Start the local server with npm start

About

Simple API to get the records of an ENS name. The link below is just an example. Please clone and run your own endpoint.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.5%
  • Shell 1.5%