Class Nexus

constructor

• new Nexus(client): Nexus

• Parameters

  • client: Client

  Returns Nexus

Readonlyclient

accountNotifications

• accountNotifications(account, min_score?, last_id?, limit?): Promise<NexusAccountNotifications[]>

• Return array of account notification objects for the account passed.

  Returned values for type:

  • new_community - a new community was created
  • set_role - mod/admin adds a role to an account
  • set_props - properties set for a community
  • set_label - a title/badge/label has been set for an account
  • mute_post - a post has been muted, with a reason
  • unmute_post - a post has been unmuted, with a reason
  • pin_post - a post has been pinned
  • unpin_post - a post has been unpinned
  • flag_post - a post has been flagged by a member, with a reason
  • error - provides feedback to developers for ops that cannot be interpreted
  • subscribe - an account has subscribed to a community
  • reply - a post has been replied to
  • reblog - a post has been reblogged/reblogged
  • follow - an account has followed another account
  • mention - author mentions an account
  • vote - voter votes for an author

  The score value is based on the originating account’s rank.

  Parameters

  • account: string

    The account to fetch.
  • Optionalmin_score: number

    Minimum score of notification, default: 25 [optional].
  • Optionallast_id: null | number

    Last notification ID, paging mechanism [optional].
  • Optionallimit: number

    Number of results, default: 100 [optional].

  Returns Promise<NexusAccountNotifications[]>
• accountNotifications(options): Promise<NexusAccountNotifications[]>

• Parameters

  • options: NexusNotificationQuery

  Returns Promise<NexusAccountNotifications[]>

call

• call(method, params?): Promise<any>

• Convenience for calling Nexus/Bridge RPC methods directly.

  Backing JSON-RPC API namespace: bridge. Nexus responses are indexed Layer 2 views, not Layer 1 consensus objects.

  Parameters

  • method: string
  • Optionalparams: any[] | {
        [key: string]: any;
    }

  Returns Promise<any>

getAccountPosts

• getAccountPosts(sort, account, start_author?, start_permlink?, limit?, observer?): Promise<NexusPost[]>

• Return a list of posts related to a given account.

  Parameters

  • sort: NexusAccountPostSort

    Values accepted:

    • blog: top posts authored by given account (excluding posts to communities - unless explicitely reblogged) plus reblogs ranked by creation/reblog time.
    • feed: top posts from blogs of accounts that given account is following ranked by creation/reblog time, not older than last month.
    • posts: top posts authored by given account, newer first comments - replies authored by given account, newer first.
    • comments:
    • replies: replies to posts of given account, newer first.
    • payout: all posts authored by given account that were not yet cashed out.
  • account: string

    The account to fetch.
  • Optionalstart_author: null | string

    Name of author to start from, used for paging. Should be used in conjunction with start_permlink.
  • Optionalstart_permlink: null | string

    Permalink of post to start from, used for paging. Should be used in conjunction with start_author.
  • Optionallimit: number

    Number of results, default: 20, max 100.
  • Optionalobserver: null | string

    A valid account [optional].

  Returns Promise<NexusPost[]>
• getAccountPosts(options): Promise<NexusPost[]>

• Parameters

  • options: NexusAccountPostsQuery

  Returns Promise<NexusPost[]>

getCommunity

• getCommunity(name, observer?): Promise<NexusCommunityExtended>

• Return a Nexus community object.

  Backing JSON-RPC method: bridge.get_community. Includes community metadata and leadership information. When observer is provided, Nexus may also include observer-specific subscription, title and role context.

  Parameters

  • name: string

    Community account/category name.
  • Optionalobserver: null | string

    Optional observer account for viewer-specific context.

  Returns Promise<NexusCommunityExtended>
• getCommunity(options): Promise<NexusCommunityExtended>

• Parameters

  • options: NexusCommunityQuery

  Returns Promise<NexusCommunityExtended>

getCommunityContext

• getCommunityContext(name, account): Promise<NexusCommunityContext>

• For a community/account: returns role, title, subscribed state.

  Parameters

  • name: string

    The community account concerned.
  • account: string

    The account to fetch.

  Returns Promise<NexusCommunityContext>

getDiscussion

• getDiscussion(author, permlink): Promise<{
      [key: string]: NexusPost;
  }>

• Gives a flattened discussion tree starting at given post. Modified get_state thread implementation. Returns an Object whose key is "author/permlink".

  Parameters

  • author: string
  • permlink: string

  Returns Promise<{
      [key: string]: NexusPost;
  }>

getPayoutStats

• getPayoutStats(limit?): Promise<NexusPayoutStats>

• Get payout stats for building treemap.

  Parameters

  • limit: number = 250

    Number of result, default: 250 [optional].

  Returns Promise<NexusPayoutStats>

