Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Misskey

Hierarchy

  • Misskey

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Misskey(baseUrl: string, accessToken?: null | string, userAgent?: null | string, proxyConfig?: false | ProxyConfig): Misskey
  • Parameters

    • baseUrl: string

      hostname or base URL

    • accessToken: null | string = null

      access token from OAuth2 authorization

    • 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 Misskey

Properties

baseUrl

baseUrl: string

client

client: Interface

proxyConfig

proxyConfig: false | ProxyConfig

Methods

acceptFollowRequest

addAccountsToList

  • addAccountsToList(id: string, account_ids: string[]): Promise<Response<{}>>

blockAccount

blockDomain

  • blockDomain(_domain: string): Promise<Response<{}>>

bookmarkStatus

cancel

  • cancel(): void
  • Cancel all requests in this instance.

    Returns void

    void

cancelScheduledStatus

  • cancelScheduledStatus(_id: string): Promise<Response<{}>>

createApp

  • createApp(client_name: string, options?: Partial<{ redirect_uris: string; scopes: string[]; website: string }>): Promise<AppData>
  • POST /api/app/create

    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>

createEmojiReaction

createFeaturedTag

createFilter

  • createFilter(_phrase: string, _context: string[], _options?: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }): Promise<Response<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

createList

deleteAccountsFromList

  • deleteAccountsFromList(id: string, account_ids: string[]): Promise<Response<{}>>

deleteConversation

  • deleteConversation(_id: string): Promise<Response<{}>>

deleteEmojiReaction

deleteFeaturedTag

  • deleteFeaturedTag(_id: string): Promise<Response<{}>>

deleteFilter

deleteList

  • deleteList(id: string): Promise<Response<{}>>

deletePushSubscription

  • deletePushSubscription(): Promise<Response<{}>>

deleteStatus

  • deleteStatus(id: string): Promise<Response<{}>>

directSocket

directStream

dismissNotification

  • dismissNotification(_id: string): Promise<Response<{}>>

dismissNotifications

  • dismissNotifications(): Promise<Response<{}>>

favouriteStatus

fetchAccessToken

  • fetchAccessToken(_client_id: null | string, client_secret: string, session_token: string, _redirect_uri?: string): Promise<TokenData>
  • POST /api/auth/session/userkey

    Parameters

    • _client_id: null | string

      This parameter is not used in this method.

    • client_secret: string

      Application secret key which will be provided in createApp.

    • session_token: string

      Session token string which will be provided in generateAuthUrlAndToken.

    • Optional _redirect_uri: string

      This parameter is not used in this method.

    Returns Promise<TokenData>

followAccount

generateAuthUrlAndToken

  • generateAuthUrlAndToken(clientSecret: string): Promise<Session>
  • POST /api/auth/session/generate

    Parameters

    • clientSecret: string

    Returns Promise<Session>

getAccount

