Class Pixelfed

Implements

MegalodonInterface

Index

Constructors

Properties

Methods

acceptFollowRequest addAccountsToList addReactionToAnnouncement blockAccount blockDomain bookmarkStatus cancel cancelScheduledStatus createApp createEmojiReaction createFeaturedTag createFilter createList deleteAccountsFromList deleteConversation deleteEmojiReaction deleteFeaturedTag deleteFilter deleteList deletePushSubscription deleteStatus directStreaming dismissInstanceAnnouncement dismissNotification dismissNotifications editStatus favouriteStatus fetchAccessToken followAccount followTag generateAuthUrl getAccount getAccountFavourites getAccountFollowers getAccountFollowing getAccountLists getAccountsInList getAccountStatuses getBlocks getBookmarks getConversationTimeline getDomainBlocks getEmojiReaction getEmojiReactions getEndorsements getFavourites getFeaturedTags getFilter getFilters getFollowedTags getFollowRequests getHomeTimeline getIdentityProof getInstance getInstanceActivity getInstanceAnnouncements getInstanceCustomEmojis getInstanceDirectory getInstancePeers getInstanceTrends getList getLists getListTimeline getLocalTimeline getMarkers getMedia getMutes getNotification getNotifications getPoll getPreferences getPublicTimeline getPushSubscription getRelationship getRelationships getScheduledStatus getScheduledStatuses getStatus getStatusContext getStatusFavouritedBy getStatusRebloggedBy getStatusSource getSuggestedTags getSuggestions getTag getTagTimeline listStreaming localStreaming lookupAccount muteAccount muteStatus pinAccount pinStatus postStatus publicStreaming readConversation readNotifications reblogStatus refreshToken registerAccount registerApp rejectFollowRequest removeReactionFromAnnouncement report revokeToken saveMarkers scheduleStatus search searchAccount setAccountNote streamingURL subscribeAccount subscribePushNotification tagStreaming unblockAccount unblockDomain unbookmarkStatus unfavouriteStatus unfollowAccount unfollowTag unmuteAccount unmuteStatus unpinAccount unpinStatus unreblogStatus unsubscribeAccount updateCredentials updateFilter updateList updateMedia updatePushSubscription uploadMedia userStreaming verifyAccountCredentials verifyAppCredentials votePoll

Constructors

constructor

new Pixelfed(
    baseUrl: string,
    accessToken?: null | string,
    userAgent?: null | string,
): Pixelfed
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.
Returns Pixelfed
- Defined in megalodon/src/pixelfed.ts:24

Properties

baseUrl

baseUrl: string

client

client: Interface

Methods

acceptFollowRequest

acceptFollowRequest(id: string): Promise<Response<Relationship>>
POST /api/v1/follow_requests/:id/authorize
Parameters
- id: string
  Target account ID.
Returns Promise<Response<Relationship>>
Relationship.
Implementation of MegalodonInterface.acceptFollowRequest
- Defined in megalodon/src/pixelfed.ts:1297

addAccountsToList

addAccountsToList(_id: string, _account_ids: string[]): Promise<Response<{}>>
POST /api/v1/lists/:id/accounts
Parameters
- _id: string
- _account_ids: string[]
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.addAccountsToList
- Defined in megalodon/src/pixelfed.ts:2557

addReactionToAnnouncement

addReactionToAnnouncement(
id: string,
name: string,
): Promise<Response<Record<never, never>>>
PUT /api/v1/announcements/:id/reactions/:name
Parameters
- id: string
  The ID of the Announcement in the database.
- name: string
  Unicode emoji, or the shortcode of a custom emoji.
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.addReactionToAnnouncement
- Defined in megalodon/src/pixelfed.ts:3016

blockAccount