getPost

• getPost(author, permlink, observer?): Promise<NexusPost>

• Return one Nexus post view.

  Backing JSON-RPC method: bridge.get_post. Use client.condenser.getContent when you need the Layer 1 content object instead of the Nexus indexed/social view.

  Parameters

  • author: string

    Post author.
  • permlink: string

    Post permlink.
  • Optionalobserver: null | string

    Optional observer account for viewer-specific context.

  Returns Promise<NexusPost>
• getPost(options): Promise<NexusPost>

• Parameters

  • options: NexusPostQuery

  Returns Promise<NexusPost>

getPostHeader

• getPostHeader(author, permlink): Promise<null | NexusPostHeader>

• Return the lightweight Nexus post header for a post, or null when missing. Backing JSON-RPC method: bridge.get_post_header.

  Parameters

  • author: string
  • permlink: string

  Returns Promise<null | NexusPostHeader>

getProfile

• getProfile(account, observer?): Promise<NexusProfile>

• Returns a resume of a profile with metadata parsed.

  Parameters

  • account: string
  • Optionalobserver: null | string

  Returns Promise<NexusProfile>
• getProfile(options): Promise<NexusProfile>

• Parameters

  • options: NexusProfileQuery

  Returns Promise<NexusProfile>

getRankedPosts

• getRankedPosts(sort, start_author?, start_permlink?, limit?, tag?, observer?): Promise<NexusPost[]>

• Query Nexus-ranked posts.

  Backing JSON-RPC method: bridge.get_ranked_posts. This is a discovery/indexing helper. If exact chain content matters, use the returned author and permlink with client.condenser.getContent.

  Parameters

  • sort: NexusSortGetRankedPost

    Sorting of results, valid options are: 'trending', 'hot', 'created', 'promoted', 'payout', 'payout_comments', 'muted'.
  • Optionalstart_author: null | string

    Name of author to start from, used for paging. Should be used in conjunction with start_permlink [optional].
  • Optionalstart_permlink: null | string

    Permalink of post to start from, used for paging. Should be used in conjunction with start_author [optional].
  • Optionallimit: number

    Number of results, default: 20 [optional].
  • Optionaltag: null | string

    Specify a Tag [optional].
  • Optionalobserver: null | string

    A valid account [optional].

  Returns Promise<NexusPost[]>
• getRankedPosts(options): Promise<NexusPost[]>

• Parameters

  • options: NexusRankedPostsQuery

  Returns Promise<NexusPost[]>

getTrendingTopics

• getTrendingTopics(limit?, observer?): Promise<NexusCommunitySummary[]>

• Return top trending topics as [name, title] pairs. Backing JSON-RPC method: bridge.get_trending_topics.

  Parameters

  • limit: number = 10
  • observer: null | string = null

  Returns Promise<NexusCommunitySummary[]>

listAllSubscriptions

• listAllSubscriptions(account): Promise<NexusCommunitySubscription[]>

• Returns a lists of all communities account subscribes to, plus role and title in each. The content of a community account subscribes to is [community name, community title, role_id, title].

  Parameters

  • account: string

    The account to fetch.

  Returns Promise<NexusCommunitySubscription[]>

listCommunities

• listCommunities(last?, limit?, query?, sort?, observer?): Promise<NexusCommunity[]>

• Return a paged list of Nexus communities.

  Backing JSON-RPC method: bridge.list_communities. This is the safest way to discover community names before calling getCommunity.

  Parameters

  • Optionallast: null | string

    Name of community, paging mechanism [optional].
  • Optionallimit: number

    Number of listed communities, default: 100 [optional].
  • Optionalquery: null | string

    Filters against title and about community fields [optional].
  • Optionalsort: NexusCommunitySort

    Sorting of results, default: rank [optional].

    • rank: sort by community rank.
    • new: sort by newest community.
    • subs: sort by subscriptions.
  • Optionalobserver: null | string

    A valid account [optional].

  Returns Promise<NexusCommunity[]>
• listCommunities(options): Promise<NexusCommunity[]>

• Parameters

  • options: NexusListCommunitiesQuery

  Returns Promise<NexusCommunity[]>

listCommunityRoles

• listCommunityRoles(community, last?, limit?): Promise<NexusCommunityRole[]>

• Returns a list of community account-roles (anyone with non-guest status). The content of a community account-roles array is [community name, role_id, title].

  Parameters

  • community: string

    Community category name (account).
  • last: null | string = ''

    Name of subscriber, paging mechanism [optional].
  • limit: number = 50

    limit Number of listed communities, default: 50 [optional].

  Returns Promise<NexusCommunityRole[]>

listCommunityTitles

