Posts

Introducing the HiveBuzz API for applications and websites

avatar of @hivebuzz
25
@hivebuzz
·
0 views
·
2 min read

Several developers have recently contacted us to ask if it is possible to integrate HiveBuzz badges with their websites or applications.

This is why we have set up an API server that will allow them to easily obtain information relating to users' badges. The API is free to use. However, be aware that the call rate is throttled to avoid exhausting the server resources.

How to use the HiveBuzz API?

Endpoint

https://hivebuzz.me/api

/level/{username}

MethodGET
DescriptionRetrieve a user's level image
Examplehttps://hivebuzz.me/api/level/arcange

HiveBuzz will update the image automatically whenever the user's level changes (up or down).

If you want the API to return the "Dead Fish" image whenever a user has been inactive and hasn't performed any transaction on the blockchain for more than 30 days, you can add the parameter ?dead to your call.

Examples: https://hivebuzz.me/api/level/arcange https://hivebuzz.me/api/level/ned https://hivebuzz.me/api/level/ned?dead

/badges/{username}

MethodGET
DescriptionRetrieve the list of all badges for a user, including those that were not collected by the user
Examplehttps://hivebuzz.me/api/badges/arcange

Returns an array of objects with the following properties

typebadge type (activity, perso, meetup)
IDidentifier
nameshort name
titlename of the badge displayed on the board
descriptionDescription of the badge that is displayed in the description modal window when you click on a badge
description_titleTitle displayed on the top of the description window
groupGroup identifier used to group badges by affinity
urlurl of the the badge

Sample Response:

[ 
 ..., 
 { 
  "type": "perso", 
  "ID": 38, 
  "name": "birthday-3", 
  "title": "3 years on the Hive blockchain", 
  "description": "Congratulations! You joined Hive blockchain three years ago!", 
  "description_title": "3 years on the Hive blockchain", 
  "group": "P01", 
  "url": "https://hivebuzz.me/badges/birthday-3.png" 
 }, 
 { 
  "type": "meetup", 
  "ID": 43, 
  "name": "steemfest-4", 
  "title": "SteemFest 4 Attendee", 
  "description": "You went to Bangkok to attend SteemFest⁴", 
  "description_title": "SteemFest 4 Attendee", 
  "group": "M01", 
  "url": "https://hivebuzz.me/badges/steemfest-4.s4.png" 
 }, 
 ... 
] 

/owners/{id}

MethodGET
DescriptionQuery for the owner list of a badge
Examplehttps://hivebuzz.me/api/owners/43

Returns an array of strings (usernames)

Sample Response:

["achimmertens","arcange","brittandjosie","charly.travels","coolsurfer","detlev","fynemiene","louis88","martibis","pundito","rollie1212","sunsea"]

Support

If you need help to integrate your website or application with HiveBuzz, feel free to contact us on Discord.

The Hivebuzz Team


HiveBuzz needs your help! Read and support our proposal!