API
The HiveBuzz API allows developers to easily get information about users' badges and integrate them into their websites or applications.
The API is free to use. However, be aware that the call rate is throttled to avoid exhausting the server resources.
Endpoint
Retrieve a user's level image
GET
https://hivebuzz.me/api/level/{username}
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.
Path Parameters
Name | Type | Description |
---|---|---|
username* | String | The Hive username |
Query Parameters
Name | Type | Description |
---|---|---|
dead | bool | return a "Dead Fish" image IF the user has been inactive for more than 30 days |
Examples: https://hivebuzz.me/api/level/arcange https://hivebuzz.me/api/level/ned https://hivebuzz.me/api/level/ned?dead
Retrieve all badges for a user
GET
https://hivebuzz.me/api/badges/{username}
Retrieve the list of all badges for a user, including those that were not collected by the user
Returns an array of objects with the following properties
| badge type (activity, perso, meetup) |
| identifier |
| short name |
| name of the badge displayed on the board |
| Description of the badge that is displayed in the description modal window when you click on a badge |
| Title displayed on the top of the description window |
| Group identifier used to group badges by affinity |
| url of the the badge |
Sample Response:
Examples: https://hivebuzz.me/api/badges/arcange
Retrieve the list of a badge owners
GET
https://hivebuzz.me/api/owners/{id}
Path Parameters
Name | Type | Description |
---|---|---|
id* | Integer | The badge identifier |
Returns an array of strings (usernames)
Sample Response:
["achimmertens","arcange","brittandjosie","charly.travels","coolsurfer","detlev","fynemiene","louis88","martibis","pundito","rollie1212","sunsea"]
Example: https://hivebuzz.me/api/owners/43
Last updated