API

get

Get user information by ID

Path parameters

userIdstringRequired

User ID, address, or username

Query parameters

fromstringOptional

Optional user making the request

Default: ""

typestring · enumOptional

Type of identifier: 'address', 'owner', or 'username'

Default: usernamePossible values:

Responses

200

Ok

application/json

204

No content - user not found

500

Server error

application/json

get

/u/{userId}

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId} HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "_created": "text",
    "_updated": "text",
    "address": "text",
    "avatarHash": "text",
    "bannerHash": "text",
    "channelCount": 1,
    "description": "text",
    "followerCount": 1,
    "followingCount": 1,
    "isFollowing": true,
    "isNotificationsRead": true,
    "name": "text",
    "owner": "text",
    "soul": "text",
    "totalEarnings": 1,
    "userKey": "text"
  }
}

get

Get notifications for a specific user

Path parameters

userIdstringRequired

The user's unique identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

Responses

200

Ok

application/json

Responseany of

or

204

No content - no notifications found

500

Server error

application/json

get

/u/{userId}/notifications

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId}/notifications HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": 1,
      "message": "text",
      "rewardAmount": 1
    }
  ],
  "nextCursor": "text"
}

put

Mark all notifications as read for a user

Path parameters

userIdstringRequired

The user's unique identifier

Query parameters

typestring · enumOptional

Type of identifier: 'address' or 'username'

Default: usernamePossible values:

Responses

200

Ok

application/json

Responseany of

or

500

Server error

application/json

put

/u/{userId}/notifications

HTTPcURLJavaScriptPython

PUT /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId}/notifications HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1
}

get

Get users that a specific user is following

Path parameters

userIdstringRequired

The user's unique identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

typestring · enumOptional

Type of identifier: 'address' or 'username'

Default: usernamePossible values:

Responses

200

Ok

application/json

Responseany of

or

204

No content - user is not following anyone

500

Server error

application/json

get

/u/{userId}/following

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId}/following HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": "text",
      "_updated": "text",
      "address": "text",
      "avatarHash": "text",
      "bannerHash": "text",
      "channelCount": 1,
      "description": "text",
      "followerCount": 1,
      "followingCount": 1,
      "isFollowing": true,
      "isNotificationsRead": true,
      "name": "text",
      "owner": "text",
      "soul": "text",
      "totalEarnings": 1,
      "userKey": "text"
    }
  ],
  "nextCursor": "text"
}

get

Get followers of a specific user

Path parameters

userIdstringRequired

The user's unique identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

typestring · enumOptional

Type of identifier: 'address' or 'username'

Default: usernamePossible values:

Responses

200

Ok

application/json

Responseany of

or

204

No content - no followers found

500

Server error

application/json

get

/u/{userId}/followers

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId}/followers HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": "text",
      "_updated": "text",
      "address": "text",
      "avatarHash": "text",
      "bannerHash": "text",
      "channelCount": 1,
      "description": "text",
      "followerCount": 1,
      "followingCount": 1,
      "isFollowing": true,
      "isNotificationsRead": true,
      "name": "text",
      "owner": "text",
      "soul": "text",
      "totalEarnings": 1,
      "userKey": "text"
    }
  ],
  "nextCursor": "text"
}

get

Get channels that a user is a member of

Path parameters

userIdstringRequired

The user's unique identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no channels found

500

Server error

application/json

get

/u/{userId}/channels

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId}/channels HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": "text",
      "_updated": "text",
      "address": "text",
      "avatarHash": "text",
      "bannerHash": "text",
      "channelKey": "text",
      "description": "text",
      "isFollowing": true,
      "isModerator": true,
      "isOwner": true,
      "followerCount": 1,
      "name": "text"
    }
  ],
  "nextCursor": "text"
}

get

Get posts by a specific user

Path parameters

userIdstringRequired

The user's unique identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no posts found

500

Server error

application/json

get