• listCommunityTitles(community, last?, limit?): Promise<NexusCommunityTitle[]>

• Returns community accounts with custom titles. Backing JSON-RPC method: bridge.list_community_titles.

  Parameters

  • community: string
  • last: null | string = ''
  • limit: number = 50

  Returns Promise<NexusCommunityTitle[]>

listPopCommunities

• listPopCommunities(limit?): Promise<NexusCommunitySummary[]>

• Correctly spelled alias for listPopComunities.

  Parameters

  • limit: number = 25

  Returns Promise<NexusCommunitySummary[]>

listPopComunities

• listPopComunities(limit?): Promise<NexusCommunitySummary[]>

• Returns a list of communities by new subscriber count. The content of a community array is [community name, community title].

  Parameters

  • limit: number = 25

    Number of listed communities, default: 25 [optional].

  Returns Promise<NexusCommunitySummary[]>

  Deprecated

  Use the correctly spelled listPopCommunities alias. This historical misspelling remains supported for backward compatibility.

listSubscribers

• listSubscribers(community, last?, limit?): Promise<NexusCommunitySubscriber[]>

• Returns a list of subscribers for a given community. The content of a subscriber array is [account, role_id, title, created_at].

  Parameters

  • community: string

    Community category name (account).
  • last: null | string = ''

    Last account, paging mechanism [optional].
  • limit: number = 100

    Number of results, default: 100 [optional].

  Returns Promise<NexusCommunitySubscriber[]>

listTopCommunities

• listTopCommunities(limit?): Promise<NexusCommunitySummary[]>

• Returns top communities as [community name, community title]. Backing JSON-RPC method: bridge.list_top_communities.

  Parameters

  • limit: number = 25

  Returns Promise<NexusCommunitySummary[]>

normalizePost

• normalizePost(post): Promise<NexusPost>

• Normalize a condenser-style post object into the Nexus bridge post shape. Backing JSON-RPC method: bridge.normalize_post.

  Parameters

  • post: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns Promise<NexusPost>

postNotifications

• postNotifications(author, permlink, min_score?, last_id?, limit?): Promise<NexusAccountNotifications[]>

• Load notifications for a specific post.

  Parameters

  • author: string

    Name of author.
  • permlink: string

    Permlink of post.
  • Optionalmin_score: number

    Minimum score of notification, default: 25 [optional].
  • Optionallast_id: null | number

    Last notification ID, paging mechanism [optional].
  • Optionallimit: number

    Number of results, default: 100 [optional].

  Returns Promise<NexusAccountNotifications[]>
• postNotifications(options): Promise<NexusAccountNotifications[]>

• Parameters

  • options: NexusPostNotificationQuery

  Returns Promise<NexusAccountNotifications[]>

referralAccounts

• referralAccounts(referrer?, campaign_id?, limit?, last_created_at?): Promise<ReferralAccount[]>

• Get all accounts of a referrer/campaign.

  Parameters

  • Optionalreferrer: null | string

    The referrer account to fetch [optional].
  • Optionalcampaign_id: null | string

    The campaign id to fetch [optional].
  • Optionallimit: number

    Number of results, default: 100 [optional].
  • Optionallast_created_at: null | string

    Last creation date (DESC order), paging mechanism [optional].

  Returns Promise<ReferralAccount[]>
• referralAccounts(options): Promise<ReferralAccount[]>

• Parameters

  • options: NexusReferralAccountsQuery

  Returns Promise<ReferralAccount[]>

referralAccountsCount

• referralAccountsCount(referrer?, campaign_id?, start_date?, end_date?): Promise<NexusReferralAccountsCount>

• Load notifications for a specific post.

  Parameters

  • Optionalreferrer: null | string

    The referrer account to fetch [optional].
  • Optionalcampaign_id: null | string

    The campaign id to fetch [optional].
  • Optionalstart_date: null | string

    start creation date, analytics mechanism [optional].
  • Optionalend_date: null | string

    end creation date, analytics mechanism [optional].

  Returns Promise<NexusReferralAccountsCount>
• referralAccountsCount(options): Promise<NexusReferralAccountsCount>

• Parameters

  • options: NexusReferralAccountsCountQuery

  Returns Promise<NexusReferralAccountsCount>

unreadNotifications

• unreadNotifications(account, min_score?): Promise<NexusUnreadNotifications>

• Load notifications for a specific post.

  Parameters

  • account: string

    The account to fetch.
  • Optionalmin_score: number

    Minimum score of notification, default: 25 [optional].

  Returns Promise<NexusUnreadNotifications>
• unreadNotifications(options): Promise<NexusUnreadNotifications>

• Parameters

  • options: NexusUnreadNotificationsQuery

  Returns Promise<NexusUnreadNotifications>