getAccountFavourites

  • getAccountFavourites(_id: string, _options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • 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<Entity.Status[]>>

    Array of statuses.

getAccountFollowers

  • getAccountFollowers(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • POST /api/users/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.Account[]>>

getAccountFollowing

  • getAccountFollowing(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • POST /api/users/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[]>>

getAccountLists

getAccountStatuses

  • getAccountStatuses(id: string, options?: { exclude_reblogs: boolean; exclude_replies: boolean; limit?: number; max_id?: string; only_media?: boolean; pinned?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/users/notes

    Parameters

    • id: string
    • Optional options: { exclude_reblogs: boolean; exclude_replies: boolean; limit?: number; max_id?: string; only_media?: boolean; pinned?: boolean; since_id?: string }
      • exclude_reblogs: boolean
      • exclude_replies: boolean
      • Optional limit?: number
      • Optional max_id?: string
      • Optional only_media?: boolean
      • Optional pinned?: boolean
      • Optional since_id?: string

    Returns Promise<Response<Entity.Status[]>>

getAccountsInList

  • getAccountsInList(id: string, _options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • POST /api/users/lists/show

    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[]>>

getBlocks

  • getBlocks(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Entity.Account[]>>
  • POST /api/blocking/list

    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[]>>

getBookmarks

  • getBookmarks(_options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • 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<Entity.Status[]>>

    Array of statuses.

getConversationTimeline

  • getConversationTimeline(options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Conversation[]>>
  • POST /api/notes/mentions

    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[]>>

getDomainBlocks

  • getDomainBlocks(_options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<string[]>>
  • 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.

getEmojiReaction

getEmojiReactions

getEndorsements

  • getEndorsements(_options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Entity.Account[]>>
  • 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<Entity.Account[]>>

    Array of accounts.

getFavourites

  • getFavourites(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/i/favorites

    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[]>>

getFeaturedTags

getFilter

getFilters

getFollowRequests

getHomeTimeline

  • getHomeTimeline(options?: { limit?: number; local?: boolean; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/notes/timeline

    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[]>>

getIdentityProof

getInstance

getInstanceActivity

getInstanceCustomEmojis

getInstanceDirectory

  • getInstanceDirectory(_options?: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }): Promise<Response<Entity.Account[]>>
  • 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<Entity.Account[]>>

    Array of accounts.

getInstancePeers

  • getInstancePeers(): Promise<Response<string[]>>

getInstanceTrends

  • getInstanceTrends(_limit?: null | number): Promise<Response<Tag[]>>

getList

getListTimeline

  • getListTimeline(list_id: string, options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/notes/user-list-timeline

    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[]>>

getLists

getLocalTimeline

  • getLocalTimeline(options?: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/notes/local-timeline

    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[]>>

getMarkers

getMutes

  • getMutes(options?: { limit?: number; max_id?: string; min_id?: string }): Promise<Response<Entity.Account[]>>
  • POST /api/mute/list

    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[]>>

getNotification

getNotifications

  • getNotifications(options?: { account_id?: string; exclude_type?: string[]; limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<Notification[]>>
  • POST /api/i/notifications

    Parameters

    • Optional options: { account_id?: string; exclude_type?: string[]; limit?: number; max_id?: string; min_id?: string; since_id?: string }
      • Optional account_id?: string
      • Optional exclude_type?: string[]
      • Optional limit?: number
      • Optional max_id?: string
      • Optional min_id?: string
      • Optional since_id?: string

    Returns Promise<Response<Notification[]>>

getPoll

getPreferences

getPublicTimeline

  • getPublicTimeline(options?: { limit?: number; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/notes/global-timeline

    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[]>>

getPushSubscription

getRelationship

getRelationships

getScheduledStatus

getScheduledStatuses

  • getScheduledStatuses(_options?: { limit?: number; max_id?: string; min_id?: string; since_id?: string }): Promise<Response<ScheduledStatus[]>>
  • GET /api/v1/scheduled_statuses

    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<ScheduledStatus[]>>

    Array of scheduled statuses.

getStatus

getStatusContext

  • getStatusContext(id: string, options?: { limit?: number; max_id?: string; since_id?: string }): Promise<Response<Context>>
  • POST /api/notes/children

    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>>

getStatusFavouritedBy

getStatusRebloggedBy

getSuggestedTags

getSuggestions

getTagTimeline

  • getTagTimeline(hashtag: string, options?: { limit?: number; local?: boolean; max_id?: string; min_id?: string; only_media?: boolean; since_id?: string }): Promise<Response<Entity.Status[]>>
  • POST /api/notes/search-by-tag

    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[]>>

listSocket

listStream

localSocket

localStream

muteAccount

muteStatus

pinAccount

pinStatus

postStatus

  • postStatus(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" }): Promise<Response<Entity.Status>>
  • POST /api/v1/statuses

    Parameters

    • status: string
    • Optional 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

publicSocket

publicStream

readConversation

readNotifications

reblogStatus

refreshToken

  • refreshToken(_client_id: string, _client_secret: string, _refresh_token: string): Promise<TokenData>
  • 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>

registerAccount

  • registerAccount(_username: string, _email: string, _password: string, _agreement: boolean, _locale: string, _reason?: null | string): Promise<Response<Token>>
  • 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.

registerApp

  • registerApp(client_name: string, options?: Partial<{ redirect_uris: string; scopes: string[]; website: string }>): Promise<AppData>
  • 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>

rejectFollowRequest

report

  • report(account_id: string, comment: string, _options?: { forward?: boolean; status_ids?: string[] }): Promise<Response<Report>>
  • POST /api/users/report-abuse

    Parameters

    • account_id: string
    • comment: string
    • Optional _options: { forward?: boolean; status_ids?: string[] }
      • Optional forward?: boolean
      • Optional status_ids?: string[]

    Returns Promise<Response<Report>>

revokeToken

  • revokeToken(_client_id: string, _client_secret: string, _token: string): Promise<Response<{}>>
  • POST /oauth/revoke

    Revoke an OAuth token.

    Parameters

    • _client_id: string
    • _client_secret: string
    • _token: string

    Returns Promise<Response<{}>>

saveMarkers

  • saveMarkers(_options?: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }): Promise<Response<Marker>>
  • 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.

scheduleStatus

search

  • search(q: string, type: "accounts" | "hashtags" | "statuses", options?: { account_id?: string; exclude_unreviewed?: boolean; following?: boolean; limit?: number; max_id?: string; min_id?: string; offset?: number; resolve?: boolean }): Promise<Response<Results>>
  • 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.

searchAccount

  • searchAccount(q: string, options?: { following?: boolean; limit?: number; max_id?: string; resolve?: boolean; since_id?: string }): Promise<Response<Entity.Account[]>>
  • POST /api/users/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<Entity.Account[]>>

subscribeAccount

subscribePushNotification

  • subscribePushNotification(_subscription: { endpoint: string; keys: { auth: string; p256dh: string } }, _data?: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }): Promise<Response<PushSubscription>>
  • 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.

tagSocket

tagStream

unblockAccount

unblockDomain

  • unblockDomain(_domain: string): Promise<Response<{}>>

unbookmarkStatus

unfavouriteStatus

unfollowAccount

unmuteAccount

unmuteStatus

unpinAccount

unpinStatus

unreblogStatus

unsubscribeAccount

updateCredentials

  • updateCredentials(options?: { avatar?: string; bot?: boolean; discoverable?: boolean; display_name?: string; fields_attributes?: { name: string; value: string }[]; header?: string; locked?: boolean; note?: string; source?: null | { language?: string; privacy?: string; sensitive?: boolean } }): Promise<Response<Entity.Account>>
  • POST /api/i/update

    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?: null | { 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?: null | { language?: string; privacy?: string; sensitive?: boolean }

    Returns Promise<Response<Entity.Account>>

updateFilter

  • updateFilter(_id: string, _phrase: string, _context: string[], _options?: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }): Promise<Response<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

updateList

  • updateList(id: string, title: string): Promise<Response<List>>

updateMedia

  • updateMedia(id: string, options?: { description?: string; file?: any; focus?: string; is_sensitive?: boolean }): Promise<Response<Attachment>>
  • POST /api/drive/files/update

    Parameters

    • id: string
    • Optional options: { description?: string; file?: any; focus?: string; is_sensitive?: boolean }
      • Optional description?: string
      • Optional file?: any
      • Optional focus?: string
      • Optional is_sensitive?: boolean

    Returns Promise<Response<Attachment>>

updatePushSubscription

  • updatePushSubscription(_data?: null | { alerts: { favourite?: boolean; follow?: boolean; mention?: boolean; poll?: boolean; reblog?: boolean } }): Promise<Response<PushSubscription>>
  • 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.

uploadMedia

  • uploadMedia(file: any, _options?: { description?: string; focus?: string }): Promise<Response<Attachment>>
  • POST /api/drive/files/create

    Parameters

    • file: any
    • Optional _options: { description?: string; focus?: string }
      • Optional description?: string
      • Optional focus?: string

    Returns Promise<Response<Attachment>>

userSocket

userStream

verifyAccountCredentials

verifyAppCredentials

votePoll

  • votePoll(_id: string, choices: number[], status_id?: null | string): Promise<Response<Poll>>
  • POST /api/notes/polls/vote

    Parameters

    • _id: string
    • choices: number[]
    • Optional status_id: null | string

    Returns Promise<Response<Poll>>

Generated using TypeDoc