Global

Methods

(async) accountBlockById(id) → {Object}

Source:
Block an account
Parameters:
Name Type Description
id string The ID of the account you want to block
Returns:
Type
Object

(async) accountBlocks() → {Object}

Source:
Get your blocks
Returns:
Type
Object

(async) accountById(id) → {Object}

Source:
Get an account
Parameters:
Name Type Description
id string The ID of the account you want to get
Returns:
Type
Object

(async) accountFollowersById(id) → {Object}

Source:
Get account followers
Parameters:
Name Type Description
id string The ID of the account you want to get the followers of
Returns:
Type
Object

(async) accountFollowingById(id) → {Object}

Source:
Get account following
Parameters:
Name Type Description
id string The ID of the account you want to get the following of
Returns:
Type
Object

(async) accountFollowRequests() → {Object}

Source:
Get your follow requests
Returns:
Type
Object

(async) accountLikes() → {Object}

Source:
Get your favourites
Returns:
Type
Object

(async) accountMuteById(id) → {Object}

Source:
Mute an account
Parameters:
Name Type Description
id string The ID of the account you want to mute
Returns:
Type
Object

(async) accountMutes() → {Object}

Source:
Get your mutes
Returns:
Type
Object

(async) accountNotifications() → {Object}

Source:
Get your notifications
Returns:
Type
Object

(async) accountSearch(query) → {Object}

Source:
Search query
Parameters:
Name Type Description
query string The query you want to search
Returns:
Type
Object

(async) accountStatusesById(id) → {Object}

Source:
Get account posts
Parameters:
Name Type Description
id string The ID of the account you want to get the posts of
Returns:
Type
Object

(async) accountUnblockById(id) → {Object}

Source:
Unblock an account
Parameters:
Name Type Description
id string The ID of the account you want to unblock
Returns:
Type
Object

(async) accountUnmuteById(id) → {Object}

Source:
Unmute an account
Parameters:
Name Type Description
id string The ID of the account you want to unmute
Returns:
Type
Object

(async) followAccountById(id) → {Object}

Source:
Follow an account
Parameters:
Name Type Description
id string The ID of the account you want to follow
Returns:
Type
Object

(async) homeTimeline() → {Object}

Source:
Get your timeline
Returns:
Type
Object

(async) instance() → {Object}

Source:
Get the info about the instance
Returns:
Type
Object

(async) mediaUpload(file) → {Object}

Source:
Upload a status
Parameters:
Name Type Description
file string The location of the file you want to upload
Returns:
Type
Object

(async) nodeinfo() → {Object}

Source:
Get node info
Returns:
Type
Object

(async) publicTimeline() → {Object}

Source:
Get the public timeline
Returns:
Type
Object

(async) statusById(id) → {Object}

Source:
Get a status
Parameters:
Name Type Description
id string The ID of the status you want to get
Returns:
Type
Object

(async) statusCreate(mediaIds, captionopt, sensitiveopt, scopeopt, inReplyToIdopt)

Source:
Parameters:
Name Type Attributes Default Description
mediaIds Array.<number> An array of media ids
caption string <optional>
null The caption
sensitive bool <optional>
false Whether or not it's sensitive
scope string <optional>
public Must be private, unlisted or public
inReplyToId number <optional>
null The ID it replies to

(async) statusFavouriteById(id) → {Object}

Source:
Favourite a status
Parameters:
Name Type Description
id string The ID of the status you want to favourite
Returns:
Type
Object

(async) statusLikedById(id) → {Object}

Source:
Get who favoureted a status
Parameters:
Name Type Description
id string The ID of the status you want to get the favourites of
Returns:
Type
Object

(async) statusRebloggedById(id) → {Object}

Source:
Get who reblogged a status
Parameters:
Name Type Description
id string The ID of the status you want to get the rebloggers of
Returns:
Type
Object

(async) statusUnfavouriteById(id) → {Object}

Source:
Unfavourite a status
Parameters:
Name Type Description
id string The ID of the status you want to unfavourite
Returns:
Type
Object

(async) unfollowAccountById(id) → {Object}

Source:
Unfollow an account
Parameters:
Name Type Description
id string The ID of the account you want to unfollow
Returns:
Type
Object

(async) user() → {Object}

Source:
Confirm that the app's OAuth2 credentials work
Returns:
Type
Object