Hive Developers logo

Hive Developer Portal

Methods:

Presents data interpreted by the hivemind database as JSON-RPC.

Also see: Communities Broadcast Ops

bridge.get_ranked_posts

Get ranked posts.

Supported values for sort:

The value for tag can be any valid tag.

The value for observer can be any valid account or empty string.

Query Parameters JSON 
{"sort": "", "tag": "", "observer": ""}
Expected Response JSON 
[
  {
    "post_id": 12345678,
    "author": "alice",
    "permlink": "that-march-hare",
    "category": "wonderland",
    "title": "That March Hare",
    "body": "I think he went mad.",
    "json_metadata": {
      "tags": ["wonderland"],
      "app": "hiveblog/0.1"
    },
    "created": "2019-12-05T16:29:12",
    "updated": "2019-12-05T16:29:12",
    "depth": 0,
    "children": 0,
    "net_rshares": 1539574839484,
    "is_paidout": false,
    "payout_at": "2019-12-12T16:29:12",
    "payout": 0.286,
    "pending_payout_value": "0.286 HBD",
    "author_payout_value": "0.000 HBD",
    "curator_payout_value": "0.000 HBD",
    "promoted": "0.000 HBD",
    "replies": [],
    "active_votes": [{"voter": "bob", "rshares": "67759296290"}],
    "author_reputation": 47.15,
    "stats": {
      "hide": false,
      "gray": false,
      "total_votes": 12,
      "flag_weight": 0
    },
    "beneficiaries": [],
    "max_accepted_payout": "1000000.000 HBD",
    "percent_hbd": 10000,
    "url": "/wonderland/@alice/that-march-hare",
    "blacklists": []
  }
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_ranked_posts", "params":{"sort":"trending","tag":"","observer":"alice"}, "id":1}' https://api.hive.blog

bridge.account_notifications

Account notifications.

Supported values for type:

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

Query Parameters JSON 
{"account": "alice", "limit": 100}
Expected Response JSON 
[
  {
    "id": 3629306,
    "type": "vote",
    "score": 25,
    "date": "2019-11-20T07:48:06",
    "msg": "@bob voted on your post ($0.013)",
    "url": "@alice/a-post-by-alice"
  }
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.account_notifications", "params":{"account":"alice","limit":100}, "id":1}' https://api.hive.blog

bridge.does_user_follow_any_lists

Checks if a given observer follows any blacklists or mute lists.

Query Parameters JSON 
{"observer": "alice"}
Expected Response JSON 
false
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.does_user_follow_any_lists", "params":{"observer":"alice"}, "id":1}' https://api.hive.blog

bridge.get_account_posts

Lists posts related to a given account.

Query Parameters JSON 
{"sort": "blog", "account": "alice", "limit": 1}
Expected Response JSON 
[
  {
    "post_id": 101867403,
    "author": "hiveio",
    "permlink": "around-the-hive-reflections",
    "category": "hiveecosystem",
    "title": "Around the Hive: Reflections",
    "body": "It's been a busy year so far for developers on Hive. Layer 2 solutions are in progress, key optimization is an ongoing priority ...",
    "json_metadata": {
      "tags": ["hiveecosystem"],
      "users": ["blocktrades", "howo"],
      "image": [
        "https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/hiveio/pKjrNcbK-Hive-Wallpaper-1920x1080.png",
        "https://images.hive.blog/DQmR3iwCn9yvwXDXfuNjmMX6FrjAvFfYQWgA4QRckpens1j/hive%20dividers-02.png"
      ],
      "links": [
        "https://gitlab.syncad.com/hive/hive-whitepaper/-/blob/master/technical-vision/infographic.pdf"
      ],
      "app": "hiveblog/0.1",
      "format": "markdown",
      "description": "The strength of Hive lies in our decentralization."
    },
    "created": "2021-02-14T08:16:03",
    "updated": "2021-02-14T08:16:03",
    "depth": 0,
    "children": 15,
    "net_rshares": 93531156115025,
    "is_paidout": true,
    "payout_at": "2021-02-21T08:16:03",
    "payout": 0,
    "pending_payout_value": "0.000 HBD",
    "author_payout_value": "0.000 HBD",
    "curator_payout_value": "0.000 HBD",
    "promoted": "0.000 HBD",
    "replies": [],
    "author_reputation": 69.29,
    "stats": {
      "hide": false,
      "gray": false,
      "total_votes": 129,
      "flag_weight": 0
    },
    "url": "/hiveecosystem/@hiveio/around-the-hive-reflections",
    "beneficiaries": [],
    "max_accepted_payout": "0.000 HBD",
    "percent_hbd": 10000,
    "active_votes": [],
    "blacklists": []
  }
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_account_posts", "params":{"sort":"blog", "account": "alice", "limit": 1}, "id":1}' https://api.hive.blog

bridge.get_community_context

Gets the role, subscription status, and title for a given account in a given community.

Query Parameters JSON 
{"name": "hive-111111", "account": "therealwolf"}
Expected Response JSON 
{
  "role": "admin",
  "subscribed": true,
  "title": "Witness: @therealwolf"
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_community_context", "params":{"name": "hive-111111", "account": "therealwolf"}, "id":1}' https://api.hive.blog

bridge.get_discussion

Gives a flattened discussion tree starting at given post.

Query Parameters JSON 
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections",
  "observer": "alice"
}
Expected Response JSON 
{
  "hiveio/around-the-hive-reflections": {
    "post_id": 101867403,
    "author": "hiveio",
    "permlink": "around-the-hive-reflections",
    "category": "hiveecosystem",
    "title": "Around the Hive: Reflections",
    "body": "It's been a busy year so far for developers on Hive. Layer 2 solutions are in progress, key optimization is an ongoing priority ...",
    "json_metadata": {
      "tags": ["hiveecosystem"],
      "users": ["blocktrades", "howo"],
      "image": [
        "https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/hiveio/pKjrNcbK-Hive-Wallpaper-1920x1080.png",
        "https://images.hive.blog/DQmR3iwCn9yvwXDXfuNjmMX6FrjAvFfYQWgA4QRckpens1j/hive%20dividers-02.png"
      ],
      "links": [
        "https://gitlab.syncad.com/hive/hive-whitepaper/-/blob/master/technical-vision/infographic.pdf"
      ],
      "app": "hiveblog/0.1",
      "format": "markdown",
      "description": "The strength of Hive lies in our decentralization."
    },
    "created": "2021-02-14T08:16:03",
    "updated": "2021-02-14T08:16:03",
    "depth": 0,
    "children": 15,
    "net_rshares": 93531156115025,
    "is_paidout": true,
    "payout_at": "2021-02-21T08:16:03",
    "payout": 0,
    "pending_payout_value": "0.000 HBD",
    "author_payout_value": "0.000 HBD",
    "curator_payout_value": "0.000 HBD",
    "promoted": "0.000 HBD",
    "replies": [],
    "author_reputation": 69.29,
    "stats": {
      "hide": false,
      "gray": false,
      "total_votes": 129,
      "flag_weight": 0
    },
    "url": "/hiveecosystem/@hiveio/around-the-hive-reflections",
    "beneficiaries": [],
    "max_accepted_payout": "0.000 HBD",
    "percent_hbd": 10000,
    "active_votes": [],
    "blacklists": []
  }
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_discussion", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections", "observer": "alice"}, "id":1}' https://api.hive.blog

bridge.get_follow_list

Returns blacklisted/muted accounts or list of blacklists/mute lists followed by a given observer.

Query Parameters JSON 
{
  "observer": "blocktrades",
  "follow_type": "follow_blacklist"
}
Expected Response JSON 
[
  {
    "name": "hive.blog",
    "blacklist_description": "",
    "muted_list_description": ""
  }
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_follow_list", "params":{"observer": "blocktrades", "follow_type": "follow_blacklist"}, "id":1}' https://api.hive.blog

bridge.get_profile

Gets profile

Query Parameters JSON 
{"account": "alice", "observer": "bob"}
Expected Response JSON 
{
  "id": 241,
  "name": "alice",
  "created": "2016-03-25T15:09:27",
  "active": "2016-04-29T22:28:00",
  "post_count": 0,
  "reputation": 25,
  "blacklists": [],
  "stats": {"rank": 0, "following": 0, "followers": 431},
  "metadata": {
    "profile": {
      "name": "",
      "about": "",
      "website": "",
      "location": "",
      "cover_image": "",
      "profile_image": "",
      "blacklist_description": "",
      "muted_list_description": ""
    }
  },
  "context": {"followed": false}
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_profile", "params":{"account": "alice", "observer": "bob"}, "id":1}' https://api.hive.blog

bridge.list_communities

Gets community

Query Parameters JSON 
{"limit": 1, "query": "wall street bets"}
Expected Response JSON 
[
  {
    "id": 1432978,
    "name": "hive-103566",
    "title": "Wall Street Bets",
    "about": "Wall Street Bets - In Case Reddit Shuts Down.",
    "lang": "en",
    "type_id": 1,
    "is_nsfw": false,
    "subscribers": 6,
    "sum_pending": 0,
    "num_pending": 0,
    "num_authors": 0,
    "created_at": "2021-01-28 18:34:09",
    "avatar_url": "",
    "context": {},
    "admins": ["spitr"]
  }
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_communities", "params":{"limit": 1, "query": "wall street bets"}, "id":1}' https://api.hive.blog

bridge.list_pop_communities

Gets a list of popular communities.

Query Parameters JSON 
{"limit": 10}
Expected Response JSON 
[
  ["hive-167922", "LeoFinance"],
  ["hive-194913", "Photography Lovers"],
  ["hive-148441", "GEMS"],
  ["hive-196037", "DTube"],
  ["hive-196708", "Hive Pets"],
  ["hive-120586", "Foodies Bee Hive"],
  ["hive-140217", "Hive Gaming"],
  ["hive-174578", "OCD"],
  ["hive-129496", "Nerday"],
  ["hive-193816", "Music"]
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_pop_communities", "params":{"limit": 10}, "id":1}' https://api.hive.blog

bridge.list_subscribers

Gets a list of subscribers for a given community.

Query Parameters JSON 
{"community": "hive-111111", "limit": 10}
Expected Response JSON 
[
  [
    "gatticus",
    "guest",
    null,
    "2021-02-18 13:15:42"
  ],
  [
    "thewarkettle",
    "guest",
    null,
    "2021-02-15 22:04:36"
  ],
  [
    "darkflame",
    "guest",
    null,
    "2021-02-14 00:30:12"
  ],
  [
    "oiuygtfrd76543",
    "guest",
    null,
    "2021-02-01 19:35:03"
  ],
  ["bhattg", "guest", null, "2021-02-01 18:39:06"],
  [
    "elenahornfilm",
    "guest",
    null,
    "2021-02-01 09:19:54"
  ],
  [
    "mrhappypants",
    "guest",
    null,
    "2021-02-01 01:03:48"
  ],
  [
    "petrahaller",
    "guest",
    null,
    "2021-02-01 00:08:09"
  ],
  [
    "hgregoria",
    "guest",
    null,
    "2021-01-29 18:46:12"
  ],
  [
    "theblockabout",
    "guest",
    null,
    "2021-01-29 15:21:48"
  ]
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_subscribers", "params":{"community": "hive-111111", "limit": 10}, "id":1}' https://api.hive.blog

bridge.list_community_roles

List community roles and labels for each account in the community.

Query Parameters JSON 
{"community": "hive-123456"}
Expected Response JSON 
[
  ["hive-123456", "owner", ""],
  ["alice", "admin", "Miss"]
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_community_roles", "params":{"community":"hive-123456"}, "id":1}' https://api.hive.blog

bridge.list_all_subscriptions

List all subscriptions, titles, and roles to a community for an account.

Query Parameters JSON 
{"account": "alice"}
Expected Response JSON 
[
  ["hive-123456", "Wonderland", "guest", ""],
  [
    "hive-654321",
    "Tulgey Wood",
    "admin",
    "Mrs. Vex"
  ]
]
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.list_all_subscriptions", "params":{"account":"alice"}, "id":1}' https://api.hive.blog

bridge.get_community

Get community details.

Query Parameters JSON 
{"name": "hive-123456", "observer": "alice"}
Expected Response JSON 
{
  "id": 1332149,
  "name": "hive-123456",
  "title": "@hive-123456",
  "about": "Wonderland",
  "lang": "en",
  "type_id": 1,
  "is_nsfw": false,
  "subscribers": 0,
  "sum_pending": 0,
  "num_pending": 0,
  "num_authors": 0,
  "created_at": "2019-10-27 08:28:54",
  "context": {
    "role": "admin",
    "title": "Miss",
    "subscribed": true
  },
  "avatar_url": "",
  "description": "",
  "flag_text": "",
  "settings": {},
  "team": [
    ["hive-123456", "owner", ""],
    ["alice", "admin", "Miss"]
  ]
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_community", "params":{"name":"hive-123456","observer":"alice"}, "id":1}' https://api.hive.blog

bridge.get_relationship_between_accounts

Tells what relations connect given accounts from the perspective of first account.

Query Parameters JSON 
["alice", "bob"]
Expected Response JSON 
{
  "follows": false,
  "ignores": false,
  "blacklists": false,
  "follows_blacklists": false,
  "follows_muted": false
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_relationship_between_accounts", "params":["alice", "bob"], "id":1}' https://api.hive.blog

bridge.get_payout_stats

Lists communities ordered by payout with stats (total payout, number of posts and authors).

Query Parameters JSON 
{"limit": 250}
Expected Response JSON 
{
  "items": [
    [
      "hive-167922",
      "LeoFinance",
      10881.39,
      16791,
      1466
    ]
  ],
  "total": 107662.592,
  "blogs": 14453.794
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 1}, "id":1}' https://api.hive.blog

curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_payout_stats", "params":{"limit": 250}, "id":1}' https://api.hive.blog

bridge.get_post

Gives single selected post.

Query Parameters JSON 
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections"
}
Expected Response JSON 
{
  "post_id": 101867403,
  "author": "hiveio",
  "permlink": "around-the-hive-reflections",
  "category": "hiveecosystem",
  "title": "Around the Hive: Reflections",
  "body": "It's been a busy year so far for developers on Hive. Layer 2 solutions are in progress, key optimization is an ongoing priority ...",
  "json_metadata": {
    "tags": ["hiveecosystem"],
    "users": ["blocktrades", "howo"],
    "image": [
      "https://images.hive.blog/768x0/https://files.peakd.com/file/peakd-hive/hiveio/pKjrNcbK-Hive-Wallpaper-1920x1080.png",
      "https://images.hive.blog/DQmR3iwCn9yvwXDXfuNjmMX6FrjAvFfYQWgA4QRckpens1j/hive%20dividers-02.png"
    ],
    "links": [
      "https://gitlab.syncad.com/hive/hive-whitepaper/-/blob/master/technical-vision/infographic.pdf"
    ],
    "app": "hiveblog/0.1",
    "format": "markdown",
    "description": "The strength of Hive lies in our decentralization."
  },
  "created": "2021-02-14T08:16:03",
  "updated": "2021-02-14T08:16:03",
  "depth": 0,
  "children": 15,
  "net_rshares": 93531156115025,
  "is_paidout": true,
  "payout_at": "2021-02-21T08:16:03",
  "payout": 0,
  "pending_payout_value": "0.000 HBD",
  "author_payout_value": "0.000 HBD",
  "curator_payout_value": "0.000 HBD",
  "promoted": "0.000 HBD",
  "replies": [],
  "author_reputation": 69.29,
  "stats": {
    "hide": false,
    "gray": false,
    "total_votes": 129,
    "flag_weight": 0
  },
  "url": "/hiveecosystem/@hiveio/around-the-hive-reflections",
  "beneficiaries": [],
  "max_accepted_payout": "0.000 HBD",
  "percent_hbd": 10000,
  "active_votes": [],
  "blacklists": []
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "alice", "permlink": "that-march-hare", "observer": "bob"}, "id":1}' https://api.hive.blog

curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}' https://api.hive.blog

bridge.get_post_header

Gives very basic information on given post.

Query Parameters JSON 
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections"
}
Expected Response JSON 
{
  "author": "hiveio",
  "permlink": "around-the-hive-reflections",
  "category": "hiveecosystem",
  "depth": 0
}
Example curl 
curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "alice", "permlink": "that-march-hare"}, "id":1}' https://api.hive.blog

curl -s --data '{"jsonrpc":"2.0", "method":"bridge.get_post_header", "params":{"author": "hiveio", "permlink": "around-the-hive-reflections"}, "id":1}' https://api.hive.blog
Back to top