/u/{userId}/posts

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/u/{userId}/posts HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "channels": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelKey": "text",
        "description": "text",
        "isFollowing": true,
        "isModerator": true,
        "isOwner": true,
        "followerCount": 1,
        "name": "text"
      }
    ],
    "posts": [
      {
        "_created": 1,
        "_updated": 1,
        "address": "text",
        "data": "text",
        "description": "text",
        "createdBy": "text",
        "commentCount": 1,
        "isLiked": true,
        "likesCount": 1,
        "parentKey": "text",
        "parentType": "text",
        "title": "text"
      }
    ],
    "users": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelCount": 1,
        "description": "text",
        "followerCount": 1,
        "followingCount": 1,
        "isFollowing": true,
        "isNotificationsRead": true,
        "name": "text",
        "owner": "text",
        "soul": "text",
        "totalEarnings": 1,
        "userKey": "text"
      }
    ]
  },
  "nextCursor": "text"
}

get

Get a single post by its address

Path parameters

postAddressstringRequired

The post's unique address/identifier

Query parameters

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - post not found

500

Server error

application/json

get

/p/{postAddress}

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/p/{postAddress} HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "users": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelCount": 1,
        "description": "text",
        "followerCount": 1,
        "followingCount": 1,
        "isFollowing": true,
        "isNotificationsRead": true,
        "name": "text",
        "owner": "text",
        "soul": "text",
        "totalEarnings": 1,
        "userKey": "text"
      }
    ],
    "posts": [
      {
        "_created": 1,
        "_updated": 1,
        "address": "text",
        "data": "text",
        "description": "text",
        "createdBy": "text",
        "commentCount": 1,
        "isLiked": true,
        "likesCount": 1,
        "parentKey": "text",
        "parentType": "text",
        "title": "text"
      }
    ],
    "channels": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelKey": "text",
        "description": "text",
        "isFollowing": true,
        "isModerator": true,
        "isOwner": true,
        "followerCount": 1,
        "name": "text"
      }
    ]
  }
}

get

Get popular posts across the platform

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no posts found

500

Server error

application/json

get

/posts/popular

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/posts/popular HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "channels": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelKey": "text",
        "description": "text",
        "isFollowing": true,
        "isModerator": true,
        "isOwner": true,
        "followerCount": 1,
        "name": "text"
      }
    ],
    "posts": [
      {
        "_created": 1,
        "_updated": 1,
        "address": "text",
        "data": "text",
        "description": "text",
        "createdBy": "text",
        "commentCount": 1,
        "isLiked": true,
        "likesCount": 1,
        "parentKey": "text",
        "parentType": "text",
        "title": "text"
      }
    ],
    "users": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelCount": 1,
        "description": "text",
        "followerCount": 1,
        "followingCount": 1,
        "isFollowing": true,
        "isNotificationsRead": true,
        "name": "text",
        "owner": "text",
        "soul": "text",
        "totalEarnings": 1,
        "userKey": "text"
      }
    ]
  },
  "nextCursor": "text"
}

get

Get posts for a user's feed

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

User identifier making the request

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no posts found

500

Server error

application/json

get

/posts/feed

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/posts/feed HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "channels": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelKey": "text",
        "description": "text",
        "isFollowing": true,
        "isModerator": true,
        "isOwner": true,
        "followerCount": 1,
        "name": "text"
      }
    ],
    "posts": [
      {
        "_created": 1,
        "_updated": 1,
        "address": "text",
        "data": "text",
        "description": "text",
        "createdBy": "text",
        "commentCount": 1,
        "isLiked": true,
        "likesCount": 1,
        "parentKey": "text",
        "parentType": "text",
        "title": "text"
      }
    ],
    "users": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelCount": 1,
        "description": "text",
        "followerCount": 1,
        "followingCount": 1,
        "isFollowing": true,
        "isNotificationsRead": true,
        "name": "text",
        "owner": "text",
        "soul": "text",
        "totalEarnings": 1,
        "userKey": "text"
      }
    ]
  },
  "nextCursor": "text"
}

