From e6f0aff8aa57cd3d8fc4abae51b3821aa4555f55 Mon Sep 17 00:00:00 2001 From: AkiraFukushima
hostname or base URL
access token from OAuth2 authorization
UserAgent is specified in header on request.
Proxy setting, or set false if don't use proxy.
POST /api/v1/follow_requests/:id/authorize
Relationship.
POST /api/v1/lists/:id/accounts
POST /api/v1/accounts/:id/block
Relationship
POST/api/v1/domain_blocks
POST /api/v1/statuses/:id/bookmark
Status.
Cancel all requests in this instance.
void
DELETE /api/v1/scheduled_statuses/:id
Call /api/v1/apps
Create an application.
your application's name
Form Data
POST /api/v1/featured_tags
FeaturedTag.
POST /api/v1/filters
Filter
POST /api/v1/lists
List.
DELETE /api/v1/lists/:id/accounts
DELETE /api/v1/conversations/:id
DELETE /api/v1/featured_tags/:id
Empty
DELETE /api/v1/filters/:id
Removed filter.
DELETE /api/v1/lists/:id
DELETE /api/v1/push/subscription
DELETE /api/v1/statuses/:id
Status
POST /api/v1/notifications/:id/dismiss
POST /api/v1/notifications/clear
POST /api/v1/statuses/:id/favourite
POST /oauth/token
Fetch OAuth access token. Get an access token based client_id and client_secret and authorization code.
POST /api/v1/accounts/:id/follow
Generate authorization url using OAuth2.
your OAuth app's client ID
as property, redirect_uri and scope are available, and must be the same as when you register your app
GET /api/v1/accounts/:id
An account.
GET /api/v1/pleroma/accounts/:id/favourites
Array of statuses.
GET /api/v1/accounts/:id/followers
The array of accounts.
GET /api/v1/accounts/:id/following
GET /api/v1/accounts/:id/lists
The array of lists.
GET /api/v1/accounts/:id/statuses
Account's statuses.
GET /api/v1/lists/:id/accounts
Array of accounts.
GET /api/v1/blocks
GET /api/v1/bookmarks
GET /api/v1/conversations
GET /api/v1/domain_blocks
Array of domain name.
GET /api/v1/endorsements
GET /api/v1/favourites
GET /api/v1/featured_tags
Array of featured tag.
GET /api/v1/filters/:id
Filter.
GET /api/v1/filters
Array of filters.
GET /api/v1/follow_requests
Array of account.
GET /api/v1/timelines/home
GET /api/v1/accounts/:id/identity_proofs
Array of IdentityProof
GET /api/v1/instance
GET /api/v1/instance/activity
GET /api/v1/custom_emojis
Array of emojis.
GET /api/v1/directory
GET /api/v1/instance/peers
GET /api/v1/trends
Maximum number of results to return. Defaults to 10.
GET /api/v1/lists/:id
GET /api/v1/timelines/list/:list_id
GET /api/v1/lists
Array of lists.
GET /api/v1/timelines/public
GET /api/v1/markers
Marker or empty object.
GET /api/v1/mutes
GET /api/v1/notifications/:id
Notification.
GET /api/v1/notifications
Array of notifications.
GET /api/v1/polls/:id
Poll
GET /api/v1/preferences
Preferences.
GET /api/v1/push/subscription
PushSubscription.
GET /api/v1/accounts/relationships
Get multiple relationships in one method
Array of Relationship.
GET /api/v1/scheduled_statuses/:id
ScheduledStatus.
GET /api/v1/scheduled_statuses
Array of scheduled statuses.
GET /api/v1/statuses/:id
GET /api/v1/statuses/:id/context
Get parent and child statuses.
Context
GET /api/v1/statuses/:id/favourited_by
GET /api/v1/statuses/:id/reblogged_by
GET /api/v1/featured_tags/suggestions
Array of tag.
GET /api/v1/suggestions
GET /api/v1/timelines/tag/:hashtag
POST /api/v1/accounts/:id/mute
POST /api/v1/statuses/:id/mute
POST /api/v1/accounts/:id/pin
POST /api/v1/statuses/:id/pin
POST /api/v1/statuses
POST /api/v1/conversations/:id/read
Conversation.
POST /api/v1/pleroma/notifcations/read
Array of notifications
POST /api/v1/statuses/:id/reblog
Refresh OAuth access token. Send refresh token and get new access token.
POST /api/v1/accounts
An account token.
First, call createApp to get client_id and client_secret. Next, call generateAuthUrl to get authorization url.
POST /api/v1/follow_requests/:id/reject
POST /api/v1/reports
Report
POST /oauth/revoke
Revoke an OAuth token.
POST /api/v1/markers
Marker.
PUT /api/v1/scheduled_statuses/:id
GET /api/v2/search
Results.
GET /api/v1/accounts/search
POST /api/v1/pleroma/accounts/:id/subscribe
POST /api/v1/push/subscription
POST /api/v1/accounts/:id/unblock
RElationship
DELETE /api/v1/domain_blocks
POST /api/v1/statuses/:id/unbookmark
POST /api/v1/statuses/:id/unfavourite
POST /api/v1/accounts/:id/unfollow
POST /api/v1/accounts/:id/unmute
POST /api/v1/statuses/:id/unmute
POST /api/v1/accounts/:id/unpin
POST /api/v1/statuses/:id/unpin
POST /api/v1/statuses/:id/unreblog
POST /api/v1/pleroma/accounts/:id/unsubscribe
PATCH /api/v1/accounts/update_credentials
PUT /api/v1/filters/:id
PUT /api/v1/lists/:id
PUT /api/v1/media/:id
Attachment
PUT /api/v1/push/subscription
POST /api/v1/media
- Preparing search index...
- The search index is not available
megalodonClass Mastodon
Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
baseUrl: string
hostname or base URL
accessToken: null | string = null
access token from OAuth2 authorization
-userAgent: null | string = ...
userAgent: null | string = DEFAULT_UA
UserAgent is specified in header on request.
proxyConfig: false | ProxyConfig = false
Proxy setting, or set false if don't use proxy.
-Returns Mastodon
Properties
base Url
client
Methods
accept Follow Request
Returns Mastodon
Properties
base Url
client
Methods
accept Follow Request
POST /api/v1/follow_requests/:id/authorize
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship.
-add Accounts To List
add Accounts To List
POST /api/v1/lists/:id/accounts
-Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
block Account
Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
block Account
POST /api/v1/accounts/:id/block
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-block Domain
block Domain
POST/api/v1/domain_blocks
-Parameters
domain: string
Returns Promise<Response<{}>>
bookmark Status
Parameters
domain: string
Returns Promise<Response<{}>>
bookmark Status
POST /api/v1/statuses/:id/bookmark
-Parameters
id: string
Returns Promise<Response<Status>>
Status.
-cancel
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
+cancel
Cancel all requests in this instance.
Returns void
void
-cancel Scheduled Status
cancel Scheduled Status
DELETE /api/v1/scheduled_statuses/:id
-Parameters
id: string
Returns Promise<Response<{}>>
create App
Parameters
id: string
Returns Promise<Response<{}>>
create App
Call /api/v1/apps
Create an application.
Parameters
client_name: string
your application's name
options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>
Form Data
-Returns Promise<AppData>
create Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Status>>
create Featured Tag
Returns Promise<AppData>
create Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Entity.Status>>
create Featured Tag
POST /api/v1/featured_tags
Parameters
name: string
Returns Promise<Response<FeaturedTag>>
FeaturedTag.
-create Filter
create Filter
POST /api/v1/filters
Parameters
phrase: string
context: string[]
Optional options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
Optional expires_ in?: string
Optional irreversible?: boolean
Optional whole_ word?: boolean
Returns Promise<Response<Filter>>
Filter
-create List
create List
POST /api/v1/lists
Parameters
title: string
Returns Promise<Response<List>>
List.
-delete Accounts From List
delete Accounts From List
DELETE /api/v1/lists/:id/accounts
-Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
delete Conversation
Parameters
id: string
account_ids: string[]
Returns Promise<Response<{}>>
delete Conversation
DELETE /api/v1/conversations/:id
-Parameters
id: string
Returns Promise<Response<{}>>
delete Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Status>>
delete Featured Tag
Parameters
id: string
Returns Promise<Response<{}>>
delete Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Entity.Status>>
delete Featured Tag
DELETE /api/v1/featured_tags/:id
Parameters
id: string
Returns Promise<Response<{}>>
Empty
-delete Filter
delete Filter
DELETE /api/v1/filters/:id
Parameters
id: string
Returns Promise<Response<Filter>>
Removed filter.
-delete List
delete List
DELETE /api/v1/lists/:id
-Parameters
id: string
Returns Promise<Response<{}>>
delete Push Subscription
Parameters
id: string
Returns Promise<Response<{}>>
delete Push Subscription
DELETE /api/v1/push/subscription
-Returns Promise<Response<{}>>
delete Status
Returns Promise<Response<{}>>
delete Status
DELETE /api/v1/statuses/:id
-Parameters
id: string
Returns Promise<Response<Status>>
Status
-direct Socket
Returns default
direct Stream
Returns StreamListenerInterface
dismiss Notification
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
+direct Socket
Returns default
direct Stream
Returns StreamListenerInterface
dismiss Notification
POST /api/v1/notifications/:id/dismiss
-Parameters
id: string
Returns Promise<Response<{}>>
dismiss Notifications
Parameters
id: string
Returns Promise<Response<{}>>
dismiss Notifications
POST /api/v1/notifications/clear
-Returns Promise<Response<{}>>
favourite Status
Returns Promise<Response<{}>>
favourite Status
POST /api/v1/statuses/:id/favourite
-Parameters
id: string
Returns Promise<Response<Status>>
Status.
-fetch Access Token
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
+fetch Access Token
POST /oauth/token
Fetch OAuth access token. Get an access token based client_id and client_secret and authorization code.
-Parameters
client_id: null | string
client_secret: string
code: string
redirect_uri: string = ...
Returns Promise<TokenData>
follow Account
Parameters
client_id: null | string
client_secret: string
code: string
redirect_uri: string = NO_REDIRECT
Returns Promise<TokenData>
follow Account
POST /api/v1/accounts/:id/follow
Parameters
id: string
Optional options: { reblog?: boolean }
Optional reblog?: boolean
Returns Promise<Response<Relationship>>
Relationship
-generate Auth Url
generate Auth Url
Generate authorization url using OAuth2.
Parameters
clientId: string
your OAuth app's client ID
@@ -79,264 +79,267 @@ Get an access token based client_id and client_secret and authorization code.your OAuth app's client Secretoptions: Partial<{ redirect_uri: string; scope: string[] }>
as property, redirect_uri and scope are available, and must be the same as when you register your app
-Returns Promise<string>
get Account
Returns Promise<string>
get Account
GET /api/v1/accounts/:id
-Parameters
id: string
Returns Promise<Response<Account>>
An account.
-get Account Favourites
Parameters
id: string
Returns Promise<Response<Entity.Account>>
An account.
+get Account Favourites
GET /api/v1/pleroma/accounts/:id/favourites
-Parameters
_id: string
Optional _options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Account Followers
Parameters
_id: string
Optional _options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Account Followers
GET /api/v1/accounts/:id/followers
-Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Account[]>>
The array of accounts.
-get Account Following
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
The array of accounts.
+get Account Following
GET /api/v1/accounts/:id/following
-Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Account[]>>
The array of accounts.
-get Account Lists
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
The array of accounts.
+get Account Lists
GET /api/v1/accounts/:id/lists
Parameters
id: string
Returns Promise<Response<List[]>>
The array of lists.
-get Account Statuses
get Account Statuses
GET /api/v1/accounts/:id/statuses
-Parameters
id: string
Optional options: { exclude_reblogs?: boolean; exclude_replies?: boolean; limit?: number; max_id?: string; only_media: boolean; pinned?: boolean; since_id?: string }
Optional exclude_ reblogs?: boolean
Optional exclude_ replies?: boolean
Optional limit?: number
Optional max_ id?: string
only_ media: boolean
Optional pinned?: boolean
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Account's statuses.
-get Accounts In List
Parameters
id: string
Optional options: { exclude_reblogs?: boolean; exclude_replies?: boolean; limit?: number; max_id?: string; only_media: boolean; pinned?: boolean; since_id?: string }
Optional exclude_ reblogs?: boolean
Optional exclude_ replies?: boolean
Optional limit?: number
Optional max_ id?: string
only_ media: boolean
Optional pinned?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Account's statuses.
+get Accounts In List
GET /api/v1/lists/:id/accounts
-Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Account[]>>
Array of accounts.
-get Blocks
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Blocks
GET /api/v1/blocks
-Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Account[]>>
Array of accounts.
-get Bookmarks
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Bookmarks
GET /api/v1/bookmarks
-Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Conversation Timeline
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Conversation Timeline
GET /api/v1/conversations
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Conversation[]>>
Array of statuses.
-get Domain Blocks
get Domain Blocks
GET /api/v1/domain_blocks
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<string[]>>
Array of domain name.
-get Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Reaction>>
get Emoji Reactions
Parameters
_id: string
Returns Promise<Response<Reaction[]>>
get Endorsements
get Emoji Reaction
Parameters
_id: string
_emoji: string
Returns Promise<Response<Reaction>>
get Emoji Reactions
Parameters
_id: string
Returns Promise<Response<Reaction[]>>
get Endorsements
GET /api/v1/endorsements
-Parameters
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Account[]>>
Array of accounts.
-get Favourites
Parameters
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Favourites
GET /api/v1/favourites
-Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Featured Tags
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Featured Tags
GET /api/v1/featured_tags
Returns Promise<Response<FeaturedTag[]>>
Array of featured tag.
-get Filter
get Filter
GET /api/v1/filters/:id
Parameters
id: string
Returns Promise<Response<Filter>>
Filter.
-get Filters
get Filters
GET /api/v1/filters
Returns Promise<Response<Filter[]>>
Array of filters.
-get Follow Requests
get Follow Requests
GET /api/v1/follow_requests
-Parameters
Optional limit: number
Returns Promise<Response<Account[]>>
Array of account.
-get Home Timeline
Parameters
Optional limit: number
Returns Promise<Response<Entity.Account[]>>
Array of account.
+get Home Timeline
GET /api/v1/timelines/home
-Parameters
Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional local?: boolean
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Identity Proof
Parameters
Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional local?: boolean
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Identity Proof
GET /api/v1/accounts/:id/identity_proofs
Parameters
id: string
Returns Promise<Response<IdentityProof[]>>
Array of IdentityProof
-get Instance
get Instance
GET /api/v1/instance
-Returns Promise<Response<Instance>>
get Instance Activity
Returns Promise<Response<Instance>>
get Instance Activity
GET /api/v1/instance/activity
-Returns Promise<Response<Activity[]>>
get Instance Custom Emojis
Returns Promise<Response<Activity[]>>
get Instance Custom Emojis
GET /api/v1/custom_emojis
Returns Promise<Response<Emoji[]>>
Array of emojis.
-get Instance Directory
get Instance Directory
GET /api/v1/directory
-Parameters
Optional options: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }
Optional limit?: number
Optional local?: boolean
Optional offset?: number
Optional order?: "active" | "new"
Returns Promise<Response<Account[]>>
Array of accounts.
-get Instance Peers
Parameters
Optional options: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }
Optional limit?: number
Optional local?: boolean
Optional offset?: number
Optional order?: "active" | "new"
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Instance Peers
GET /api/v1/instance/peers
-Returns Promise<Response<string[]>>
get Instance Trends
Returns Promise<Response<string[]>>
get Instance Trends
GET /api/v1/trends
Parameters
Optional limit: null | number
Maximum number of results to return. Defaults to 10.
-Returns Promise<Response<Tag[]>>
get List
Returns Promise<Response<Tag[]>>
get List
GET /api/v1/lists/:id
Parameters
id: string
Returns Promise<Response<List>>
List.
-get List Timeline
get List Timeline
GET /api/v1/timelines/list/:list_id
-Parameters
list_id: string
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Lists
Parameters
list_id: string
Optional options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Lists
GET /api/v1/lists
Returns Promise<Response<List[]>>
Array of lists.
-get Local Timeline
get Local Timeline
GET /api/v1/timelines/public
-Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Markers
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Markers
GET /api/v1/markers
Parameters
timeline: string[]
Returns Promise<Response<{} | Marker>>
Marker or empty object.
-get Mutes
get Mutes
GET /api/v1/mutes
-Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Account[]>>
Array of accounts.
-get Notification
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Notification
GET /api/v1/notifications/:id
Parameters
id: string
Returns Promise<Response<Notification>>
Notification.
-get Notifications
get Notifications
GET /api/v1/notifications
Parameters
Optional options: { account_id?: string; exclude_types?: string[]; limit?: number; max_id?: string; min_id?: string; since_id?: string }
Optional account_ id?: string
Optional exclude_ types?: string[]
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional since_ id?: string
Returns Promise<Response<Notification[]>>
Array of notifications.
-get Poll
get Poll
GET /api/v1/polls/:id
Parameters
id: string
Returns Promise<Response<Poll>>
Poll
-get Preferences
get Preferences
GET /api/v1/preferences
Returns Promise<Response<Preferences>>
Preferences.
-get Public Timeline
get Public Timeline
GET /api/v1/timelines/public
-Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-get Push Subscription
Parameters
Optional options: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+get Push Subscription
GET /api/v1/push/subscription
Returns Promise<Response<PushSubscription>>
PushSubscription.
-get Relationship
get Relationship
GET /api/v1/accounts/relationships
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-get Relationships
get Relationships
Get multiple relationships in one method
Parameters
ids: string[]
Returns Promise<Response<Relationship[]>>
Array of Relationship.
-get Scheduled Status
get Scheduled Status
GET /api/v1/scheduled_statuses/:id
Parameters
id: string
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
-get Scheduled Statuses
get Scheduled Statuses
GET /api/v1/scheduled_statuses
Parameters
Optional options: { limit?: null | number; max_id?: null | string; min_id?: null | string; since_id?: null | string }
Optional limit?: null | number
Optional max_ id?: null | string
Optional min_ id?: null | string
Optional since_ id?: null | string
Returns Promise<Response<ScheduledStatus[]>>
Array of scheduled statuses.
-get Status
get Status
GET /api/v1/statuses/:id
-Parameters
id: string
Returns Promise<Response<Status>>
Status
-get Status Context
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
+get Status Context
GET /api/v1/statuses/:id/context
Get parent and child statuses.
Parameters
id: string
Optional options: { limit?: number; max_id?: string; since_id?: string }
Optional limit?: number
Optional max_ id?: string
Optional since_ id?: string
Returns Promise<Response<Context>>
Context
-get Status Favourited By
get Status Favourited By
GET /api/v1/statuses/:id/favourited_by
-Parameters
id: string
Returns Promise<Response<Account[]>>
Array of accounts.
-get Status Reblogged By
Parameters
id: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Status Reblogged By
GET /api/v1/statuses/:id/reblogged_by
-Parameters
id: string
Returns Promise<Response<Account[]>>
Array of accounts.
-get Suggested Tags
Parameters
id: string
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Suggested Tags
GET /api/v1/featured_tags/suggestions
Returns Promise<Response<Tag[]>>
Array of tag.
-get Suggestions
get Suggestions
GET /api/v1/suggestions
-Parameters
Optional limit: number
Returns Promise<Response<Account[]>>
Array of accounts.
-get Tag Timeline
Parameters
Optional limit: number
Returns Promise<Response<Entity.Account[]>>
Array of accounts.
+get Tag Timeline
GET /api/v1/timelines/tag/:hashtag
-Parameters
hashtag: string
Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional local?: boolean
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Status[]>>
Array of statuses.
-list Socket
Parameters
list_id: string
Returns default
list Stream
Parameters
list_id: string
Returns StreamListenerInterface
local Socket
Returns default
local Stream
Returns StreamListenerInterface
mute Account
Parameters
hashtag: string
Optional options: { limit?: number; local?: boolean; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }
Optional limit?: number
Optional local?: boolean
Optional max_ id?: string
Optional min_ id?: string
Optional only_ media?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Status[]>>
Array of statuses.
+list Socket
Parameters
list_id: string
Returns default
list Stream
Parameters
list_id: string
Returns StreamListenerInterface
local Socket
Returns default
local Stream
Returns StreamListenerInterface
mute Account
POST /api/v1/accounts/:id/mute
Parameters
id: string
notifications: boolean = true
Returns Promise<Response<Relationship>>
Relationship
-mute Status
mute Status
POST /api/v1/statuses/:id/mute
-Parameters
id: string
Returns Promise<Response<Status>>
Status
-pin Account
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
+pin Account
POST /api/v1/accounts/:id/pin
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-pin Status
pin Status
POST /api/v1/statuses/:id/pin
-Parameters
id: string
Returns Promise<Response<Status>>
Status
-post Status
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
+post Status
POST /api/v1/statuses
-Parameters
status: string
options: { in_reply_to_id?: string; language?: string; media_ids?: string[]; poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }; quote_id?: string; scheduled_at?: string; sensitive?: boolean; spoiler_text?: string; visibility?: "public" | "unlisted" | "private" | "direct" }
Optional in_ reply_ to_ id?: string
Optional language?: string
Optional media_ ids?: string[]
Optional poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }
expires_ in: number
Optional hide_ totals?: boolean
Optional multiple?: boolean
options: string[]
Optional quote_ id?: string
Optional scheduled_ at?: string
Optional sensitive?: boolean
Optional spoiler_ text?: string
Optional visibility?: "public" | "unlisted" | "private" | "direct"
Returns Promise<Response<Status>>
Status
-public Socket
Returns default
public Stream
Returns StreamListenerInterface
read Conversation
Parameters
status: string
options: { in_reply_to_id?: string; language?: string; media_ids?: string[]; poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }; quote_id?: string; scheduled_at?: string; sensitive?: boolean; spoiler_text?: string; visibility?: "public" | "unlisted" | "private" | "direct" }
Optional in_ reply_ to_ id?: string
Optional language?: string
Optional media_ ids?: string[]
Optional poll?: { expires_in: number; hide_totals?: boolean; multiple?: boolean; options: string[] }
expires_ in: number
Optional hide_ totals?: boolean
Optional multiple?: boolean
options: string[]
Optional quote_ id?: string
Optional scheduled_ at?: string
Optional sensitive?: boolean
Optional spoiler_ text?: string
Optional visibility?: "public" | "unlisted" | "private" | "direct"
Returns Promise<Response<Entity.Status>>
Status
+public Socket
Returns default
public Stream
Returns StreamListenerInterface
read Conversation
POST /api/v1/conversations/:id/read
Parameters
id: string
Returns Promise<Response<Conversation>>
Conversation.
-reblog Status
read Notifications
POST /api/v1/pleroma/notifcations/read
+Parameters
_options: { id?: string; max_id?: string }
Optional id?: string
Optional max_ id?: string
Returns Promise<Response<Notification | Notification[]>>
Array of notifications
+reblog Status
POST /api/v1/statuses/:id/reblog
-Parameters
id: string
Returns Promise<Response<Status>>
Status.
-refresh Token
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
+refresh Token
POST /oauth/token
Refresh OAuth access token. Send refresh token and get new access token.
-Parameters
client_id: string
client_secret: string
refresh_token: string
Returns Promise<TokenData>
register Account
Parameters
client_id: string
client_secret: string
refresh_token: string
Returns Promise<TokenData>
register Account
POST /api/v1/accounts
Parameters
username: string
email: string
password: string
agreement: boolean
locale: string
Optional reason: null | string
Returns Promise<Response<Token>>
An account token.
-register App
register App
First, call createApp to get client_id and client_secret. Next, call generateAuthUrl to get authorization url.
-Parameters
client_name: string
options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>
Returns Promise<AppData>
reject Follow Request
Parameters
client_name: string
options: Partial<{ redirect_uris: string; scopes: string[]; website: string }>
Returns Promise<AppData>
reject Follow Request
POST /api/v1/follow_requests/:id/reject
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship.
-report
report
POST /api/v1/reports
Parameters
account_id: string
comment: string
Optional options: { forward?: boolean; status_ids?: string[] }
Optional forward?: boolean
Optional status_ ids?: string[]
Returns Promise<Response<Report>>
Report
-revoke Token
revoke Token
POST /oauth/revoke
Revoke an OAuth token.
-Parameters
client_id: string
client_secret: string
token: string
Returns Promise<Response<{}>>
save Markers
Parameters
client_id: string
client_secret: string
token: string
Returns Promise<Response<{}>>
save Markers
POST /api/v1/markers
Parameters
Optional options: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }
Optional home?: { last_read_id: string }
last_ read_ id: string
Optional notifications?: { last_read_id: string }
last_ read_ id: string
Returns Promise<Response<Marker>>
Marker.
-schedule Status
schedule Status
PUT /api/v1/scheduled_statuses/:id
Parameters
id: string
Optional scheduled_at: null | string
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
-search
search
GET /api/v2/search
Parameters
q: string
type: "accounts" | "hashtags" | "statuses"
Optional options: { account_id?: string; exclude_unreviewed?: boolean; following?: boolean; limit?: number; max_id?: string; min_id?: string; offset?: number; resolve?: boolean }
Optional account_ id?: string
Optional exclude_ unreviewed?: boolean
Optional following?: boolean
Optional limit?: number
Optional max_ id?: string
Optional min_ id?: string
Optional offset?: number
Optional resolve?: boolean
Returns Promise<Response<Results>>
Results.
-search Account
search Account
GET /api/v1/accounts/search
-Parameters
q: string
Optional options: { following?: boolean; limit?: number; max_id?: string; resolve?: boolean; since_id?: string }
Optional following?: boolean
Optional limit?: number
Optional max_ id?: string
Optional resolve?: boolean
Optional since_ id?: string
Returns Promise<Response<Account[]>>
The array of accounts.
-subscribe Account
Parameters
q: string
Optional options: { following?: boolean; limit?: number; max_id?: string; resolve?: boolean; since_id?: string }
Optional following?: boolean
Optional limit?: number
Optional max_ id?: string
Optional resolve?: boolean
Optional since_ id?: string
Returns Promise<Response<Entity.Account[]>>
The array of accounts.
+subscribe Account
POST /api/v1/pleroma/accounts/:id/subscribe
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship.
-subscribe Push Notification
subscribe Push Notification
POST /api/v1/push/subscription
Parameters
subscription: { endpoint: string; keys: { auth: string; p256dh: string } }
endpoint: string
keys: { auth: string; p256dh: string }
auth: string
p256dh: string
Optional data: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }
Returns Promise<Response<PushSubscription>>
PushSubscription.
-tag Socket
Parameters
tag: string
Returns default
tag Stream
Parameters
tag: string
Returns StreamListenerInterface
unblock Account
tag Socket
Parameters
tag: string
Returns default
tag Stream
Parameters
tag: string
Returns StreamListenerInterface
unblock Account
POST /api/v1/accounts/:id/unblock
Parameters
id: string
Returns Promise<Response<Relationship>>
RElationship
-unblock Domain
unblock Domain
DELETE /api/v1/domain_blocks
-Parameters
domain: string
Returns Promise<Response<{}>>
unbookmark Status
Parameters
domain: string
Returns Promise<Response<{}>>
unbookmark Status
POST /api/v1/statuses/:id/unbookmark
-Parameters
id: string
Returns Promise<Response<Status>>
Status.
-unfavourite Status
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
+unfavourite Status
POST /api/v1/statuses/:id/unfavourite
-Parameters
id: string
Returns Promise<Response<Status>>
Status.
-unfollow Account
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
+unfollow Account
POST /api/v1/accounts/:id/unfollow
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-unmute Account
unmute Account
POST /api/v1/accounts/:id/unmute
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-unmute Status
unmute Status
POST /api/v1/statuses/:id/unmute
-Parameters
id: string
Returns Promise<Response<Status>>
Status
-unpin Account
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
+unpin Account
POST /api/v1/accounts/:id/unpin
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship
-unpin Status
unpin Status
POST /api/v1/statuses/:id/unpin
-Parameters
id: string
Returns Promise<Response<Status>>
Status
-unreblog Status
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status
+unreblog Status
POST /api/v1/statuses/:id/unreblog
-Parameters
id: string
Returns Promise<Response<Status>>
Status.
-unsubscribe Account
Parameters
id: string
Returns Promise<Response<Entity.Status>>
Status.
+unsubscribe Account
POST /api/v1/pleroma/accounts/:id/unsubscribe
Parameters
id: string
Returns Promise<Response<Relationship>>
Relationship.
-update Credentials
update Credentials
PATCH /api/v1/accounts/update_credentials
-Parameters
Optional options: { avatar?: string; bot?: boolean; discoverable?: boolean; display_name?: string; fields_attributes?: { name: string; value: string }[]; header?: string; locked?: boolean; note?: string; source?: { language?: string; privacy?: string; sensitive?: boolean } }
Optional avatar?: string
Optional bot?: boolean
Optional discoverable?: boolean
Optional display_ name?: string
Optional fields_ attributes?: { name: string; value: string }[]
Optional header?: string
Optional locked?: boolean
Optional note?: string
Optional source?: { language?: string; privacy?: string; sensitive?: boolean }
Optional language?: string
Optional privacy?: string
Optional sensitive?: boolean
Returns Promise<Response<Account>>
An account.
-update Filter
Parameters
Optional options: { avatar?: string; bot?: boolean; discoverable?: boolean; display_name?: string; fields_attributes?: { name: string; value: string }[]; header?: string; locked?: boolean; note?: string; source?: { language?: string; privacy?: string; sensitive?: boolean } }
Optional avatar?: string
Optional bot?: boolean
Optional discoverable?: boolean
Optional display_ name?: string
Optional fields_ attributes?: { name: string; value: string }[]
Optional header?: string
Optional locked?: boolean
Optional note?: string
Optional source?: { language?: string; privacy?: string; sensitive?: boolean }
Optional language?: string
Optional privacy?: string
Optional sensitive?: boolean
Returns Promise<Response<Entity.Account>>
An account.
+update Filter
PUT /api/v1/filters/:id
Parameters
id: string
phrase: string
context: string[]
Optional options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
Optional expires_ in?: string
Optional irreversible?: boolean
Optional whole_ word?: boolean
Returns Promise<Response<Filter>>
Filter
-update List
update List
PUT /api/v1/lists/:id
Parameters
id: string
title: string
Returns Promise<Response<List>>
List.
-update Media
update Media
PUT /api/v1/media/:id
Parameters
id: string
Optional options: { description?: string; file?: any; focus?: string }
Optional description?: string
Optional file?: any
Optional focus?: string
Returns Promise<Response<Attachment>>
Attachment
-update Push Subscription
update Push Subscription
PUT /api/v1/push/subscription
Parameters
Optional data: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }
Returns Promise<Response<PushSubscription>>
PushSubscription.
-upload Media
upload Media
POST /api/v1/media
Parameters
file: any
Optional options: { description?: string; focus?: string }