blockAccount(id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/block
Parameters
- id: string
  The account ID.
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.blockAccount
- Defined in megalodon/src/pixelfed.ts:647

blockDomain

blockDomain(domain: string): Promise<Response<{}>>
POST/api/v1/domain_blocks
Parameters
- domain: string
  Domain to block.
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.blockDomain
- Defined in megalodon/src/pixelfed.ts:1044

bookmarkStatus

bookmarkStatus(id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/bookmark
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.bookmarkStatus
- Defined in megalodon/src/pixelfed.ts:1852

cancel

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

Returns void
void
Implementation of MegalodonInterface.cancel
- Defined in megalodon/src/pixelfed.ts:37

cancelScheduledStatus

cancelScheduledStatus(id: string): Promise<Response<{}>>
DELETE /api/v1/scheduled_statuses/:id
Parameters
- id: string
  Target scheduled status ID.
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.cancelScheduledStatus
- Defined in megalodon/src/pixelfed.ts:2132

createApp

createApp(
    client_name: string,
    options: Partial<
        { redirect_uris: string; scopes: string[]; website: string },
    >,
): Promise<AppData>
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>
Implementation of MegalodonInterface.createApp
- Defined in megalodon/src/pixelfed.ts:71

createEmojiReaction

createEmojiReaction(_id: string, _emoji: string): Promise<Response<Status>>
React to a post with a unicode emoji.
Parameters
- _id: string
- _emoji: string
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.createEmojiReaction
- Defined in megalodon/src/pixelfed.ts:3033

createFeaturedTag

createFeaturedTag(_name: string): Promise<Response<FeaturedTag>>
POST /api/v1/featured_tags
Parameters
- _name: string
Returns Promise<Response<FeaturedTag>>
FeaturedTag.
Implementation of MegalodonInterface.createFeaturedTag
- Defined in megalodon/src/pixelfed.ts:1377

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
  Text to be filtered.
- context: string[]
  Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
- Optionaloptions: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
  - Optionalexpires_in?: string
    ISO 8601 Datetime for when the filter expires.
  - Optionalirreversible?: boolean
    Should the server irreversibly drop matching entities from home and notifications?
  - Optionalwhole_word?: boolean
    Consider word boundaries?
Returns Promise<Response<Filter>>
Filter
Implementation of MegalodonInterface.createFilter
- Defined in megalodon/src/pixelfed.ts:1101

createList

createList(_title: string): Promise<Response<List>>
POST /api/v1/lists
Parameters
- _title: string
Returns Promise<Response<List>>
List.
Implementation of MegalodonInterface.createList
- Defined in megalodon/src/pixelfed.ts:2494

deleteAccountsFromList

deleteAccountsFromList(
_id: string,
_account_ids: string[],
): Promise<Response<{}>>
DELETE /api/v1/lists/:id/accounts
Parameters
- _id: string
- _account_ids: string[]
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.deleteAccountsFromList
- Defined in megalodon/src/pixelfed.ts:2570

deleteConversation

deleteConversation(id: string): Promise<Response<{}>>
DELETE /api/v1/conversations/:id
Parameters
- id: string
  Target conversation ID.
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.deleteConversation
- Defined in megalodon/src/pixelfed.ts:2441

deleteEmojiReaction

deleteEmojiReaction(_id: string, _emoji: string): Promise<Response<Status>>
Remove a reaction to a post with a unicode emoji.
Parameters
- _id: string
- _emoji: string
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.deleteEmojiReaction
- Defined in megalodon/src/pixelfed.ts:3040

deleteFeaturedTag

deleteFeaturedTag(_id: string): Promise<Response<{}>>
DELETE /api/v1/featured_tags/:id
Parameters
- _id: string
Returns Promise<Response<{}>>
Empty
Implementation of MegalodonInterface.deleteFeaturedTag
- Defined in megalodon/src/pixelfed.ts:1390

deleteFilter

deleteFilter(id: string): Promise<Response<Filter>>
DELETE /api/v1/filters/:id
Parameters
- id: string
  The filter ID.
Returns Promise<Response<Filter>>
Removed filter.
Implementation of MegalodonInterface.deleteFilter
- Defined in megalodon/src/pixelfed.ts:1193

deleteList

deleteList(_id: string): Promise<Response<{}>>
DELETE /api/v1/lists/:id
Parameters
- _id: string
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.deleteList
- Defined in megalodon/src/pixelfed.ts:2520

deletePushSubscription

deletePushSubscription(): Promise<Response<{}>>
DELETE /api/v1/push/subscription

Returns Promise<Response<{}>>
Implementation of MegalodonInterface.deletePushSubscription
- Defined in megalodon/src/pixelfed.ts:2797

deleteStatus

deleteStatus(id: string): Promise<Response<Status>>
DELETE /api/v1/statuses/:id
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.deleteStatus
- Defined in megalodon/src/pixelfed.ts:1704

directStreaming

directStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.directStreaming
- Defined in megalodon/src/pixelfed.ts:3092

dismissInstanceAnnouncement

dismissInstanceAnnouncement(id: string): Promise<Response<Record<never, never>>>
POST /api/v1/announcements/:id/dismiss
Parameters
- id: string
  The ID of the Announcement in the database.
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.dismissInstanceAnnouncement
- Defined in megalodon/src/pixelfed.ts:3006

dismissNotification

dismissNotification(_id: string): Promise<Response<{}>>
POST /api/v1/notifications/:id/dismiss
Parameters
- _id: string
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.dismissNotification
- Defined in megalodon/src/pixelfed.ts:2723

dismissNotifications

dismissNotifications(): Promise<Response<{}>>
POST /api/v1/notifications/clear

Returns Promise<Response<{}>>
Implementation of MegalodonInterface.dismissNotifications
- Defined in megalodon/src/pixelfed.ts:2711

editStatus

editStatus(
    id: string,
    options: {
        media_ids?: string[];
        poll?: {
            expires_in?: number;
            hide_totals?: boolean;
            multiple?: boolean;
            options?: string[];
        };
        sensitive?: boolean;
        spoiler_text?: string;
        status?: string;
    },
): Promise<Response<Status>>
PUT /api/v1/statuses/:id * *
Parameters
- id: string
  The target status id. *
- options: {
      media_ids?: string[];
      poll?: {
          expires_in?: number;
          hide_totals?: boolean;
          multiple?: boolean;
          options?: string[];
      };
      sensitive?: boolean;
      spoiler_text?: string;
      status?: string;
  }
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.editStatus
- Defined in megalodon/src/pixelfed.ts:1634

favouriteStatus

favouriteStatus(id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/favourite
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.favouriteStatus
- Defined in megalodon/src/pixelfed.ts:1796

fetchAccessToken

fetchAccessToken(
    client_id: null | string,
    client_secret: string,
    code: string,
    redirect_uri?: string,
): Promise<TokenData>
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
  will be generated by #createApp or #registerApp
- client_secret: string
  will be generated by #createApp or #registerApp
- code: string
  will be generated by the link of #generateAuthUrl or #registerApp
- redirect_uri: string = NO_REDIRECT
  must be the same uri as the time when you register your OAuth application
Returns Promise<TokenData>
Implementation of MegalodonInterface.fetchAccessToken
- Defined in megalodon/src/pixelfed.ts:150

followAccount

followAccount(
id: string,
options?: { reblog?: boolean },
): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/follow
Parameters
- id: string
  The account ID.
- Optionaloptions: { reblog?: boolean }
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.followAccount
- Defined in megalodon/src/pixelfed.ts:611

followTag

followTag(id: string): Promise<Response<Tag>>
POST /api/v1/tags/:id/follow
Parameters
- id: string
  Target hashtag id.
Returns Promise<Response<Tag>>
Tag
Implementation of MegalodonInterface.followTag
- Defined in megalodon/src/pixelfed.ts:1480

generateAuthUrl

generateAuthUrl(
    clientId: string,
    clientSecret: string,
    options: Partial<{ redirect_uri: string | null; scope: string[] }>,
): Promise<string>
Generate authorization url using OAuth2.
Parameters
- clientId: string
  your OAuth app's client ID
- clientSecret: string
  your OAuth app's client Secret
- options: Partial<{ redirect_uri: string | null; scope: string[] }>
  as property, redirect_uri and scope are available, and must be the same as when you register your app
Returns Promise<string>
- Defined in megalodon/src/pixelfed.ts:102

getAccount

getAccount(id: string): Promise<Response<Account>>
GET /api/v1/accounts/:id
Parameters
- id: string
  The account ID.
Returns Promise<Response<Account>>
An account.
Implementation of MegalodonInterface.getAccount
- Defined in megalodon/src/pixelfed.ts:340

getAccountFavourites

getAccountFavourites(
_id: string,
_options?: { limit?: number; max_id?: string; since_id?: string },
): Promise<Response<Status[]>>
Favourites timeline of any user.
Parameters
- _id: string
- Optional_options: { limit?: number; max_id?: string; since_id?: string }
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getAccountFavourites
- Defined in megalodon/src/pixelfed.ts:425

getAccountFollowers

getAccountFollowers(
    id: string,
    options?: {
        get_all?: boolean;
        limit?: number;
        max_id?: string;
        since_id?: string;
        sleep_ms?: number;
    },
): Promise<Response<Account[]>>
GET /api/v1/accounts/:id/followers
Parameters
- id: string
  The account ID.
- Optionaloptions: {
      get_all?: boolean;
      limit?: number;
      max_id?: string;
      since_id?: string;
      sleep_ms?: number;
  }
  - Optionalget_all?: boolean
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
  - Optionalsleep_ms?: number
Returns Promise<Response<Account[]>>
The array of accounts.
Implementation of MegalodonInterface.getAccountFollowers
- Defined in megalodon/src/pixelfed.ts:482

getAccountFollowing

getAccountFollowing(
    id: string,
    options?: {
        get_all?: boolean;
        limit?: number;
        max_id?: string;
        since_id?: string;
        sleep_ms?: number;
    },
): Promise<Response<Account[]>>
GET /api/v1/accounts/:id/following
Parameters
- id: string
  The account ID.
- Optionaloptions: {
      get_all?: boolean;
      limit?: number;
      max_id?: string;
      since_id?: string;
      sleep_ms?: number;
  }
  - Optionalget_all?: boolean
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
  - Optionalsleep_ms?: number
Returns Promise<Response<Account[]>>
The array of accounts.
Implementation of MegalodonInterface.getAccountFollowing
- Defined in megalodon/src/pixelfed.ts:522

getAccountLists

getAccountLists(_id: string): Promise<Response<List[]>>
GET /api/v1/accounts/:id/lists
Parameters
- _id: string
Returns Promise<Response<List[]>>
The array of lists.
Implementation of MegalodonInterface.getAccountLists
- Defined in megalodon/src/pixelfed.ts:584

getAccountsInList

getAccountsInList(
_id: string,
_options?: { limit?: number; max_id?: string; since_id?: string },
): Promise<Response<Account[]>>
GET /api/v1/lists/:id/accounts
Parameters
- _id: string
- Optional_options: { limit?: number; max_id?: string; since_id?: string }
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getAccountsInList
- Defined in megalodon/src/pixelfed.ts:2537

getAccountStatuses

getAccountStatuses(
    id: string,
    options?: {
        exclude_reblogs?: boolean;
        exclude_replies?: boolean;
        limit?: number;
        max_id?: string;
        min_id?: string;
        only_media: boolean;
        pinned?: boolean;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/accounts/:id/statuses
Parameters
- id: string
  The account ID.
- Optionaloptions: {
      exclude_reblogs?: boolean;
      exclude_replies?: boolean;
      limit?: number;
      max_id?: string;
      min_id?: string;
      only_media: boolean;
      pinned?: boolean;
      since_id?: string;
  }
  - Optionalexclude_reblogs?: boolean
    Return statuses which exclude reblogs.
  - Optionalexclude_replies?: boolean
    Return statuses which exclude replies.
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results newer than ID.
  - only_media: boolean
    Show only statuses with media attached? Defaults to false.
  - Optionalpinned?: boolean
    Return statuses which include pinned statuses.
  - Optionalsince_id?: string
    Return results newer than ID but starting with most recent.
Returns Promise<Response<Status[]>>
Account's statuses.
Implementation of MegalodonInterface.getAccountStatuses
- Defined in megalodon/src/pixelfed.ts:362

getBlocks

getBlocks(
options?: { limit?: number; max_id?: string; min_id?: string },
): Promise<Response<Account[]>>
GET /api/v1/blocks
Parameters
- Optionaloptions: { limit?: number; max_id?: string; min_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getBlocks
- Defined in megalodon/src/pixelfed.ts:980

getBookmarks

getBookmarks(
    options?: {
        limit?: number;
        max_id?: string;
        min_id?: string;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/bookmarks
Parameters
- Optionaloptions: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getBookmarks
- Defined in megalodon/src/pixelfed.ts:858

getConversationTimeline

getConversationTimeline(
    options?: {
        limit?: number;
        max_id?: string;
        min_id?: string;
        since_id?: string;
    },
): Promise<Response<Conversation[]>>
GET /api/v1/conversations
Parameters
- Optionaloptions: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Conversation[]>>
Array of statuses.
Implementation of MegalodonInterface.getConversationTimeline
- Defined in megalodon/src/pixelfed.ts:2400

getDomainBlocks

getDomainBlocks(
options?: { limit?: number; max_id?: string; min_id?: string },
): Promise<Response<string[]>>
GET /api/v1/domain_blocks
Parameters
- Optionaloptions: { limit?: number; max_id?: string; min_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
Returns Promise<Response<string[]>>
Array of domain name.
Implementation of MegalodonInterface.getDomainBlocks
- Defined in megalodon/src/pixelfed.ts:1017

getEmojiReaction

getEmojiReaction(_id: string, _emoji: string): Promise<Response<Reaction>>
Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji.
Parameters
- _id: string
- _emoji: string
Returns Promise<Response<Reaction>>
Reaction.
Implementation of MegalodonInterface.getEmojiReaction
- Defined in megalodon/src/pixelfed.ts:3054

getEmojiReactions

getEmojiReactions(_id: string): Promise<Response<Reaction[]>>
Get an object of emoji to account mappings with accounts that reacted to the post.
Parameters
- _id: string
Returns Promise<Response<Reaction[]>>
Array of reaction.
Implementation of MegalodonInterface.getEmojiReactions
- Defined in megalodon/src/pixelfed.ts:3047

getEndorsements

getEndorsements(
options?: { limit?: number; max_id?: string; since_id?: string },
): Promise<Response<Account[]>>
GET /api/v1/endorsements
Parameters
- Optionaloptions: { limit?: number; max_id?: string; since_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getEndorsements
- Defined in megalodon/src/pixelfed.ts:1330

getFavourites

getFavourites(
options?: { limit?: number; max_id?: string; min_id?: string },
): Promise<Response<Status[]>>
GET /api/v1/favourites
Parameters
- Optionaloptions: { limit?: number; max_id?: string; min_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getFavourites
- Defined in megalodon/src/pixelfed.ts:906

getFeaturedTags

getFeaturedTags(): Promise<Response<FeaturedTag[]>>
GET /api/v1/featured_tags

Returns Promise<Response<FeaturedTag[]>>
Array of featured tag.
Implementation of MegalodonInterface.getFeaturedTags
- Defined in megalodon/src/pixelfed.ts:1364

getFilter

getFilter(id: string): Promise<Response<Filter>>
GET /api/v1/filters/:id
Parameters
- id: string
  The filter ID.
Returns Promise<Response<Filter>>
Filter.
Implementation of MegalodonInterface.getFilter
- Defined in megalodon/src/pixelfed.ts:1083

getFilters

getFilters(): Promise<Response<Filter[]>>
GET /api/v1/filters

Returns Promise<Response<Filter[]>>
Array of filters.
Implementation of MegalodonInterface.getFilters
- Defined in megalodon/src/pixelfed.ts:1069

getFollowedTags

getFollowedTags(): Promise<Response<Tag[]>>
GET /api/v1/followed_tags

Returns Promise<Response<Tag[]>>
Array of Tag.
Implementation of MegalodonInterface.getFollowedTags
- Defined in megalodon/src/pixelfed.ts:1433

getFollowRequests

getFollowRequests(limit?: number): Promise<Response<Account[]>>
GET /api/v1/follow_requests
Parameters
- Optionallimit: number
  Maximum number of results.
Returns Promise<Response<Account[]>>
Array of account.
Implementation of MegalodonInterface.getFollowRequests
- Defined in megalodon/src/pixelfed.ts:1271

getHomeTimeline

getHomeTimeline(
    options?: {
        limit?: number;
        local?: boolean;
        max_id?: string;
        min_id?: string;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/timelines/home
Parameters
- Optionaloptions: {
      limit?: number;
      local?: boolean;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionallocal?: boolean
    Show only local statuses? Defaults to false.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getHomeTimeline
- Defined in megalodon/src/pixelfed.ts:2321

getIdentityProof

getIdentityProof(_id: string): Promise<Response<IdentityProof[]>>
GET /api/v1/accounts/:id/identity_proofs
Parameters
- _id: string
Returns Promise<Response<IdentityProof[]>>
Array of IdentityProof
Implementation of MegalodonInterface.getIdentityProof
- Defined in megalodon/src/pixelfed.ts:597

getInstance

getInstance(): Promise<Response<Instance>>
GET /api/v1/instance

Returns Promise<Response<Instance>>
Implementation of MegalodonInterface.getInstance
- Defined in megalodon/src/pixelfed.ts:2898

getInstanceActivity

getInstanceActivity(): Promise<Response<Activity[]>>
GET /api/v1/instance/activity

Returns Promise<Response<Activity[]>>
Implementation of MegalodonInterface.getInstanceActivity
- Defined in megalodon/src/pixelfed.ts:2916

getInstanceAnnouncements

getInstanceAnnouncements(): Promise<Response<Announcement[]>>
GET /api/v1/announcements

Returns Promise<Response<Announcement[]>>
Array of announcements.
Implementation of MegalodonInterface.getInstanceAnnouncements
- Defined in megalodon/src/pixelfed.ts:2993

getInstanceCustomEmojis

getInstanceCustomEmojis(): Promise<Response<Emoji[]>>
GET /api/v1/custom_emojis

Returns Promise<Response<Emoji[]>>
Array of emojis.
Implementation of MegalodonInterface.getInstanceCustomEmojis
- Defined in megalodon/src/pixelfed.ts:2977

getInstanceDirectory

getInstanceDirectory(
    _options?: {
        limit?: number;
        local?: boolean;
        offset?: number;
        order?: "active" | "new";
    },
): Promise<Response<Account[]>>
GET /api/v1/directory
Parameters
- Optional_options: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getInstanceDirectory
- Defined in megalodon/src/pixelfed.ts:2957

getInstancePeers

getInstancePeers(): Promise<Response<string[]>>
GET /api/v1/instance/peers

Returns Promise<Response<string[]>>
Implementation of MegalodonInterface.getInstancePeers
- Defined in megalodon/src/pixelfed.ts:2909

getInstanceTrends

getInstanceTrends(limit?: null | number): Promise<Response<Tag[]>>
GET /api/v1/trends
Parameters
- Optionallimit: null | number
  Maximum number of results to return. Defaults to 10.
Returns Promise<Response<Tag[]>>
Implementation of MegalodonInterface.getInstanceTrends
- Defined in megalodon/src/pixelfed.ts:2931

getList

getList(_id: string): Promise<Response<List>>
GET /api/v1/lists/:id
Parameters
- _id: string
Returns Promise<Response<List>>
List.
Implementation of MegalodonInterface.getList
- Defined in megalodon/src/pixelfed.ts:2481

getLists

getLists(): Promise<Response<List[]>>
GET /api/v1/lists

Returns Promise<Response<List[]>>
Array of lists.
Implementation of MegalodonInterface.getLists
- Defined in megalodon/src/pixelfed.ts:2467

getListTimeline

getListTimeline(
    _list_id: string,
    _options?: {
        limit?: number;
        max_id?: string;
        min_id?: string;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/timelines/list/:list_id
Parameters
- _list_id: string
- Optional_options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getListTimeline
- Defined in megalodon/src/pixelfed.ts:2373

getLocalTimeline

getLocalTimeline(
    options?: {
        limit?: number;
        max_id?: string;
        min_id?: string;
        only_media?: boolean;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/timelines/public
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      only_media?: boolean;
      since_id?: string;
  }
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalonly_media?: boolean
    Show only statuses with media attached? Defaults to false.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getLocalTimeline
- Defined in megalodon/src/pixelfed.ts:2204

getMarkers

getMarkers(timeline: string[]): Promise<Response<Marker | Record<never, never>>>
GET /api/v1/markers
Parameters
- timeline: string[]
Returns Promise<Response<Marker | Record<never, never>>>
Marker or empty object.
Implementation of MegalodonInterface.getMarkers
- Defined in megalodon/src/pixelfed.ts:2586

getMedia

getMedia(id: string): Promise<Response<Attachment>>
GET /api/v1/media/:id
Parameters
- id: string
  Target media ID.
Returns Promise<Response<Attachment>>
Attachment
Implementation of MegalodonInterface.getMedia
- Defined in megalodon/src/pixelfed.ts:1963

getMutes

getMutes(
options?: { limit?: number; max_id?: string; min_id?: string },
): Promise<Response<Account[]>>
GET /api/v1/mutes
Parameters
- Optionaloptions: { limit?: number; max_id?: string; min_id?: string }
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getMutes
- Defined in megalodon/src/pixelfed.ts:943

getNotification

getNotification(_id: string): Promise<Response<Notification>>
GET /api/v1/notifications/:id
Parameters
- _id: string
Returns Promise<Response<Notification>>
Notification.
Implementation of MegalodonInterface.getNotification
- Defined in megalodon/src/pixelfed.ts:2701

getNotifications

getNotifications(
    options?: {
        account_id?: string;
        exclude_types?: string[];
        limit?: number;
        max_id?: string;
        min_id?: string;
        since_id?: string;
    },
): Promise<Response<Notification[]>>
GET /api/v1/notifications
Parameters
- Optionaloptions: {
      account_id?: string;
      exclude_types?: string[];
      limit?: number;
      max_id?: string;
      min_id?: string;
      since_id?: string;
  }
  - Optionalaccount_id?: string
    Return only notifications received from this account.
  - Optionalexclude_types?: string[]
    Array of types to exclude.
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Notification[]>>
Array of notifications.
Implementation of MegalodonInterface.getNotifications
- Defined in megalodon/src/pixelfed.ts:2643

getPoll

getPoll(id: string): Promise<Response<Poll>>
GET /api/v1/polls/:id
Parameters
- id: string
  Target poll ID.
Returns Promise<Response<Poll>>
Poll
Implementation of MegalodonInterface.getPoll
- Defined in megalodon/src/pixelfed.ts:2017

getPreferences

getPreferences(): Promise<Response<Preferences>>
GET /api/v1/preferences

Returns Promise<Response<Preferences>>
Preferences.
Implementation of MegalodonInterface.getPreferences
- Defined in megalodon/src/pixelfed.ts:1417

getPublicTimeline

getPublicTimeline(
    options?: {
        limit?: number;
        max_id?: string;
        min_id?: string;
        only_media?: boolean;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/timelines/public
Parameters
- Optionaloptions: {
      limit?: number;
      max_id?: string;
      min_id?: string;
      only_media?: boolean;
      since_id?: string;
  }
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalonly_media?: boolean
    Show only statuses with media attached? Defaults to false.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getPublicTimeline
- Defined in megalodon/src/pixelfed.ts:2149

getPushSubscription

getPushSubscription(): Promise<Response<PushSubscription>>
GET /api/v1/push/subscription

Returns Promise<Response<PushSubscription>>
PushSubscription.
Implementation of MegalodonInterface.getPushSubscription
- Defined in megalodon/src/pixelfed.ts:2768

getRelationship

getRelationship(id: string): Promise<Response<Relationship>>
GET /api/v1/accounts/relationships
Parameters
- id: string
  The account ID.
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.getRelationship
- Defined in megalodon/src/pixelfed.ts:748

getRelationships

getRelationships(ids: string[]): Promise<Response<Relationship[]>>
GET /api/v1/accounts/relationships
Parameters
- ids: string[]
  Array of account IDs.
Returns Promise<Response<Relationship[]>>
Array of Relationship.
Implementation of MegalodonInterface.getRelationships
- Defined in megalodon/src/pixelfed.ts:766

getScheduledStatus

getScheduledStatus(id: string): Promise<Response<ScheduledStatus>>
GET /api/v1/scheduled_statuses/:id
Parameters
- id: string
  Target status ID.
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
Implementation of MegalodonInterface.getScheduledStatus
- Defined in megalodon/src/pixelfed.ts:2098

getScheduledStatuses

getScheduledStatuses(
    options?: {
        limit?: null | number;
        max_id?: null | string;
        min_id?: null | string;
        since_id?: null | string;
    },
): Promise<Response<ScheduledStatus[]>>
GET /api/v1/scheduled_statuses
Parameters
- Optionaloptions: {
      limit?: null | number;
      max_id?: null | string;
      min_id?: null | string;
      since_id?: null | string;
  }
  - Optionallimit?: null | number
    Max number of results to return. Defaults to 20.
  - Optionalmax_id?: null | string
    Return results older than ID.
  - Optionalmin_id?: null | string
    Return results immediately newer than ID.
  - Optionalsince_id?: null | string
    Return results newer than ID.
Returns Promise<Response<ScheduledStatus[]>>
Array of scheduled statuses.
Implementation of MegalodonInterface.getScheduledStatuses
- Defined in megalodon/src/pixelfed.ts:2056

getStatus

getStatus(id: string): Promise<Response<Status>>
GET /api/v1/statuses/:id
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.getStatus
- Defined in megalodon/src/pixelfed.ts:1620

getStatusContext

getStatusContext(
id: string,
options?: { limit?: number; max_id?: string; since_id?: string },
): Promise<Response<Context>>
GET /api/v1/statuses/:id/context

Get parent and child statuses.
Parameters
- id: string
  The target status id.
- Optionaloptions: { limit?: number; max_id?: string; since_id?: string }
Returns Promise<Response<Context>>
Context
Implementation of MegalodonInterface.getStatusContext
- Defined in megalodon/src/pixelfed.ts:1719

getStatusFavouritedBy

getStatusFavouritedBy(id: string): Promise<Response<Account[]>>
GET /api/v1/statuses/:id/favourited_by
Parameters
- id: string
  The target status id.
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getStatusFavouritedBy
- Defined in megalodon/src/pixelfed.ts:1782

getStatusRebloggedBy

getStatusRebloggedBy(id: string): Promise<Response<Account[]>>
GET /api/v1/statuses/:id/reblogged_by
Parameters
- id: string
  The target status id.
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getStatusRebloggedBy
- Defined in megalodon/src/pixelfed.ts:1768

getStatusSource

getStatusSource(_id: string): Promise<Response<StatusSource>>
GET /api/v1/statuses/:id/source

Obtain the source properties for a status so that it can be edited.
Parameters
- _id: string
Returns Promise<Response<StatusSource>>
StatusSource
Implementation of MegalodonInterface.getStatusSource
- Defined in megalodon/src/pixelfed.ts:1755

getSuggestedTags

getSuggestedTags(): Promise<Response<Tag[]>>
GET /api/v1/featured_tags/suggestions

Returns Promise<Response<Tag[]>>
Array of tag.
Implementation of MegalodonInterface.getSuggestedTags
- Defined in megalodon/src/pixelfed.ts:1402

getSuggestions

getSuggestions(_limit?: number): Promise<Response<Account[]>>
GET /api/v1/suggestions
Parameters
- Optional_limit: number
Returns Promise<Response<Account[]>>
Array of accounts.
Implementation of MegalodonInterface.getSuggestions
- Defined in megalodon/src/pixelfed.ts:1450

getTag

getTag(id: string): Promise<Response<Tag>>
GET /api/v1/tags/:id
Parameters
- id: string
  Target hashtag id.
Returns Promise<Response<Tag>>
Tag
Implementation of MegalodonInterface.getTag
- Defined in megalodon/src/pixelfed.ts:1466

getTagTimeline

getTagTimeline(
    hashtag: string,
    options?: {
        limit?: number;
        local?: boolean;
        max_id?: string;
        min_id?: string;
        only_media?: boolean;
        since_id?: string;
    },
): Promise<Response<Status[]>>
GET /api/v1/timelines/tag/:hashtag
Parameters
- hashtag: string
  Content of a #hashtag, not including # symbol.
- Optionaloptions: {
      limit?: number;
      local?: boolean;
      max_id?: string;
      min_id?: string;
      only_media?: boolean;
      since_id?: string;
  }
  - Optionallimit?: number
    Max number of results to return. Defaults to 20.
  - Optionallocal?: boolean
    Show only local statuses? Defaults to false.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalmin_id?: string
    Return results immediately newer than ID.
  - Optionalonly_media?: boolean
    Show only statuses with media attached? Defaults to false.
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Status[]>>
Array of statuses.
Implementation of MegalodonInterface.getTagTimeline
- Defined in megalodon/src/pixelfed.ts:2260

listStreaming

listStreaming(_list_id: string): Promise<WebSocketInterface>
Parameters
- _list_id: string
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.listStreaming
- Defined in megalodon/src/pixelfed.ts:3088

localStreaming

localStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.localStreaming
- Defined in megalodon/src/pixelfed.ts:3080

lookupAccount

lookupAccount(_acct: string): Promise<Response<Account>>
GET /api/v1/accounts/lookup
Parameters
- _acct: string
Returns Promise<Response<Account>>
Account.
Implementation of MegalodonInterface.lookupAccount
- Defined in megalodon/src/pixelfed.ts:838

muteAccount

muteAccount(
id: string,
notifications?: boolean,
): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/mute
Parameters
- id: string
  The account ID.
- notifications: boolean = true
  Mute notifications in addition to statuses.
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.muteAccount
- Defined in megalodon/src/pixelfed.ts:676

muteStatus

muteStatus(_id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/mute
Parameters
- _id: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.muteStatus
- Defined in megalodon/src/pixelfed.ts:1880

pinAccount

pinAccount(_id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/pin
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.pinAccount
- Defined in megalodon/src/pixelfed.ts:708

pinStatus

pinStatus(_id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/pin
Parameters
- _id: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.pinStatus
- Defined in megalodon/src/pixelfed.ts:1905

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?: StatusVisibility;
    },
): Promise<Response<Status | ScheduledStatus>>
POST /api/v1/statuses
Parameters
- status: string
  Text content of status.
- 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?: StatusVisibility;
  }
  - Optionalin_reply_to_id?: string
    ID of the status being replied to, if status is a reply.
  - Optionallanguage?: string
    ISO 639 language code for this status.
  - Optionalmedia_ids?: string[]
    Array of Attachment ids.
  - Optionalpoll?: {
        expires_in: number;
        hide_totals?: boolean;
        multiple?: boolean;
        options: string[];
    }
    Poll object.
  - Optionalquote_id?: string
    ID of the status being quoted to, if status is a quote.
  - Optionalscheduled_at?: string
    ISO 8601 Datetime at which to schedule a status.
  - Optionalsensitive?: boolean
    Mark status and attached media as sensitive?
  - Optionalspoiler_text?: string
    Text to be shown as a warning or subject before the actual content.
  - Optionalvisibility?: StatusVisibility
    Visibility of the posted status.
Returns Promise<Response<Status | ScheduledStatus>>
Status. When options.scheduled_at is present, ScheduledStatus is returned instead.
Implementation of MegalodonInterface.postStatus
- Defined in megalodon/src/pixelfed.ts:1520

publicStreaming

publicStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.publicStreaming
- Defined in megalodon/src/pixelfed.ts:3076

readConversation

readConversation(id: string): Promise<Response<Conversation>>
POST /api/v1/conversations/:id/read
Parameters
- id: string
  Target conversation ID.
Returns Promise<Response<Conversation>>
Conversation.
Implementation of MegalodonInterface.readConversation
- Defined in megalodon/src/pixelfed.ts:2451

readNotifications

readNotifications(
_options: { id?: string; max_id?: string },
): Promise<Response<{}>>
Mark as read all unread notifications.
Parameters
- _options: { id?: string; max_id?: string }
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.readNotifications
- Defined in megalodon/src/pixelfed.ts:2730

reblogStatus

reblogStatus(id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/reblog
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.reblogStatus
- Defined in megalodon/src/pixelfed.ts:1824

refreshToken

refreshToken(
    client_id: string,
    client_secret: string,
    refresh_token: string,
): Promise<TokenData>
POST /oauth/token

Revoke an OAuth token.
Parameters
- client_id: string
  will be generated by #createApp or #registerApp
- client_secret: string
  will be generated by #createApp or #registerApp
- refresh_token: string
Returns Promise<TokenData>
Implementation of MegalodonInterface.refreshToken
- Defined in megalodon/src/pixelfed.ts:178

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
  Username for the account.
- email: string
  Email for the account.
- password: string
  Password for the account.
- agreement: boolean
  Whether the user agrees to the local rules, terms, and policies.
- locale: string
  The language of the confirmation email that will be sent
- Optionalreason: null | string
  Text that will be reviewed by moderators if registrations require manual approval.
Returns Promise<Response<Token>>
An account token.
Implementation of MegalodonInterface.registerAccount
- Defined in megalodon/src/pixelfed.ts:219

registerApp

registerApp(
    client_name: string,
    options: Partial<
        { redirect_uris: string; scopes: string[]; website: string },
    >,
): Promise<AppData>
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>
Implementation of MegalodonInterface.registerApp
- Defined in megalodon/src/pixelfed.ts:48

rejectFollowRequest

rejectFollowRequest(id: string): Promise<Response<Relationship>>
POST /api/v1/follow_requests/:id/reject
Parameters
- id: string
  Target account ID.
Returns Promise<Response<Relationship>>
Relationship.
Implementation of MegalodonInterface.rejectFollowRequest
- Defined in megalodon/src/pixelfed.ts:1311

removeReactionFromAnnouncement

removeReactionFromAnnouncement(
id: string,
name: string,
): Promise<Response<Record<never, never>>>
DELETE /api/v1/announcements/:id/reactions/:name
Parameters
- id: string
  The ID of the Announcement in the database.
- name: string
  Unicode emoji, or the shortcode of a custom emoji.
Returns Promise<Response<Record<never, never>>>
Implementation of MegalodonInterface.removeReactionFromAnnouncement
- Defined in megalodon/src/pixelfed.ts:3026

report

report(
    account_id: string,
    options?: {
        category?: Category;
        comment: string;
        forward?: boolean;
        rule_ids?: number[];
        status_ids?: string[];
    },
): Promise<Response<Report>>
POST /api/v1/reports
Parameters
- account_id: string
  Target account ID.
- Optionaloptions: {
      category?: Category;
      comment: string;
      forward?: boolean;
      rule_ids?: number[];
      status_ids?: string[];
  }
  - Optionalcategory?: Category
    Specify if the report is due to spam, violation of enumerated instance rules, or some other reason. Defaults to other. Will be set to violation if rule_ids[] is provided (regardless of any category value you provide).
  - comment: string
    The reason for the report. Default maximum of 1000 characters.
  - Optionalforward?: boolean
    If the account is remote, should the report be forwarded to the remote admin?
  - Optionalrule_ids?: number[]
    For violation category reports, specify the ID of the exact rules broken. Rules and their IDs are available via GET /api/v1/instance/rules and GET /api/v1/instance.
  - Optionalstatus_ids?: string[]
    Array of Statuses ids to attach to the report.
Returns Promise<Response<Report>>
Report
Implementation of MegalodonInterface.report
- Defined in megalodon/src/pixelfed.ts:1215

revokeToken

revokeToken(
    client_id: string,
    client_secret: string,
    token: string,
): Promise<Response<{}>>
POST /oauth/revoke

Revoke an OAuth token.
Parameters
- client_id: string
  will be generated by #createApp or #registerApp
- client_secret: string
  will be generated by #createApp or #registerApp
- token: string
  will be get #fetchAccessToken
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.revokeToken
- Defined in megalodon/src/pixelfed.ts:197

saveMarkers

saveMarkers(
    options?: {
        home?: { last_read_id: string };
        notifications?: { last_read_id: string };
    },
): Promise<Response<Marker>>
POST /api/v1/markers
Parameters
- Optionaloptions: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }
  - Optionalhome?: { last_read_id: string }
    Marker position of the last read status ID in home timeline.
  - Optionalnotifications?: { last_read_id: string }
    Marker position of the last read notification ID in notifications.
Returns Promise<Response<Marker>>
Marker.
Implementation of MegalodonInterface.saveMarkers
- Defined in megalodon/src/pixelfed.ts:2605

scheduleStatus

scheduleStatus(
id: string,
scheduled_at?: null | string,
): Promise<Response<ScheduledStatus>>
PUT /api/v1/scheduled_statuses/:id
Parameters
- id: string
  Target scheduled status ID.
- Optionalscheduled_at: null | string
  ISO 8601 Datetime at which the status will be published.
Returns Promise<Response<ScheduledStatus>>
ScheduledStatus.
Implementation of MegalodonInterface.scheduleStatus
- Defined in megalodon/src/pixelfed.ts:2113

search

search(
    q: string,
    options?: {
        account_id?: string;
        exclude_unreviewed?: boolean;
        following?: boolean;
        limit?: number;
        max_id?: string;
        min_id?: string;
        offset?: number;
        resolve?: boolean;
        type?: "accounts" | "hashtags" | "statuses";
    },
): Promise<Response<Results>>
GET /api/v2/search
Parameters
- q: string
  The search query.
- Optionaloptions: {
      account_id?: string;
      exclude_unreviewed?: boolean;
      following?: boolean;
      limit?: number;
      max_id?: string;
      min_id?: string;
      offset?: number;
      resolve?: boolean;
      type?: "accounts" | "hashtags" | "statuses";
  }
  - Optionalaccount_id?: string
    If provided, statuses returned will be authored only by this account.
  - Optionalexclude_unreviewed?: boolean
    Filter out unreviewed tags? Defaults to false.
  - Optionalfollowing?: boolean
    Only include accounts that the user is following. Defaults to false.
  - Optionallimit?: number
    Maximum number of results to load, per type. Defaults to 20. Max 40.
  - Optionalmax_id?: string
    Return results older than this id.
  - Optionalmin_id?: string
    Return results immediately newer than this id.
  - Optionaloffset?: number
  - Optionalresolve?: boolean
    Attempt WebFinger lookup. Defaults to false.
  - Optionaltype?: "accounts" | "hashtags" | "statuses"
Returns Promise<Response<Results>>
Results.
Implementation of MegalodonInterface.search
- Defined in megalodon/src/pixelfed.ts:2821

searchAccount

searchAccount(
    q: string,
    options?: {
        following?: boolean;
        limit?: number;
        max_id?: string;
        resolve?: boolean;
        since_id?: string;
    },
): Promise<Response<Account[]>>
GET /api/v1/accounts/search
Parameters
- q: string
  Search query.
- Optionaloptions: {
      following?: boolean;
      limit?: number;
      max_id?: string;
      resolve?: boolean;
      since_id?: string;
  }
  - Optionalfollowing?: boolean
  - Optionallimit?: number
    Max number of results to return. Defaults to 40.
  - Optionalmax_id?: string
    Return results older than ID.
  - Optionalresolve?: boolean
  - Optionalsince_id?: string
    Return results newer than ID.
Returns Promise<Response<Account[]>>
The array of accounts.
Implementation of MegalodonInterface.searchAccount
- Defined in megalodon/src/pixelfed.ts:787

setAccountNote

setAccountNote(_id: string, _note?: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/note
Parameters
- _id: string
- Optional_note: string
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.setAccountNote
- Defined in megalodon/src/pixelfed.ts:735

streamingURL

streamingURL(): Promise<string>
Returns Promise<string>
Implementation of MegalodonInterface.streamingURL
- Defined in megalodon/src/pixelfed.ts:3064

subscribeAccount

subscribeAccount(id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/follow
Parameters
- id: string
  Target account ID.
Returns Promise<Response<Relationship>>
Relationship.
Implementation of MegalodonInterface.subscribeAccount
- Defined in megalodon/src/pixelfed.ts:445

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 } }
- Optional_data:
      | null
      | {
          alerts: {
              favourite?: boolean;
              follow?: boolean;
              mention?: boolean;
              poll?: boolean;
              reblog?: boolean;
          };
      }
Returns Promise<Response<PushSubscription>>
PushSubscription.
Implementation of MegalodonInterface.subscribePushNotification
- Defined in megalodon/src/pixelfed.ts:2753

tagStreaming

tagStreaming(_tag: string): Promise<WebSocketInterface>
Parameters
- _tag: string
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.tagStreaming
- Defined in megalodon/src/pixelfed.ts:3084

unblockAccount

unblockAccount(id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/unblock
Parameters
- id: string
  The account ID.
Returns Promise<Response<Relationship>>
RElationship
Implementation of MegalodonInterface.unblockAccount
- Defined in megalodon/src/pixelfed.ts:661

unblockDomain

unblockDomain(domain: string): Promise<Response<{}>>
DELETE /api/v1/domain_blocks
Parameters
- domain: string
  Domain to unblock
Returns Promise<Response<{}>>
Implementation of MegalodonInterface.unblockDomain
- Defined in megalodon/src/pixelfed.ts:1055

unbookmarkStatus

unbookmarkStatus(id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/unbookmark
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.unbookmarkStatus
- Defined in megalodon/src/pixelfed.ts:1866

unfavouriteStatus

unfavouriteStatus(id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/unfavourite
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.unfavouriteStatus
- Defined in megalodon/src/pixelfed.ts:1810

unfollowAccount

unfollowAccount(id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/unfollow
Parameters
- id: string
  The account ID.
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.unfollowAccount
- Defined in megalodon/src/pixelfed.ts:633

unfollowTag

unfollowTag(id: string): Promise<Response<Tag>>
POST /api/v1/tags/:id/unfollow
Parameters
- id: string
  Target hashtag id.
Returns Promise<Response<Tag>>
Tag
Implementation of MegalodonInterface.unfollowTag
- Defined in megalodon/src/pixelfed.ts:1494

unmuteAccount

unmuteAccount(id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/unmute
Parameters
- id: string
  The account ID.
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.unmuteAccount
- Defined in megalodon/src/pixelfed.ts:694

unmuteStatus

unmuteStatus(_id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/unmute
Parameters
- _id: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.unmuteStatus
- Defined in megalodon/src/pixelfed.ts:1893

unpinAccount

unpinAccount(_id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/unpin
Parameters
- _id: string
Returns Promise<Response<Relationship>>
Relationship
Implementation of MegalodonInterface.unpinAccount
- Defined in megalodon/src/pixelfed.ts:721

unpinStatus

unpinStatus(_id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/unpin
Parameters
- _id: string
Returns Promise<Response<Status>>
Status
Implementation of MegalodonInterface.unpinStatus
- Defined in megalodon/src/pixelfed.ts:1918

unreblogStatus

unreblogStatus(id: string): Promise<Response<Status>>
POST /api/v1/statuses/:id/unreblog
Parameters
- id: string
  The target status id.
Returns Promise<Response<Status>>
Status.
Implementation of MegalodonInterface.unreblogStatus
- Defined in megalodon/src/pixelfed.ts:1838

unsubscribeAccount

unsubscribeAccount(id: string): Promise<Response<Relationship>>
POST /api/v1/accounts/:id/follow
Parameters
- id: string
  Target account ID.
Returns Promise<Response<Relationship>>
Relationship.
Implementation of MegalodonInterface.unsubscribeAccount
- Defined in megalodon/src/pixelfed.ts:462

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?: { language?: string; privacy?: string; sensitive?: boolean };
    },
): Promise<Response<Account>>
PATCH /api/v1/accounts/update_credentials
Parameters
- Optionaloptions: {
      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 };
  }
Returns Promise<Response<Account>>
An account.
Implementation of MegalodonInterface.updateCredentials
- Defined in megalodon/src/pixelfed.ts:264

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
  The filter ID.
- phrase: string
  Text to be filtered.
- context: string[]
  Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
- Optionaloptions: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }
  - Optionalexpires_in?: string
    ISO 8601 Datetime for when the filter expires.
  - Optionalirreversible?: boolean
    Should the server irreversibly drop matching entities from home and notifications?
  - Optionalwhole_word?: boolean
    Consider word boundaries?
Returns Promise<Response<Filter>>
Filter
Implementation of MegalodonInterface.updateFilter
- Defined in megalodon/src/pixelfed.ts:1149

updateList

updateList(_id: string, _title: string): Promise<Response<List>>
PUT /api/v1/lists/:id
Parameters
- _id: string
- _title: string
Returns Promise<Response<List>>
List.
Implementation of MegalodonInterface.updateList
- Defined in megalodon/src/pixelfed.ts:2508

updateMedia

updateMedia(
id: string,
options?: { description?: string; file?: any; focus?: string },
): Promise<Response<Attachment>>
PUT /api/v1/media/:id
Parameters
- id: string
  Target media ID.
- Optionaloptions: { description?: string; file?: any; focus?: string }
  - Optionaldescription?: string
    A plain-text description of the media.
  - Optionalfile?: any
    The file to be attached, using multipart form data.
  - Optionalfocus?: string
    Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
Returns Promise<Response<Attachment>>
Attachment
Implementation of MegalodonInterface.updateMedia
- Defined in megalodon/src/pixelfed.ts:1981

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.
Implementation of MegalodonInterface.updatePushSubscription
- Defined in megalodon/src/pixelfed.ts:2785

uploadMedia

uploadMedia(
file: any,
options?: { description?: string; focus?: string },
): Promise<Response<Attachment | AsyncAttachment>>
POST /api/v2/media
Parameters
- file: any
  The file to be attached, using multipart form data.
- Optionaloptions: { description?: string; focus?: string }
  - Optionaldescription?: string
    A plain-text description of the media.
  - Optionalfocus?: string
    Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
Returns Promise<Response<Attachment | AsyncAttachment>>
Attachment
Implementation of MegalodonInterface.uploadMedia
- Defined in megalodon/src/pixelfed.ts:1936

userStreaming

userStreaming(): Promise<WebSocketInterface>
Returns Promise<WebSocketInterface>
Implementation of MegalodonInterface.userStreaming
- Defined in megalodon/src/pixelfed.ts:3072

verifyAccountCredentials

verifyAccountCredentials(): Promise<Response<Account>>
GET /api/v1/accounts/verify_credentials

Returns Promise<Response<Account>>
Account.
Implementation of MegalodonInterface.verifyAccountCredentials
- Defined in megalodon/src/pixelfed.ts:251

verifyAppCredentials

verifyAppCredentials(): Promise<Response<Application>>
GET /api/v1/apps/verify_credentials

Returns Promise<Response<Application>>
An Application
Implementation of MegalodonInterface.verifyAppCredentials
- Defined in megalodon/src/pixelfed.ts:133

votePoll

votePoll(id: string, choices: number[]): Promise<Response<Poll>>
POST /api/v1/polls/:id/votes
Parameters
- id: string
  Target poll ID.
- choices: number[]
  Array of own votes containing index for each option (starting from 0).
Returns Promise<Response<Poll>>
Poll
Implementation of MegalodonInterface.votePoll
- Defined in megalodon/src/pixelfed.ts:2032

Class Pixelfed

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Pixelfed

Properties

baseUrl

client

Methods

acceptFollowRequest

Parameters

Returns Promise<Response<Relationship>>

addAccountsToList

Parameters

Returns Promise<Response<{}>>

addReactionToAnnouncement

Parameters

Returns Promise<Response<Record<never, never>>>

blockAccount

Parameters

Returns Promise<Response<Relationship>>

blockDomain

Parameters

Returns Promise<Response<{}>>

bookmarkStatus

Parameters

Returns Promise<Response<Status>>

cancel

Returns void

cancelScheduledStatus

Parameters

Returns Promise<Response<{}>>

createApp

Parameters

Returns Promise<AppData>

createEmojiReaction

Parameters

Returns Promise<Response<Status>>

createFeaturedTag

Parameters

Returns Promise<Response<FeaturedTag>>

createFilter

Parameters

Optionalexpires_in?: string

Optionalirreversible?: boolean

Optionalwhole_word?: boolean

Returns Promise<Response<Filter>>

createList

Parameters

Returns Promise<Response<List>>

deleteAccountsFromList

Parameters

Returns Promise<Response<{}>>

deleteConversation

Parameters

Returns Promise<Response<{}>>

deleteEmojiReaction

Parameters

Returns Promise<Response<Status>>

deleteFeaturedTag

Parameters

Returns Promise<Response<{}>>

deleteFilter

Parameters

Returns Promise<Response<Filter>>

deleteList

Parameters

Returns Promise<Response<{}>>

deletePushSubscription

Returns Promise<Response<{}>>

deleteStatus

Parameters

Returns Promise<Response<Status>>

directStreaming

Returns Promise<WebSocketInterface>

`Optional`expires_in?: string

`Optional`irreversible?: boolean

`Optional`whole_word?: boolean

`Optional`get_all?: boolean

`Optional`limit?: number

`Optional`max_id?: string

`Optional`since_id?: string

`Optional`sleep_ms?: number

`Optional`get_all?: boolean

`Optional`limit?: number

`Optional`max_id?: string

`Optional`since_id?: string

`Optional`sleep_ms?: number

`Optional`exclude_reblogs?: boolean

`Optional`exclude_replies?: boolean

`Optional`limit?: number

`Optional`max_id?: string

`Optional`min_id?: string

`Optional`pinned?: boolean

`Optional`since_id?: string

`Optional`limit?: number

`Optional`max_id?: string

`Optional`min_id?: string