From e91fb94617d4ca9c58a021d7c4a51d766a1d7b52 Mon Sep 17 00:00:00 2001 From: AkiraFukushima
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
+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.
+DELETE /api/v1/lists/:id/accounts
+DELETE /api/v1/conversations/:id
+DELETE /api/v1/featured_tags/:id
+Empty
+DELETE /api/v1/lists/:id
+DELETE /api/v1/push/subscription
+POST /api/v1/notifications/:id/dismiss
+POST /api/v1/notifications/clear
+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
+Relationship
+Generate authorization url using OAuth2.
+your OAuth app's client ID
+your OAuth app's client Secret
+as property, redirect_uri and scope are available, and must be the same as when you register your app
+GET /api/v1/accounts/:id/statuses
+Account's statuses.
+GET /api/v1/conversations
+Array of statuses.
+GET /api/v1/domain_blocks
+Array of domain name.
+GET /api/v1/featured_tags
+Array of featured tag.
+GET /api/v1/timelines/home
+Array of statuses.
+GET /api/v1/accounts/:id/identity_proofs
+Array of IdentityProof
+GET /api/v1/instance/peers
+GET /api/v1/timelines/list/:list_id
+Array of statuses.
+GET /api/v1/timelines/public
+Array of statuses.
+GET /api/v1/notifications/:id
+Notification.
+GET /api/v1/notifications
+Array of notifications.
+GET /api/v1/preferences
+Preferences.
+GET /api/v1/timelines/public
+Array of statuses.
+GET /api/v1/push/subscription
+PushSubscription.
+GET /api/v1/accounts/relationships
+Relationship
+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/timelines/tag/:hashtag
+Array of statuses.
+POST /api/v1/accounts/:id/mute
+Relationship
+POST /api/v1/accounts/:id/pin
+Relationship
+POST /api/v1/statuses
+Status
+POST /api/v1/conversations/:id/read
+Conversation.
+POST /oauth/token
+Refresh OAuth access token. +Send refresh token and get new access 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
+Relationship.
+POST /oauth/revoke
+Revoke an OAuth token.
+PUT /api/v1/scheduled_statuses/:id
+ScheduledStatus.
+GET /api/v2/search
+Results.
+GET /api/v1/accounts/search
+The array of accounts.
+POST /api/v1/pleroma/accounts/:id/subscribe
+Relationship.
+POST /api/v1/push/subscription
+PushSubscription.
+POST /api/v1/accounts/:id/unblock
+RElationship
+DELETE /api/v1/domain_blocks
+POST /api/v1/accounts/:id/unfollow
+Relationship
+POST /api/v1/accounts/:id/unmute
+Relationship
+POST /api/v1/accounts/:id/unpin
+Relationship
+POST /api/v1/pleroma/accounts/:id/unsubscribe
+Relationship.
+PATCH /api/v1/accounts/update_credentials
+An account.
+PUT /api/v1/media/:id
+Attachment
+PUT /api/v1/push/subscription
+PushSubscription.
+POST /api/v1/media
+Attachment
+GET /api/v1/apps/verify_credentials
+An Application
+Generated using TypeDoc
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/following/requests/accept
+POST /api/users/lists/push
+POST /api/blocking/create
+POST/api/v1/domain_blocks
+Cancel all requests in this instance.
+void
+DELETE /api/v1/scheduled_statuses/:id
+POST /api/app/create
+Create an application.
+Your application's name.
+Form data.
+POST /api/v1/featured_tags
+FeaturedTag.
+POST /api/users/lists/pull
+DELETE /api/v1/conversations/:id
+DELETE /api/v1/featured_tags/:id
+Empty
+POST /api/users/lists/delete
+DELETE /api/v1/push/subscription
+POST /api/notes/delete
+POST /api/v1/notifications/:id/dismiss
+POST /api/notifications/mark-all-as-read
+POST /api/auth/session/userkey
+This parameter is not used in this method.
+Application secret key which will be provided in createApp.
+Session token string which will be provided in generateAuthUrlAndToken.
+This parameter is not used in this method.
+POST /api/following/create
+POST /api/auth/session/generate
+POST /api/users/notes
+POST /api/notes/mentions
+GET /api/v1/domain_blocks
+Array of domain name.
+GET /api/v1/featured_tags
+Array of featured tag.
+GET /api/v1/accounts/:id/identity_proofs
+Array of IdentityProof
+GET /api/v1/instance/peers
+POST /api/notes/local-timeline
+GET /api/v1/notifications/:id
+Notification.
+POST /api/i/notifications
+GET /api/v1/preferences
+Preferences.
+POST /api/notes/global-timeline
+GET /api/v1/push/subscription
+PushSubscription.
+POST /api/users/relation
+The accountID, for example '1sdfag'
POST /api/users/relation
+GET /api/v1/scheduled_statuses/:id
+ScheduledStatus.
+GET /api/v1/scheduled_statuses
+Array of scheduled statuses.
+POST /api/notes/search-by-tag
+POST /api/mute/create
+POST /api/v1/accounts/:id/pin
+Relationship
+POST /api/v1/statuses
+Status
+POST /api/v1/conversations/:id/read
+Conversation.
+POST /oauth/token
+Refresh OAuth access token. +Send refresh token and get new access token.
+First, call createApp to get client_id and client_secret. +Next, call generateAuthUrl to get authorization url.
+POST /api/following/requests/reject
+POST /oauth/revoke
+Revoke an OAuth token.
+POST /api/v1/markers
+Marker.
+PUT /api/v1/scheduled_statuses/:id
+ScheduledStatus.
+GET /api/v2/search
+Results.
+POST /api/users/search
+POST /api/v1/pleroma/accounts/:id/subscribe
+Relationship.
+POST /api/v1/push/subscription
+PushSubscription.
+POST /api/blocking/delete
+DELETE /api/v1/domain_blocks
+POST /api/following/delete
+POST /api/mute/delete
+POST /api/v1/accounts/:id/unpin
+Relationship
+POST /api/v1/pleroma/accounts/:id/unsubscribe
+Relationship.
+POST /api/i/update
+POST /api/drive/files/update
+PUT /api/v1/push/subscription
+PushSubscription.
+POST /api/drive/files/create
+GET /api/v1/apps/verify_credentials
+An Application
+Generated using TypeDoc
Serialize raw application data from server
+from server
+Generated using TypeDoc
OAuth Aceess Token
+Application ID
+OAuth Refresh Token
+Serialize raw token data from server
+from server
+Generated using TypeDoc
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
+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.
+DELETE /api/v1/lists/:id/accounts
+DELETE /api/v1/conversations/:id
+DELETE /api/v1/featured_tags/:id
+Empty
+DELETE /api/v1/lists/:id
+DELETE /api/v1/push/subscription
+POST /api/v1/notifications/:id/dismiss
+POST /api/v1/notifications/clear
+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
+Relationship
+Generate authorization url using OAuth2.
+your OAuth app's client ID
+your OAuth app's client Secret
+as property, redirect_uri and scope are available, and must be the same as when you register your app
+GET /api/v1/accounts/:id/statuses
+Account's statuses.
+GET /api/v1/conversations
+Array of statuses.
+GET /api/v1/domain_blocks
+Array of domain name.
+GET /api/v1/featured_tags
+Array of featured tag.
+GET /api/v1/timelines/home
+Array of statuses.
+GET /api/v1/accounts/:id/identity_proofs
+Array of IdentityProof
+GET /api/v1/instance/peers
+GET /api/v1/timelines/list/:list_id
+Array of statuses.
+GET /api/v1/timelines/public
+Array of statuses.
+GET /api/v1/notifications/:id
+Notification.
+GET /api/v1/notifications
+Array of notifications.
+GET /api/v1/preferences
+Preferences.
+GET /api/v1/timelines/public
+Array of statuses.
+GET /api/v1/push/subscription
+PushSubscription.
+GET /api/v1/accounts/relationships
+Relationship
+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/timelines/tag/:hashtag
+Array of statuses.
+POST /api/v1/accounts/:id/mute
+Relationship
+POST /api/v1/accounts/:id/pin
+Relationship
+POST /api/v1/statuses
+Status
+POST /api/v1/conversations/:id/read
+Conversation.
+POST /oauth/token
+Refresh OAuth access token. +Send refresh token and get new access 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
+Relationship.
+POST /oauth/revoke
+Revoke an OAuth token.
+PUT /api/v1/scheduled_statuses/:id
+ScheduledStatus.
+GET /api/v2/search
+Results.
+GET /api/v1/accounts/search
+The array of accounts.
+POST /api/v1/pleroma/accounts/:id/subscribe
+Relationship.
+POST /api/v1/push/subscription
+PushSubscription.
+POST /api/v1/accounts/:id/unblock
+RElationship
+DELETE /api/v1/domain_blocks
+POST /api/v1/accounts/:id/unfollow
+Relationship
+POST /api/v1/accounts/:id/unmute
+Relationship
+POST /api/v1/accounts/:id/unpin
+Relationship
+POST /api/v1/pleroma/accounts/:id/unsubscribe
+Relationship.
+PATCH /api/v1/accounts/update_credentials
+An account.
+PUT /api/v1/media/:id
+Attachment
+PUT /api/v1/push/subscription
+PushSubscription.
+POST /api/v1/media
+Attachment
+GET /api/v1/apps/verify_credentials
+An Application
+Generated using TypeDoc
Create .stack property on a target object
+Optional override for formatting stack traces
+Generated using TypeDoc
Optional override for formatting stack traces
-Create .stack property on a target object
-Generated using TypeDoc
-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
-POST /api/v1/lists/:id/accounts
-POST /api/v1/accounts/:id/block
-POST/api/v1/domain_blocks
-Cancel all requests in this instance.
-DELETE /api/v1/scheduled_statuses/:id
-Call /api/v1/apps
-Create an application.
-your application's name
-Form Data
-POST /api/v1/featured_tags
-POST /api/v1/filters
-DELETE /api/v1/lists/:id/accounts
-DELETE /api/v1/conversations/:id
-DELETE /api/v1/featured_tags/:id
-DELETE /api/v1/lists/:id
-DELETE /api/v1/push/subscription
-POST /api/v1/notifications/:id/dismiss
-POST /api/v1/notifications/clear
-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
-your OAuth app's client Secret
-as property, redirect_uri and scope are available, and must be the same as when you register your app
-GET /api/v1/pleroma/accounts/:id/favourites
-GET /api/v1/accounts/:id/followers
-GET /api/v1/accounts/:id/following
-GET /api/v1/accounts/:id/statuses
-GET /api/v1/bookmarks
-GET /api/v1/conversations
-GET /api/v1/domain_blocks
-GET /api/v1/featured_tags
-GET /api/v1/timelines/home
-GET /api/v1/accounts/:id/identity_proofs
-GET /api/v1/directory
-GET /api/v1/instance/peers
-GET /api/v1/timelines/list/:list_id
-GET /api/v1/timelines/public
-GET /api/v1/notifications/:id
-GET /api/v1/notifications
-GET /api/v1/preferences
-GET /api/v1/timelines/public
-GET /api/v1/push/subscription
-GET /api/v1/accounts/relationships
-Get multiple relationships in one method
-GET /api/v1/scheduled_statuses/:id
-GET /api/v1/scheduled_statuses
-GET /api/v1/statuses/:id/context
-Get parent and child statuses.
-GET /api/v1/timelines/tag/:hashtag
-POST /api/v1/accounts/:id/mute
-POST /api/v1/accounts/:id/pin
-POST /api/v1/statuses
-POST /api/v1/conversations/:id/read
-POST /oauth/token
-Refresh OAuth access token. - Send refresh token and get new access 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 /oauth/revoke
-Revoke an OAuth token.
-POST /api/v1/markers
-PUT /api/v1/scheduled_statuses/:id
-GET /api/v2/search
-GET /api/v1/accounts/search
-POST /api/v1/pleroma/accounts/:id/subscribe
-POST /api/v1/push/subscription
-POST /api/v1/accounts/:id/unblock
-DELETE /api/v1/domain_blocks
-POST /api/v1/accounts/:id/unfollow
-POST /api/v1/accounts/:id/unmute
-POST /api/v1/accounts/:id/unpin
-POST /api/v1/pleroma/accounts/:id/unsubscribe
-PATCH /api/v1/accounts/update_credentials
-PUT /api/v1/filters/:id
-PUT /api/v1/media/:id
-PUT /api/v1/push/subscription
-POST /api/v1/media
-GET /api/v1/apps/verify_credentials
-Generated using TypeDoc
-Mastodon API client.
-Using axios for request, you will handle promises.
-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.
-Cancel all requests in this instance.
-void
-DELETE request to mastodon REST API.
-relative path from baseUrl
-Form data
-Request header object
-GET request to mastodon REST API.
-relative path from baseUrl
-Query parameters
-Request header object
-PATCH request to mastodon REST API.
-relative path from baseUrl
-Form data. If you want to post file, please use FormData()
-Request header object
-POST request to mastodon REST API.
-relative path from baseUrl
-Form data
-Request header object
-PUT request to mastodon REST API.
-relative path from baseUrl
-Form data. If you want to post file, please use FormData()
-Request header object
-Get connection and receive websocket connection for Pleroma API.
-relative path from baseUrl: normally it is /streaming
.
Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28
-WebSocket, which inherits from EventEmitter
-Receive Server-sent Events from Mastodon Streaming API. - Create streaming connection, and start streamin.
-relative path from baseUrl
-interval of reconnect
-streamListener, which inherits from EventEmitter
-Generated using TypeDoc
-EventStream - Listener of text/event-stream. It receives data, and parse when streaming.
-Full url of streaming: e.g. https://mastodon.social/api/v1/streaming/user
-headers object of streaming request
-Proxy setting, or set false if don't use proxy
-reconnection interval[ms] when the connection is unexpectedly closed
-Request the url and get response, and start streaming.
-Reconnects to the same endpoint.
-Resets connection and remove listeners.
-Resets parameters.
-Set up parser when receive some data.
-Start streaming connection.
-Stop the connection.
-Generated using TypeDoc
-Optional override for formatting stack traces
-Create .stack property on a target object
-Generated using TypeDoc
-WebSocket - Pleroma is not support streaming. It is support websocket instead of streaming. - So this class connect to Phoenix websocket for Pleroma.
-Full url of websocket: e.g. https://pleroma.io/api/v1/streaming
-Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28
-The access token.
-The specified User Agent.
-Proxy setting, or set false if don't use proxy.
-Bind event for web socket client.
-A WebSocket instance.
-Call ping and wait to pong.
-Clear binding event for web socket client.
-Base url of streaming endpoint.
-The specified stream name.
-Access token.
-The specified headers.
-Proxy setting, or set false if don't use proxy.
-A WebSocket instance.
-Reconnects to the same endpoint.
-Clean up current connection, and listeners.
-Resets the parameters used in reconnect.
-Set up parser when receive message.
-Reset connection and start new websocket connection.
-Start websocket connection.
-Stop current connection.
-Generated using TypeDoc
-Parser - This class provides parser for websocket message.
-Message body of websocket.
-Generated using TypeDoc
-Optional override for formatting stack traces
-Create .stack property on a target object
-Generated using TypeDoc
-Optional override for formatting stack traces
-Create .stack property on a target object
-Generated using TypeDoc
-Optional override for formatting stack traces
-Create .stack property on a target object
-Generated using TypeDoc
-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/following/requests/accept
-POST /api/users/lists/push
-POST /api/blocking/create
-POST/api/v1/domain_blocks
-Cancel all requests in this instance.
-void
-DELETE /api/v1/scheduled_statuses/:id
-POST /api/app/create
-Create an application.
-Your application's name.
-Form data.
-POST /api/v1/featured_tags
-FeaturedTag.
-POST /api/v1/filters
-Filter
-POST /api/users/lists/pull
-DELETE /api/v1/conversations/:id
-DELETE /api/v1/featured_tags/:id
-Empty
-POST /api/users/lists/delete
-DELETE /api/v1/push/subscription
-POST /api/notes/delete
-POST /api/v1/notifications/:id/dismiss
-POST /api/notifications/mark-all-as-read
-POST /api/auth/session/userkey
-This parameter is not used in this method.
-Application secret key which will be provided in createApp.
-Session token string which will be provided in generateAuthUrlAndToken.
-This parameter is not used in this method.
-POST /api/following/create
-POST /api/auth/session/generate
-GET /api/v1/pleroma/accounts/:id/favourites
-Array of statuses.
-POST /api/users/notes
-GET /api/v1/bookmarks
-Array of statuses.
-POST /api/notes/mentions
-GET /api/v1/domain_blocks
-Array of domain name.
-GET /api/v1/featured_tags
-Array of featured tag.
-POST /api/notes/timeline
-GET /api/v1/accounts/:id/identity_proofs
-Array of IdentityProof
-GET /api/v1/directory
-Array of accounts.
-GET /api/v1/instance/peers
-POST /api/notes/user-list-timeline
-POST /api/notes/local-timeline
-GET /api/v1/notifications/:id
-Notification.
-POST /api/i/notifications
-GET /api/v1/preferences
-Preferences.
-POST /api/notes/global-timeline
-GET /api/v1/push/subscription
-PushSubscription.
-POST /api/users/relation
-The accountID, for example '1sdfag'
POST /api/users/relation
-GET /api/v1/scheduled_statuses/:id
-ScheduledStatus.
-GET /api/v1/scheduled_statuses
-Array of scheduled statuses.
-POST /api/notes/search-by-tag
-POST /api/mute/create
-POST /api/v1/accounts/:id/pin
-Relationship
-POST /api/v1/statuses
-Status
-POST /api/v1/conversations/:id/read
-Conversation.
-POST /oauth/token
-Refresh OAuth access token. - Send refresh token and get new access token.
-First, call createApp to get client_id and client_secret. - Next, call generateAuthUrl to get authorization url.
-POST /api/following/requests/reject
-POST /oauth/revoke
-Revoke an OAuth token.
-POST /api/v1/markers
-Marker.
-PUT /api/v1/scheduled_statuses/:id
-ScheduledStatus.
-GET /api/v2/search
-Results.
-POST /api/users/search
-POST /api/v1/pleroma/accounts/:id/subscribe
-Relationship.
-POST /api/v1/push/subscription
-PushSubscription.
-POST /api/blocking/delete
-DELETE /api/v1/domain_blocks
-POST /api/following/delete
-POST /api/mute/delete
-POST /api/v1/accounts/:id/unpin
-Relationship
-POST /api/v1/pleroma/accounts/:id/unsubscribe
-Relationship.
-POST /api/i/update
-PUT /api/v1/filters/:id
-Filter
-POST /api/drive/files/update
-PUT /api/v1/push/subscription
-PushSubscription.
-POST /api/drive/files/create
-GET /api/v1/apps/verify_credentials
-An Application
-Generated using TypeDoc
-Misskey API client.
-Usign axios for request, you will handle promises.
-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.
-Cancel all requests in this instance.
-void
-POST request to mastodon REST API.
-relative path from baseUrl
-Form data
-Request header object
-Get connection and receive websocket connection for Misskey API.
-Channel name is user, localTimeline, hybridTimeline, globalTimeline, conversation or list.
-This parameter is required only list channel.
-Generated using TypeDoc
-WebSocket - Misskey is not support http streaming. It supports websocket instead of streaming. - So this class connect to Misskey server with WebSocket.
-Full url of websocket: e.g. wss://misskey.io/streaming
-Channel name is user, localTimeline, hybridTimeline, globalTimeline, conversation or list.
-The access token.
-This parameter is required when you specify list as channel.
-Bind event for web socket client.
-A WebSocket instance.
-Connect specified channels in websocket.
-Call ping and wait to pong.
-Clear binding event for websocket client.
-Connect to the endpoint.
-Reconnects to the same endpoint.
-Clean up current connection, and listeners.
-Resets the parameters used in reconnect.
-Set up parser when receive message.
-Reset connection and start new websocket connection.
-Start websocket connection.
-Stop current connection.
-Generated using TypeDoc
-Parser - This class provides parser for websocket message.
-Message body of websocket.
-Parse only messages which has same channelID.
-Generated using TypeDoc
-Serialize raw application data from server
-from server
-Generated using TypeDoc
-OAuth Aceess Token
-Application ID
-OAuth Refresh Token
-Serialize raw token data from server
-from server
-Generated using TypeDoc
-Parser - Parse response data in streaming.
-Generated using TypeDoc
-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
-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
-DELETE /api/v1/lists/:id/accounts
-DELETE /api/v1/conversations/:id
-DELETE /api/v1/featured_tags/:id
-Empty
-DELETE /api/v1/lists/:id
-DELETE /api/v1/push/subscription
-POST /api/v1/notifications/:id/dismiss
-POST /api/v1/notifications/clear
-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
-Relationship
-Generate authorization url using OAuth2.
-your OAuth app's client ID
-your OAuth app's client Secret
-as property, redirect_uri and scope are available, and must be the same as when you register your app
-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
-The array of accounts.
-GET /api/v1/accounts/:id/statuses
-Account's statuses.
-GET /api/v1/lists/:id/accounts
-Array of accounts.
-GET /api/v1/bookmarks
-Array of statuses.
-GET /api/v1/conversations
-Array of statuses.
-GET /api/v1/domain_blocks
-Array of domain name.
-GET /api/v1/featured_tags
-Array of featured tag.
-GET /api/v1/timelines/home
-Array of statuses.
-GET /api/v1/accounts/:id/identity_proofs
-Array of IdentityProof
-GET /api/v1/directory
-Array of accounts.
-GET /api/v1/instance/peers
-GET /api/v1/timelines/list/:list_id
-Array of statuses.
-GET /api/v1/timelines/public
-Array of statuses.
-GET /api/v1/notifications/:id
-Notification.
-GET /api/v1/notifications
-Array of notifications.
-GET /api/v1/preferences
-Preferences.
-GET /api/v1/timelines/public
-Array of statuses.
-GET /api/v1/push/subscription
-PushSubscription.
-GET /api/v1/accounts/relationships
-Relationship
-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/context
-Get parent and child statuses.
-Context
-GET /api/v1/timelines/tag/:hashtag
-Array of statuses.
-POST /api/v1/accounts/:id/mute
-Relationship
-POST /api/v1/accounts/:id/pin
-Relationship
-POST /api/v1/statuses
-Status
-POST /api/v1/conversations/:id/read
-Conversation.
-POST /oauth/token
-Refresh OAuth access token. - Send refresh token and get new access 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
-Relationship.
-POST /oauth/revoke
-Revoke an OAuth token.
-POST /api/v1/markers
-Marker.
-PUT /api/v1/scheduled_statuses/:id
-ScheduledStatus.
-GET /api/v2/search
-Results.
-GET /api/v1/accounts/search
-The array of accounts.
-POST /api/v1/pleroma/accounts/:id/subscribe
-Relationship.
-POST /api/v1/push/subscription
-PushSubscription.
-POST /api/v1/accounts/:id/unblock
-RElationship
-DELETE /api/v1/domain_blocks
-POST /api/v1/accounts/:id/unfollow
-Relationship
-POST /api/v1/accounts/:id/unmute
-Relationship
-POST /api/v1/accounts/:id/unpin
-Relationship
-POST /api/v1/pleroma/accounts/:id/unsubscribe
-Relationship.
-PATCH /api/v1/accounts/update_credentials
-An account.
-PUT /api/v1/filters/:id
-Filter
-PUT /api/v1/media/:id
-Attachment
-PUT /api/v1/push/subscription
-PushSubscription.
-POST /api/v1/media
-Attachment
-GET /api/v1/apps/verify_credentials
-An Application
-Generated using TypeDoc
-Mastodon API client.
-Using axios for request, you will handle promises.
-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.
-Cancel all requests in this instance.
-void
-DELETE request to mastodon REST API.
-relative path from baseUrl
-Form data
-Request header object
-GET request to mastodon REST API.
-relative path from baseUrl
-Query parameters
-Request header object
-PATCH request to mastodon REST API.
-relative path from baseUrl
-Form data. If you want to post file, please use FormData()
-Request header object
-POST request to mastodon REST API.
-relative path from baseUrl
-Form data
-Request header object
-PUT request to mastodon REST API.
-relative path from baseUrl
-Form data. If you want to post file, please use FormData()
-Request header object
-Get connection and receive websocket connection for Pleroma API.
-relative path from baseUrl: normally it is /streaming
.
Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28
-WebSocket, which inherits from EventEmitter
-Generated using TypeDoc
-WebSocket - Pleroma is not support streaming. It is support websocket instead of streaming. - So this class connect to Phoenix websocket for Pleroma.
-Full url of websocket: e.g. https://pleroma.io/api/v1/streaming
-Stream name, please refer: https://git.pleroma.social/pleroma/pleroma/blob/develop/lib/pleroma/web/mastodon_api/mastodon_socket.ex#L19-28
-The access token.
-The specified User Agent.
-Proxy setting, or set false if don't use proxy.
-Bind event for web socket client.
-A WebSocket instance.
-Call ping and wait to pong.
-Clear binding event for web socket client.
-Base url of streaming endpoint.
-The specified stream name.
-Access token.
-The specified headers.
-Proxy setting, or set false if don't use proxy.
-A WebSocket instance.
-Reconnects to the same endpoint.
-Clean up current connection, and listeners.
-Resets the parameters used in reconnect.
-Set up parser when receive message.
-Reset connection and start new websocket connection.
-Start websocket connection.
-Stop current connection.
-Generated using TypeDoc
-Parser - This class provides parser for websocket message.
-Message body of websocket.
-Generated using TypeDoc
-A Mastodon, Pleroma and Misskey API Client library for node.js and browser. It provides REST API and streaming methods. - By using this library, you can take Mastodon, Pleroma and Misskey with the same interface.
- -There are some breaking changes, so you can not update megalodon out of the box. - Please refer migration guide before you update megalodon version.
- -$ npm install -S megalodon
+megalodon megalodon
+
+ Megalodon
+
+
+A Mastodon, Pleroma and Misskey API Client library for node.js and browser. It provides REST API and streaming methods.
+By using this library, you can take Mastodon, Pleroma and Misskey with the same interface.
+
+
+ !!Migrate v2.x to v3.0.0
+
+There are some breaking changes, so you can not update megalodon out of the box.
+Please refer migration guide before you update megalodon version.
+
+
+ Features
+
+
+- REST API
+- Streaming with Server-Sent Event
+- Streaming with WebSocket
+- Promisified methods
+- Proxy support
+- Support node.js and browser
+- Written in typescript
+
+
+
+ Install
+
+$ npm install -S megalodon
- or
- $ yarn add megalodon
+or
+$ yarn add megalodon
-
- Build for browser
-
- Important: In browser, you can not use proxy.
- If you want to build for browser, please use Webpack and set empty value for these libraries.
-
- - net
- - tls
- - dns
-
- node: {
- net: 'empty',
- tls: 'empty',
- dns: 'empty'
- }
+
+
+ Build for browser
+
+Important: In browser, you can not use proxy.
+If you want to build for browser, please use Webpack and set empty value for these libraries.
+
+- net
+- tls
+- dns
+
+ node: {
net: 'empty',
tls: 'empty',
dns: 'empty'
}
- These libraries are for node.js, so can not use in browser.
- Here is example Webpack configuration.
-
- Usage
-
- I prepared examples, and please refer documents about each methods.
- I explain some typical methods.
- At first, please get your access token for a fediverse server.
- If you don't have access token, or you want to register applications and get access token programmably, please refer Authorization section.
-
- Home timeline
-
- import generator, { Entity, Response } from 'megalodon'
+These libraries are for node.js, so can not use in browser.
+Here is example Webpack configuration.
-const BASE_URL: string = 'https://mastodon.social'
-const access_token: string = '...'
+
+ Usage
+
+I prepared examples, and please refer documents about each methods.
+I explain some typical methods.
+At first, please get your access token for a fediverse server.
+If you don't have access token, or you want to register applications and get access token programmably, please refer Authorization section.
-const client = generator('mastodon', BASE_URL, access_token)
-client.getHomeTimeline()
- .then((res: Response<Array<Entity.Status>>) => {
- console.log(res.data)
- })
+
+ Home timeline
+
+import generator, { Entity, Response } from 'megalodon'
const BASE_URL: string = 'https://mastodon.social'
const access_token: string = '...'
const client = generator('mastodon', BASE_URL, access_token)
client.getHomeTimeline()
.then((res: Response<Array<Entity.Status>>) => {
console.log(res.data)
})
-
- Post toot
-
- import generator, { Entity, Response } from 'megalodon'
-const BASE_URL: string = 'https://mastodon.social'
-const access_token: string = '...'
-const toot: string = 'test toot'
-
-const client = generator('mastodon', BASE_URL, access_token)
-client.postStatus(toot)
- .then((res: Response<Entity.Status>) => {
- console.log(res.data)
- })
+
+ Post toot
+
+import generator, { Entity, Response } from 'megalodon'
const BASE_URL: string = 'https://mastodon.social'
const access_token: string = '...'
const toot: string = 'test toot'
const client = generator('mastodon', BASE_URL, access_token)
client.postStatus(toot)
.then((res: Response<Entity.Status>) => {
console.log(res.data)
})
-
- Post medias
-
- Please provide a file to the argument.
- import generator, { Entity, Response } from 'megalodon'
-import fs from 'fs'
-const BASE_URL: string = 'https://mastodon.social'
-const access_token: string = '...'
-const image = fs.readFileSync("test.image")
-
-const client = generator('mastodon', BASE_URL, access_token)
-client.uploadMedia(image)
- .then((res: Response<Entity.Attachment>) => {
- console.log(res.data)
- })
+
+ Post medias
+
+Please provide a file to the argument.
+import generator, { Entity, Response } from 'megalodon'
import fs from 'fs'
const BASE_URL: string = 'https://mastodon.social'
const access_token: string = '...'
const image = fs.readFileSync("test.image")
const client = generator('mastodon', BASE_URL, access_token)
client.uploadMedia(image)
.then((res: Response<Entity.Attachment>) => {
console.log(res.data)
})
-
- WebSocket streaming
-
- Mastodon, Pleroma and Misskey provide WebSocket for streaming.
- import generator, { Entity, WebSocketInterface } from 'megalodon'
-const BASE_URL: string = 'wss://pleroma.io'
-const access_token: string = '...'
-
-const client = generator('pleroma', BASE_URL, access_token)
-const stream: WebSocketInterface = client.userSocket()
-
-stream.on('connect', () => {
- console.log('connect')
-})
-
-stream.on('update', (status: Entity.Status) => {
- console.log(status)
-})
-
-stream.on('notification', (notification: Entity.Notification) => {
- console.log(notification)
-})
-
-stream.on('delete', (id: number) => {
- console.log(id)
-})
-
-stream.on('error', (err: Error) => {
- console.error(err)
-})
-
-stream.on('heartbeat', () => {
- console.log('thump.')
-})
-
-stream.on('close', () => {
- console.log('close')
-})
-
-stream.on('parser-error', (err: Error) => {
- console.error(err)
-})
+
+ WebSocket streaming
+
+Mastodon, Pleroma and Misskey provide WebSocket for streaming.
+import generator, { Entity, WebSocketInterface } from 'megalodon'
const BASE_URL: string = 'wss://pleroma.io'
const access_token: string = '...'
const client = generator('pleroma', BASE_URL, access_token)
const stream: WebSocketInterface = client.userSocket()
stream.on('connect', () => {
console.log('connect')
})
stream.on('update', (status: Entity.Status) => {
console.log(status)
})
stream.on('notification', (notification: Entity.Notification) => {
console.log(notification)
})
stream.on('delete', (id: number) => {
console.log(id)
})
stream.on('error', (err: Error) => {
console.error(err)
})
stream.on('heartbeat', () => {
console.log('thump.')
})
stream.on('close', () => {
console.log('close')
})
stream.on('parser-error', (err: Error) => {
console.error(err)
})
-
- HTTP Streaming
-
- Mastodon provides HTTP streaming.
- import generator, { Entity, StreamListenerInterface } from 'megalodon'
-const BASE_URL: string = 'https://mastodon.social'
-const access_token: string = '...'
-
-const client = generator('mastodon', BASE_URL, access_token)
-const stream: StreamListenerInterface
-
-stream.on('update', (status: Entity.Status) => {
- console.log(status)
-})
-
-stream.on('notification', (notification: Entity.Notification) => {
- console.log(notification)
-})
-
-stream.on('delete', (id: number) => {
- console.log(id)
-})
-
-stream.on('error', (err: Error) => {
- console.error(err)
-})
-
-stream.on('heartbeat', () => {
- console.log('thump.')
-})
+
+ HTTP Streaming
+
+Mastodon provides HTTP streaming.
+import generator, { Entity, StreamListenerInterface } from 'megalodon'
const BASE_URL: string = 'https://mastodon.social'
const access_token: string = '...'
const client = generator('mastodon', BASE_URL, access_token)
const stream: StreamListenerInterface
stream.on('update', (status: Entity.Status) => {
console.log(status)
})
stream.on('notification', (notification: Entity.Notification) => {
console.log(notification)
})
stream.on('delete', (id: number) => {
console.log(id)
})
stream.on('error', (err: Error) => {
console.error(err)
})
stream.on('heartbeat', () => {
console.log('thump.')
})
-
- Authorization
-
- You can register applications, and get access tokens to use this method.
- import generator, { OAuth } from 'megalodon'
-const BASE_URL: string = 'https://mastodon.social'
-
-let clientId: string
-let clientSecret: string
-
-const client = generator('mastodon', BASE_URL)
-
-client.registerApp('Test App')
- .then(appData => {
- clientId = appData.clientId
- clientSecret = appData.clientSecret
- console.log('Authorization URL is generated.')
- console.log(appData.url)
- })
+
+ Authorization
+
+You can register applications, and get access tokens to use this method.
+import generator, { OAuth } from 'megalodon'
const BASE_URL: string = 'https://mastodon.social'
let clientId: string
let clientSecret: string
const client = generator('mastodon', BASE_URL)
client.registerApp('Test App')
.then(appData => {
clientId = appData.clientId
clientSecret = appData.clientSecret
console.log('Authorization URL is generated.')
console.log(appData.url)
})
- Please open Autorhization URL
in your browser, and authorize this app.
- In this time, you can get authorization code.
- After that, get an access token.
- const code = '...' // Authorization code
-
-client.fetchAccessToken(clientId, clientSecret, code)
-})
- .then((tokenData: OAuth.TokenData) => {
- console.log(tokenData.accessToken)
- console.log(tokenData.refreshToken)
- })
- .catch((err: Error) => console.error(err))
+Please open Autorhization URL
in your browser, and authorize this app.
+In this time, you can get authorization code.
+After that, get an access token.
+const code = '...' // Authorization code
client.fetchAccessToken(clientId, clientSecret, code)
})
.then((tokenData: OAuth.TokenData) => {
console.log(tokenData.accessToken)
console.log(tokenData.refreshToken)
})
.catch((err: Error) => console.error(err))
-
- Detect each SNS
-
- You have to provide SNS name mastodon
, pleroma
or misskey
to generator
function.
- But when you only know the URL and not the SNS, detector
function can detect the SNS.
- import { detector } from 'megalodon'
-const URL = 'https://misskey.io'
-
-const sns = await detector(URL)
-console.log(sns)
+
+ Detect each SNS
+
+You have to provide SNS name mastodon
, pleroma
or misskey
to generator
function.
+But when you only know the URL and not the SNS, detector
function can detect the SNS.
+import { detector } from 'megalodon'
const URL = 'https://misskey.io'
const sns = await detector(URL)
console.log(sns)
-
- License
-
- The software is available as open source under the terms of the MIT License.
-
-
-
-
-
-
-
- Generated using TypeDoc
-
-
-
-
-
\ No newline at end of file
+
+
+ License
+
+The software is available as open source under the terms of the MIT License.
+
Generated using TypeDoc
POST /api/v1/follow_requests/:id/authorize
+Target account ID.
+Relationship.
+POST /api/v1/lists/:id/accounts
+Target list ID.
+Array of account IDs to add to the list.
+POST /api/v1/accounts/:id/block
+The account ID.
+Relationship
+POST/api/v1/domain_blocks
+Domain to block.
+Cancel all requests in this instance.
+void
+DELETE /api/v1/scheduled_statuses/:id
+Target scheduled status ID.
+Call /api/v1/apps
+Create an application.
+your application's name
+Form Data
+POST /api/v1/featured_tags
+Target hashtag name.
+FeaturedTag.
+POST /api/v1/filters
+Text to be filtered.
+Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
+ISO 8601 Datetime for when the filter expires.
+Should the server irreversibly drop matching entities from home and notifications?
+Consider word boundaries?
+Filter
+DELETE /api/v1/lists/:id/accounts
+Target list ID.
+Array of account IDs to add to the list.
+DELETE /api/v1/conversations/:id
+Target conversation ID.
+DELETE /api/v1/featured_tags/:id
+Target featured tag id.
+Empty
+DELETE /api/v1/lists/:id
+Target list ID.
+DELETE /api/v1/push/subscription
+DELETE /api/v1/statuses/:id
+The target status id.
+Status
+POST /api/v1/notifications/:id/dismiss
+Target notification ID.
+POST /api/v1/notifications/clear
+POST /oauth/token
+Fetch OAuth access token. +Get an access token based client_id and client_secret and authorization code.
+will be generated by #createApp or #registerApp
+will be generated by #createApp or #registerApp
+will be generated by the link of #generateAuthUrl or #registerApp
+must be the same uri as the time when you register your OAuth application
+POST /api/v1/accounts/:id/follow
+The account ID.
+Relationship
+GET /api/v1/pleroma/accounts/:id/favourites
+Target account ID.
+Max number of results to return.
+Return results order than ID.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/accounts/:id/followers
+The account ID.
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results newer than ID.
+The array of accounts.
+GET /api/v1/accounts/:id/following
+The account ID.
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results newer than ID.
+The array of accounts.
+GET /api/v1/accounts/:id/statuses
+The account ID.
+Return statuses which exclude reblogs.
+Return statuses which exclude replies.
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Show only statuses with media attached? Defaults to false.
+Return statuses which include pinned statuses.
+Return results newer than ID.
+Account's statuses.
+GET /api/v1/lists/:id/accounts
+Target list ID.
+Max number of results to return.
+Return results older than ID.
+Return results newer than ID.
+Array of accounts.
+GET /api/v1/blocks
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results immediately newer than ID.
+Array of accounts.
+GET /api/v1/bookmarks
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results immediately newer than ID.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/conversations
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Return results immediately newer than ID.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/domain_blocks
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results immediately newer than ID.
+Array of domain name.
+GET /api/v1/endorsements
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results newer than ID.
+Array of accounts.
+GET /api/v1/favourites
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results immediately newer than ID.
+Array of statuses.
+GET /api/v1/featured_tags
+Array of featured tag.
+GET /api/v1/timelines/home
+Max number of results to return. Defaults to 20.
+Show only local statuses? Defaults to false.
+Return results older than ID.
+Return results immediately newer than ID.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/accounts/:id/identity_proofs
+The account ID.
+Array of IdentityProof
+GET /api/v1/directory
+How many accounts to load. Default 40.
+Only return local accounts.
+How many accounts to skip before returning results. Default 0.
+Order of results.
+Array of accounts.
+GET /api/v1/instance/peers
+GET /api/v1/timelines/list/:list_id
+Local ID of the list in the database.
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Return results immediately newer than ID.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/timelines/public
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Return results immediately newer than ID.
+Show only statuses with media attached? Defaults to false.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/mutes
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results immediately newer than ID.
+Array of accounts.
+GET /api/v1/notifications/:id
+Target notification ID.
+Notification.
+GET /api/v1/notifications
+Return only notifications received from this account.
+Array of types to exclude.
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Return results immediately newer than ID.
+Return results newer than ID.
+Array of notifications.
+GET /api/v1/preferences
+Preferences.
+GET /api/v1/timelines/public
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Return results immediately newer than ID.
+Show only statuses with media attached? Defaults to false.
+Return results newer than ID.
+Array of statuses.
+GET /api/v1/push/subscription
+PushSubscription.
+GET /api/v1/accounts/relationships
+The account ID.
+Relationship
+Get multiple relationships in one method
+Array of account IDs.
+Array of Relationship.
+GET /api/v1/scheduled_statuses/:id
+Target status ID.
+ScheduledStatus.
+GET /api/v1/scheduled_statuses
+Max number of results to return. Defaults to 20.
+Return results older than ID.
+Return results immediately newer than ID.
+Return results newer than ID.
+Array of scheduled statuses.
+GET /api/v1/statuses/:id/context
+Get parent and child statuses.
+The target status id.
+Context
+GET /api/v1/timelines/tag/:hashtag
+Content of a #hashtag, not including # symbol.
+Max number of results to return. Defaults to 20.
+Show only local statuses? Defaults to false.
+Return results older than ID.
+Return results immediately newer than ID.
+Show only statuses with media attached? Defaults to false.
+Return results newer than ID.
+Array of statuses.
+POST /api/v1/accounts/:id/mute
+The account ID.
+Mute notifications in addition to statuses.
+Relationship
+POST /api/v1/accounts/:id/pin
+The account ID.
+Relationship
+POST /api/v1/statuses
+Text content of status.
+ID of the status being replied to, if status is a reply.
+ISO 639 language code for this status.
+Array of Attachment ids.
+Poll object.
+ID of the status being quoted to, if status is a quote.
+ISO 8601 Datetime at which to schedule a status.
+Mark status and attached media as sensitive?
+Text to be shown as a warning or subject before the actual content.
+Visibility of the posted status.
+Status
+POST /api/v1/conversations/:id/read
+Target conversation ID.
+Conversation.
+POST /oauth/token
+Refresh OAuth access token. +Send refresh token and get new access token.
+will be generated by #createApp or #registerApp
+will be generated by #createApp or #registerApp
+will be get #fetchAccessToken
+POST /api/v1/accounts
+Username for the account.
+Email for the account.
+Password for the account.
+Whether the user agrees to the local rules, terms, and policies.
+The language of the confirmation email that will be sent
+Text that will be reviewed by moderators if registrations require manual approval.
+An account token.
+First, call createApp to get client_id and client_secret. +Next, call generateAuthUrl to get authorization url.
+Form Data, which is sent to /api/v1/apps
+Form Data, which is sent to /api/v1/apps. and properties should be snake_case
+POST /api/v1/follow_requests/:id/reject
+Target account ID.
+Relationship.
+POST /api/v1/reports
+Target account ID.
+Reason of the report.
+If the account is remote, should the report be forwarded to the remote admin?
+Array of Statuses ids to attach to the report.
+Report
+POST /oauth/revoke
+Revoke an OAuth token.
+will be generated by #createApp or #registerApp
+will be generated by #createApp or #registerApp
+will be get #fetchAccessToken
+POST /api/v1/markers
+Marker position of the last read status ID in home timeline.
+Marker position of the last read notification ID in notifications.
+Marker.
+PUT /api/v1/scheduled_statuses/:id
+Target scheduled status ID.
+ISO 8601 Datetime at which the status will be published.
+ScheduledStatus.
+GET /api/v2/search
+The search query.
+Enum of search target.
+If provided, statuses returned will be authored only by this account.
+Filter out unreviewed tags? Defaults to false.
+Only include accounts that the user is following. Defaults to false.
+Maximum number of results to load, per type. Defaults to 20. Max 40.
+Return results older than this id.
+Return results immediately newer than this id.
+Attempt WebFinger lookup. Defaults to false.
+Results.
+GET /api/v1/accounts/search
+Search query.
+Max number of results to return. Defaults to 40.
+Return results older than ID.
+Return results newer than ID.
+The array of accounts.
+POST /api/v1/pleroma/accounts/:id/subscribe
+Target account ID.
+Relationship.
+POST /api/v1/push/subscription
+PushSubscription.
+POST /api/v1/accounts/:id/unblock
+The account ID.
+RElationship
+DELETE /api/v1/domain_blocks
+Domain to unblock
+POST /api/v1/accounts/:id/unfollow
+The account ID.
+Relationship
+POST /api/v1/accounts/:id/unmute
+The account ID.
+Relationship
+POST /api/v1/accounts/:id/unpin
+The account ID.
+Relationship
+POST /api/v1/pleroma/accounts/:id/unsubscribe
+Target account ID.
+Relationship.
+PATCH /api/v1/accounts/update_credentials
+An account.
+PUT /api/v1/filters/:id
+The filter ID.
+Text to be filtered.
+Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
+ISO 8601 Datetime for when the filter expires.
+Should the server irreversibly drop matching entities from home and notifications?
+Consider word boundaries?
+Filter
+PUT /api/v1/media/:id
+Target media ID.
+A plain-text description of the media.
+The file to be attached, using multipart form data.
+Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
+Whether the media is sensitive.
+Attachment
+PUT /api/v1/push/subscription
+PushSubscription.
+POST /api/v1/media
+The file to be attached, using multipart form data.
+A plain-text description of the media.
+Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
+Attachment
+GET /api/v1/apps/verify_credentials
+An Application
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface
-Generated using TypeDoc
-POST /api/v1/follow_requests/:id/authorize
-Target account ID.
-Relationship.
-POST /api/v1/lists/:id/accounts
-Target list ID.
-Array of account IDs to add to the list.
-POST /api/v1/accounts/:id/block
-The account ID.
-Relationship
-POST/api/v1/domain_blocks
-Domain to block.
-Cancel all requests in this instance.
-void
-DELETE /api/v1/scheduled_statuses/:id
-Target scheduled status ID.
-Call /api/v1/apps
-Create an application.
-your application's name
-Form Data
-POST /api/v1/featured_tags
-Target hashtag name.
-FeaturedTag.
-POST /api/v1/filters
-Text to be filtered.
-Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
-ISO 8601 Datetime for when the filter expires.
-Should the server irreversibly drop matching entities from home and notifications?
-Consider word boundaries?
-Filter
-DELETE /api/v1/lists/:id/accounts
-Target list ID.
-Array of account IDs to add to the list.
-DELETE /api/v1/conversations/:id
-Target conversation ID.
-DELETE /api/v1/featured_tags/:id
-Target featured tag id.
-Empty
-DELETE /api/v1/lists/:id
-Target list ID.
-DELETE /api/v1/push/subscription
-DELETE /api/v1/statuses/:id
-The target status id.
-Status
-POST /api/v1/notifications/:id/dismiss
-Target notification ID.
-POST /api/v1/notifications/clear
-POST /oauth/token
-Fetch OAuth access token. - Get an access token based client_id and client_secret and authorization code.
-will be generated by #createApp or #registerApp
-will be generated by #createApp or #registerApp
-will be generated by the link of #generateAuthUrl or #registerApp
-must be the same uri as the time when you register your OAuth application
-POST /api/v1/accounts/:id/follow
-The account ID.
-Relationship
-GET /api/v1/pleroma/accounts/:id/favourites
-Target account ID.
-Max number of results to return.
-Return results order than ID.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/accounts/:id/followers
-The account ID.
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results newer than ID.
-The array of accounts.
-GET /api/v1/accounts/:id/following
-The account ID.
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results newer than ID.
-The array of accounts.
-GET /api/v1/accounts/:id/statuses
-The account ID.
-Return statuses which exclude reblogs.
-Return statuses which exclude replies.
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Show only statuses with media attached? Defaults to false.
-Return statuses which include pinned statuses.
-Return results newer than ID.
-Account's statuses.
-GET /api/v1/lists/:id/accounts
-Target list ID.
-Max number of results to return.
-Return results older than ID.
-Return results newer than ID.
-Array of accounts.
-GET /api/v1/blocks
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results immediately newer than ID.
-Array of accounts.
-GET /api/v1/bookmarks
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results immediately newer than ID.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/conversations
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Return results immediately newer than ID.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/domain_blocks
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results immediately newer than ID.
-Array of domain name.
-GET /api/v1/endorsements
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results newer than ID.
-Array of accounts.
-GET /api/v1/favourites
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results immediately newer than ID.
-Array of statuses.
-GET /api/v1/featured_tags
-Array of featured tag.
-GET /api/v1/timelines/home
-Max number of results to return. Defaults to 20.
-Show only local statuses? Defaults to false.
-Return results older than ID.
-Return results immediately newer than ID.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/accounts/:id/identity_proofs
-The account ID.
-Array of IdentityProof
-GET /api/v1/directory
-How many accounts to load. Default 40.
-Only return local accounts.
-How many accounts to skip before returning results. Default 0.
-Order of results.
-Array of accounts.
-GET /api/v1/instance/peers
-GET /api/v1/timelines/list/:list_id
-Local ID of the list in the database.
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Return results immediately newer than ID.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/timelines/public
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Return results immediately newer than ID.
-Show only statuses with media attached? Defaults to false.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/mutes
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results immediately newer than ID.
-Array of accounts.
-GET /api/v1/notifications/:id
-Target notification ID.
-Notification.
-GET /api/v1/notifications
-Return only notifications received from this account.
-Array of types to exclude.
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Return results immediately newer than ID.
-Return results newer than ID.
-Array of notifications.
-GET /api/v1/preferences
-Preferences.
-GET /api/v1/timelines/public
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Return results immediately newer than ID.
-Show only statuses with media attached? Defaults to false.
-Return results newer than ID.
-Array of statuses.
-GET /api/v1/push/subscription
-PushSubscription.
-GET /api/v1/accounts/relationships
-The account ID.
-Relationship
-Get multiple relationships in one method
-Array of account IDs.
-Array of Relationship.
-GET /api/v1/scheduled_statuses/:id
-Target status ID.
-ScheduledStatus.
-GET /api/v1/scheduled_statuses
-Max number of results to return. Defaults to 20.
-Return results older than ID.
-Return results immediately newer than ID.
-Return results newer than ID.
-Array of scheduled statuses.
-GET /api/v1/statuses/:id/context
-Get parent and child statuses.
-The target status id.
-Context
-GET /api/v1/timelines/tag/:hashtag
-Content of a #hashtag, not including # symbol.
-Max number of results to return. Defaults to 20.
-Show only local statuses? Defaults to false.
-Return results older than ID.
-Return results immediately newer than ID.
-Show only statuses with media attached? Defaults to false.
-Return results newer than ID.
-Array of statuses.
-POST /api/v1/accounts/:id/mute
-The account ID.
-Mute notifications in addition to statuses.
-Relationship
-POST /api/v1/accounts/:id/pin
-The account ID.
-Relationship
-POST /api/v1/statuses
-Text content of status.
-ID of the status being replied to, if status is a reply.
-ISO 639 language code for this status.
-Array of Attachment ids.
-Poll object.
-ID of the status being quoted to, if status is a quote.
-ISO 8601 Datetime at which to schedule a status.
-Mark status and attached media as sensitive?
-Text to be shown as a warning or subject before the actual content.
-Visibility of the posted status.
-Status
-POST /api/v1/conversations/:id/read
-Target conversation ID.
-Conversation.
-POST /oauth/token
-Refresh OAuth access token. - Send refresh token and get new access token.
-will be generated by #createApp or #registerApp
-will be generated by #createApp or #registerApp
-will be get #fetchAccessToken
-POST /api/v1/accounts
-Username for the account.
-Email for the account.
-Password for the account.
-Whether the user agrees to the local rules, terms, and policies.
-The language of the confirmation email that will be sent
-Text that will be reviewed by moderators if registrations require manual approval.
-An account token.
-First, call createApp to get client_id and client_secret. - Next, call generateAuthUrl to get authorization url.
-Form Data, which is sent to /api/v1/apps
-Form Data, which is sent to /api/v1/apps. and properties should be snake_case
-POST /api/v1/follow_requests/:id/reject
-Target account ID.
-Relationship.
-POST /api/v1/reports
-Target account ID.
-Reason of the report.
-If the account is remote, should the report be forwarded to the remote admin?
-Array of Statuses ids to attach to the report.
-Report
-POST /oauth/revoke
-Revoke an OAuth token.
-will be generated by #createApp or #registerApp
-will be generated by #createApp or #registerApp
-will be get #fetchAccessToken
-POST /api/v1/markers
-Marker position of the last read status ID in home timeline.
-Marker position of the last read notification ID in notifications.
-Marker.
-PUT /api/v1/scheduled_statuses/:id
-Target scheduled status ID.
-ISO 8601 Datetime at which the status will be published.
-ScheduledStatus.
-GET /api/v2/search
-The search query.
-Enum of search target.
-If provided, statuses returned will be authored only by this account.
-Filter out unreviewed tags? Defaults to false.
-Only include accounts that the user is following. Defaults to false.
-Maximum number of results to load, per type. Defaults to 20. Max 40.
-Return results older than this id.
-Return results immediately newer than this id.
-Attempt WebFinger lookup. Defaults to false.
-Results.
-GET /api/v1/accounts/search
-Search query.
-Max number of results to return. Defaults to 40.
-Return results older than ID.
-Return results newer than ID.
-The array of accounts.
-POST /api/v1/pleroma/accounts/:id/subscribe
-Target account ID.
-Relationship.
-POST /api/v1/push/subscription
-PushSubscription.
-POST /api/v1/accounts/:id/unblock
-The account ID.
-RElationship
-DELETE /api/v1/domain_blocks
-Domain to unblock
-POST /api/v1/accounts/:id/unfollow
-The account ID.
-Relationship
-POST /api/v1/accounts/:id/unmute
-The account ID.
-Relationship
-POST /api/v1/accounts/:id/unpin
-The account ID.
-Relationship
-POST /api/v1/pleroma/accounts/:id/unsubscribe
-Target account ID.
-Relationship.
-PATCH /api/v1/accounts/update_credentials
-An account.
-PUT /api/v1/filters/:id
-The filter ID.
-Text to be filtered.
-Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
-ISO 8601 Datetime for when the filter expires.
-Should the server irreversibly drop matching entities from home and notifications?
-Consider word boundaries?
-Filter
-PUT /api/v1/media/:id
-Target media ID.
-A plain-text description of the media.
-The file to be attached, using multipart form data.
-Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
-Whether the media is sensitive.
-Attachment
-PUT /api/v1/push/subscription
-PushSubscription.
-POST /api/v1/media
-The file to be attached, using multipart form data.
-A plain-text description of the media.
-Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
-Attachment
-GET /api/v1/apps/verify_credentials
-An Application
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Interface
-Generated using TypeDoc
-Interface
-Generated using TypeDoc
-Generated using TypeDoc
-Get client for each SNS according to megalodon interface.
+Name of your SNS, mastodon
or pleroma
.
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.
+Client instance for each SNS you specified.
+Detect SNS type. +Now support Mastodon, Pleroma and Pixelfed.
+Base URL of SNS.
+Proxy setting, or set false if don't use proxy.
+SNS name.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
OAuth +Response data when oauth request.
+Generated using TypeDoc
Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Get client for each SNS according to megalodon interface.
-Name of your SNS, mastodon
or pleroma
.
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.
-Client instance for each SNS you specified.
-Detect SNS type. - Now support Mastodon, Pleroma and Pixelfed.
-Base URL of SNS.
-Proxy setting, or set false if don't use proxy.
-SNS name.
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-OAuth - Response data when oauth request.
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-Generated using TypeDoc
-
hostname or base URL
+