get

Get comments for a specific post

Path parameters

postAddressstringRequired

The post's unique address/identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no comments found

500

Server error

application/json

get

/p/{postAddress}/comments

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/p/{postAddress}/comments HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "posts": [
      {
        "_created": 1,
        "_updated": 1,
        "address": "text",
        "data": "text",
        "description": "text",
        "createdBy": "text",
        "commentCount": 1,
        "isLiked": true,
        "likesCount": 1,
        "parentKey": "text",
        "parentType": "text",
        "title": "text"
      }
    ],
    "users": [
      {
        "_created": "text",
        "_updated": "text",
        "address": "text",
        "avatarHash": "text",
        "bannerHash": "text",
        "channelCount": 1,
        "description": "text",
        "followerCount": 1,
        "followingCount": 1,
        "isFollowing": true,
        "isNotificationsRead": true,
        "name": "text",
        "owner": "text",
        "soul": "text",
        "totalEarnings": 1,
        "userKey": "text"
      }
    ]
  },
  "nextCursor": "text"
}

get

Get posts from a specific channel

Path parameters

channelIdstringRequired

The channel's unique identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no posts found

500

Server error

application/json

get

/c/{channelId}/posts

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/c/{channelId}/posts HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": 1,
      "_updated": 1,
      "address": "text",
      "data": "text",
      "description": "text",
      "createdBy": "text",
      "commentCount": 1,
      "isLiked": true,
      "likesCount": 1,
      "parentKey": "text",
      "parentType": "text",
      "title": "text"
    }
  ],
  "nextCursor": "text"
}

get

Get users that are members of a specific channel

Path parameters

channelIdstringRequired

The unique channel identifier

Query parameters

cursorstringOptional

Pagination cursor for fetching next set of results

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - no users found

500

Server error

application/json

get

/c/{channelId}/users

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/c/{channelId}/users HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": "text",
      "_updated": "text",
      "address": "text",
      "avatarHash": "text",
      "bannerHash": "text",
      "channelCount": 1,
      "description": "text",
      "followerCount": 1,
      "followingCount": 1,
      "isFollowing": true,
      "isNotificationsRead": true,
      "name": "text",
      "owner": "text",
      "soul": "text",
      "totalEarnings": 1,
      "userKey": "text"
    }
  ],
  "nextCursor": "text"
}

get

Get information about a specific channel

Path parameters

channelIdstringRequired

The unique channel identifier

Query parameters

fromstringOptional

Optional user making the request, for personalized response

Default: ""

Responses

200

Ok

application/json

Responseany of

or

204

No content - channel not found

500

Server error

application/json

get

/c/{channelId}

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/c/{channelId} HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": {
    "_created": "text",
    "_updated": "text",
    "address": "text",
    "avatarHash": "text",
    "bannerHash": "text",
    "channelKey": "text",
    "description": "text",
    "isFollowing": true,
    "isModerator": true,
    "isOwner": true,
    "followerCount": 1,
    "name": "text"
  }
}

get

Get recommended channels for the user

Query parameters

cursorstringOptional

Responses

200

Ok

application/json

204

No content - no recommended channels found

500

Server error

application/json

get

/channels/recommended

HTTPcURLJavaScriptPython

GET /https:/4igrv4i2ll.execute-api.us-east-1.amazonaws.com/channels/recommended HTTP/1.1
Host: 
Accept: */*

{
  "ok": true,
  "err": "text",
  "statusCode": 1,
  "data": [
    {
      "_created": "text",
      "_updated": "text",
      "address": "text",
      "avatarHash": "text",
      "bannerHash": "text",
      "channelKey": "text",
      "description": "text",
      "isFollowing": true,
      "isModerator": true,
      "isOwner": true,
      "followerCount": 1,
      "name": "text"
    }
  ],
  "nextCursor": "text"
}