Skip to content
Ethereum Follow Protocol Logo EFP Docs

Users

API URL: https://api.ethfollow.xyz/api/v1

Routes

Terminal window
GET /users/:addressOrENS/followers
GET /users/:addressOrENS/following
GET /users/:addressOrENS/list-records
GET /users/:addressOrENS/primary-list
GET /users/:addressOrENS/stats

/users/:addressOrENS/followers

Get followers by Address or ENS Name

TODO: pagination

Terminal window
curl http://api.ethfollow.xyz/api/v1/users/dr3a.eth/followers
// sample response
{
  "followers": [
    {
      "follower": "0x0483499fac8c6eaccd64c5d316762af172f5eb4a",
      "tags": ["dr3a"],
      "is_following": false,
      "is_blocked": true,
      "is_muted": false
    },
    {
      "follower": "0x2a3bb9f9b1a305f39c917b8a5b7fba0be1fe3601",
      "tags": [],
      "is_following": false,
      "is_blocked": false,
      "is_muted": false
    },
    {
      "follower": "0x2de24a3a593ad27aa7f7db4a4a6204a57bf75d0b",
      "tags": [],
      "is_following": false,
      "is_blocked": false,
      "is_muted": false
    }
  ]
}

/users/:addressOrENS/following

Get following by Address or ENS Name

TODO: pagination

Terminal window
curl https://api.ethfollow.xyz/api/v1/users/dr3a.eth/following
// sample response
{
  "following": [
    {
      "version": 1,
      "record_type": "address",
      "data": "0x983110309620d911731ac0932219af06091b6744",
      "tags": ["efp", "ens"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0xbdb41bff7e828e2dc2d15eb67257455db818f1dc",
      "tags": ["efp", "ens"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0xf4212614c7fe0b3feef75057e88b2e77a7e23e83",
      "tags": ["efp"]
    }
  ]
}

/users/:addressOrENS/list-records

Get list records by Address or ENS Name

TODO: pagination

Terminal window
curl https://api.ethfollow.xyz/api/v1/users/dr3a.eth/list-records
// sample response
{
  "records": [
    {
      "version": 1,
      "record_type": "address",
      "data": "0x0483499fac8c6eaccd64c5d316762af172f5eb4a",
      "tags": ["block"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0x092ad3842dced68b5b6ef9cc602be66924baecdd",
      "tags": ["mute"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0x86a41524cb61edd8b115a72ad9735f8068996688",
      "tags": ["block", "mute"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0x983110309620d911731ac0932219af06091b6744",
      "tags": ["efp", "ens"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0xbdb41bff7e828e2dc2d15eb67257455db818f1dc",
      "tags": ["efp", "ens"]
    },
    {
      "version": 1,
      "record_type": "address",
      "data": "0xf4212614c7fe0b3feef75057e88b2e77a7e23e83",
      "tags": ["efp"]
    }
  ]
}

/users/:addressOrENS/primary-list

Get primary list by Address or ENS Name

Terminal window
curl http://api.ethfollow.xyz/api/v1/users/dr3a.eth/primary-list
// sample response
{
  "primary_list": "0"
}

/users/:addressOrENS/stats

Get number of followers and following by Address or ENS Name

Terminal window
curl http://api.ethfollow.xyz/api/v1/users/dr3a.eth/stats
// sample response
{
  "followers_count": 35,
  "following_count": 4
}