API should be used to build clients for iOS, Android and other platforms. Clients should have their own branding starting with "sub" prefix: Subchat, Sublevel, Subversion, etc. Clients can provide additional features like image support, language translation to and from English, etc.

You can authenticate by getting a token from /api/login endpoint then setting the Bearer header for following requests. You can paginate a GET endpoint using ?p=number parameter.

GET Endpoints

  • /api/feed
  • /api/following
  • /api/followers
  • /api/mentions
  • /api/replies
  • /api/saved
  • /api/people — optional q param to find people
  • /api/discover — optional q param to search content
  • /api/trending
  • /api/messages
  • /api/notifications
  • /api/reply/{id:int}
  • /api/{username}
  • /api/chat/{username}

POST Endpoints

  • /api/login — username*, password* params returns token and user
  • /api/register — username*, email*, password1*, password2*, email*, first_name, last_name, emoji, birthday, location params returns token and user
  • /api/post — parent, content* params returns post details
  • POST Actions

    • /api/erase/{id:int}
    • /api/unsend/{id:int}
    • /api/delete/{id:int}
    • /api/save/{id:int}
    • /api/unsave/{id:int}
    • /api/follow/{username}
    • /api/unfollow/{username}

    PUT Endpoints

    • work in progress