Yurba Docs
Yurba Documentation

Get started

Overview OAuth 2.0 Websocket API

Accounts

GET /get_me GET /tokens POST /login DELETE /logout POST /register POST /confirm POST /reset POST /reset_password GET /incoming_requests GET /outcoming_requests

Apps

GET /apps POST /apps GET /apps/{public_key} GET /apps/{public_key}/token POST /apps/{public_key}/token GET /apps/tokens DELETE /apps/tokens/{token} DELETE /apps/{app_id} GET /apps/user/{token}

Users

GET /user/{user_tag} GET /user/{user_tag}/friends GET /user/{user_tag}/playlists GET /user/{user_tag}/photos GET /user/{user_tag}/posts POST /user/{user_tag}/post

Relationships

GET /user/{user_tag}/relationships PATCH /user/{user_tag}/subscribe DELETE /incoming_requests/{user_id}

Dialogs (Messages)

GET /dialogs POST /dialogs POST /dialogs/private/{user_id} GET /dialogs/{dialog_id} GET /dialogs/{dialog_id}/messages GET /dialogs/messages/{message_id} DELETE /dialogs/messages/
{message_id}

Tracks (MuseBase)

GET /musebase/{track_id} GET /musebase/find/{mask} POST /musebase/upload GET /musebase/playlists/{playlist_id} GET /user/{user_tag}/playlists

Photos

GET /photos/{photo_id} POST /photos/upload DELETE /photos/{photo_id} GET /user/{user_tag}/photos

Posts

GET /posts/{post_id} DELETE /posts/{post_id} PATCH /posts/{post_id} PATCH /posts/{post_id}/like GET /posts/{post_id}/comments POST /posts/{post_id}/comment

Comments

GET /comments/{comment_id} DELETE /comments/{comment_id} PATCH /comments/{comment_id}/like

Safety

GET /safety/link

Other

GET /languages GET /countries GET /countries/{country_id}/regions GET /countries/{country_id}/regions/
{region_id}/cities

Yurba CDN (cdn.yurba.one)

GET /photos/{photo_id}.jpg GET /musebase/{track_id}.mp3

For Desktop Developers

START Get started METHOD Player METHOD CSS METHOD log METHOD select METHOD reload METHOD createWindow METHOD createNotification METHOD quit METHOD browse METHOD fetch METHOD unixToDate METHOD createButton METHOD eventButton METHOD setButtonIndicator METHOD hideButtonIndicator METHOD alert METHOD observe START Using Tab METHOD openTab METHOD closeTab METHOD setTab METHOD tabEvent OBJECT User OBJECT window

GET /user/{user_tag}

Returns UserModel.

Request URL params:

user_tag: string

Request headers:

token: string

Response:

{ ID: int, Name: string, Surname: string, Link: string, RegisterDate: int, Avatar: int, Banner: int, Status: string, About: string, Country: string, City: string, CityNative: string, WorksAt: string, Birthday: string, Relationships: int, Website: string, Languages: list[string], Sub: int, # 0 - Yurba Plus, 1 - Yurba Premium Verify: string, # "None", "Default", "Organisation", "Goverment" Ban: int, Emoji: string, Online: OnlineModel, OriginalAccount: int, CosmeticAvatar: int, Coins: int, Posts: int, # count of posts Friends: int, # count of friends Followers: int, # count of followers RelationshipState: string, # "strangers", "me_subscribed", "he_subscribed", "friends" PostState: int, # who can post on the wall (0 - all, 1 - friends, 2 - nobody) CommentsState: int, # who can comments the user's posts (0 - all, 1 - friends, 2 - nobody) AddFriendState: int, # who can send a friend request to user (1 - all, 0 - nobody) ViewFriendsState: int, # who can see the user's friends (0 - all, 1 - friends, 2 - nobody) SendMessageState: int, # who can send a message to the user (0 - all, 1 - friends, 2 - nobody) ViewAvatarState: int, # who can see the user's avatar (0 - all, 1 - friends, 2 - nobody) ViewBirthdayState: int, # who can see the user's birthday (0 - all, 1 - friends, 2 - nobody) SearchState: int, # display in search (1 - allow, 0 - disallow) OnlineType: int, # online display type (0 - default, 1 - approximate, 2 - invisible, the last one will get 0 to other people) # NOT EMPTY ONLY IF UNSAFE (/get_me) Password: string, Email: string, EmailReserve: string, TrackList: int, NewMessages: int, # count of new messages NewNotifications: int # count of friend requests FriendsRequests: int, # count of new notifications } About OnlineModel: Scroll Down

Example:

{ ID: 4, Name: "Yurba", Surname: "", Link: "yurba", RegisterDate: 1635946555, Avatar: 733, Banner: 732, Status: "Official account of Yurba", About: "", Country: "Україна", City: "", CityNative: "", WorksAt: "", Birthday: "", Relationships: 0, Website: "yurba.one", Languages: [], Sub: 0, Verify: "Organisation", Ban: 0, Emoji: "0", Online: { Online: false, LastBeen: 1710895556, Degree: "none" }, OriginalAccount: 0, CosmeticAvatar: 0, Coins: 0, Posts: 0, Friends: 1, Followers: 2, RelationshipState: "strangers", PostState: 0, CommentsState: 0, AddFriendState: 1, ViewFriendsState: 0, SendMessageState: 0, ViewAvatarState: 0, ViewBirthdayState: 0, SearchState: 1, OnlineType: 2, Password: null, Email: null, EmailReserve: null, TrackList: 0, NewMessages: 0, NewNotifications: 0, FriendsRequests: 0 }

Errors:

auth_failed: token authorization failed

invalid_user: your user is missing from the database or cannot be read

ShortUserModel

Some endpoints contain a ShortUserModel, which contains basic information about the user

{ ID: int, Name: string, Surname: string, Link: string, Avatar: int, Sub: int, Verify: string, Ban: int, Emoji: string, CosmeticAvatar: int, CommentsState: int, RelationshipState: string }

Example:

{ ID: 1, Name: "Ілля", Surname: "Чернов", Link: "sample", Avatar: 715, Sub: 1, Verify: "Default", Ban: 0, Emoji: ":ua:", CosmeticAvatar: 0, CommentsState: 0, RelationshipState: "friends" }

OnlineModel

{ Online: bool, LastBeen: int, Degree: string, Status: string }

Example:

{ Online: false, LastBeen: 1710895556, Degree: "none", Status: "online" }
Degrees

none: the user did not hide his online
recent: <= one day ago (recently)
few_days_ago: <= 3 days ago (few days ago)
this_week: <= 7 days ago (this week)
this_month: <= 30 days (this month)
long_ago: > 30 days (long time ago)

Statuses

online: when the user is online, everyone will see a green icon
dont_disturb: do not disturb, the user does not receive notifications, red icon
moved_away: visual orange icon only