API
Last updated
Last updated
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.
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.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Examples: https://hivebuzz.me/api/level/arcange https://hivebuzz.me/api/level/ned https://hivebuzz.me/api/level/ned?dead
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
Sample Response:
Examples: https://hivebuzz.me/api/badges/arcange
GET https://hivebuzz.me/api/owners/{id}
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
| Name | Type | Description |
|---|---|---|
username*
String
The Hive username
dead
bool
return a "Dead Fish" image IF the user has been inactive for more than 30 days
type
badge type (activity, perso, meetup)
ID
identifier
name
short name
title
name of the badge displayed on the board
description
Description of the badge that is displayed in the description modal window when you click on a badge
description_title
Title displayed on the top of the description window
group
Group identifier used to group badges by affinity
url
url of the the badge
id*
Integer
The badge identifier