<p dir="auto">Several developers have recently contacted us to ask if it is possible to integrate HiveBuzz badges with their websites or applications.
<p dir="auto">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.
<h2>How to use the HiveBuzz API?
<h3>Endpoint
<p dir="auto"><span><a href="https://hivebuzz.me/api" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api
<h3>/level/{username}
<div class="table-responsive"><table>
<thead>
<tr><th><th>
<tbody>
<tr><td>Method<td>GET
<tr><td>Description<td>Retrieve a user's level image
<tr><td>Example<td><span><a href="https://hivebuzz.me/api/level/arcange" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api/level/arcange
<p dir="auto">HiveBuzz will update the image automatically whenever the user's level changes (up or down).
<p dir="auto">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 <code>?dead to your call.
<p dir="auto">Examples:<br /><br /><br /><span>
<a href="https://hivebuzz.me/api/level/arcange" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api/level/arcange<span>
<a href="https://hivebuzz.me/api/level/ned" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api/level/ned<span>
<a href="https://hivebuzz.me/api/level/ned?dead" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api/level/ned?dead
<h3>/badges/{username}
<div class="table-responsive"><table>
<thead>
<tr><th><th>
<tbody>
<tr><td>Method<td>GET
<tr><td>Description<td>Retrieve the list of all badges for a user, including those that were not collected by the user
<tr><td>Example<td><span><a href="https://hivebuzz.me/api/badges/arcange" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api/badges/arcange
<p dir="auto">Returns an array of objects with the following properties
<div class="table-responsive"><table>
<thead>
<tr><th><th>
<tbody>
<tr><td><code>type<td>badge type <em>(activity, perso, meetup)
<tr><td><code>ID<td>identifier
<tr><td><code>name<td>short name
<tr><td><code>title<td>name of the badge displayed on the board
<tr><td><code>description<td>Description of the badge that is displayed in the description modal window when you click on a badge
<tr><td><code>description_title<td>Title displayed on the top of the description window
<tr><td><code>group<td>Group identifier used to group badges by affinity
<tr><td><code>url<td>url of the the badge
<p dir="auto">Sample Response:
<pre><code>[
...,
{
"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"
},
...
]
<h3>/owners/{id}
<div class="table-responsive"><table>
<thead>
<tr><th><th>
<tbody>
<tr><td>Method<td>GET
<tr><td>Description<td>Query for the owner list of a badge
<tr><td>Example<td><span><a href="https://hivebuzz.me/api/owners/43" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://hivebuzz.me/api/owners/43
<p dir="auto">Returns an array of strings (usernames)
<p dir="auto">Sample Response:
<p dir="auto"><code>["achimmertens","arcange","brittandjosie","charly.travels","coolsurfer","detlev","fynemiene","louis88","martibis","pundito","rollie1212","sunsea"]
<h3>Support
<p dir="auto">If you need help to integrate your website or application with HiveBuzz, feel free to contact us on <a href="https://discord.gg/J6JrABJ" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">Discord.
<p dir="auto"><strong>The Hivebuzz Team
<hr />
<p dir="auto"><center>
<p dir="auto">HiveBuzz needs your help! <strong>Read and support <a href="https://peakd.com/me/proposals/109" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">our proposal!
<hr />
<p dir="auto"><center><sub><em><span>HiveBuzz is a project created by <a href="/@arcange">@arcange
Its only development that produce good outcome, @hivebuzz, you guys have gone extra mile in developing the hive community, though am new,I think I will enjoy working with you guys,as a contribution, I will reblog your post so people in my blog can also be notified
Sigamos trabajando y aportando ideas para crecer en Hive!...
Let's keep working and giving ideas to grow in Hive!Hola @hivebuzz… He elegido tu post para mi iniciativa diaria de reblogear. Este es mi aporte para Hive… Hello @hivebuzz... I have chosen your post for my daily reblogging initiative. This is my contribution to Hive...
Awesome :))) I will try the API 😁
@hivebuzz won't you require a client id/token for requests?
what for?
Most APIs require tokens to track who uses which and map usage per account if it reaches limit or not. Only limits excess usage to accounts with that token. Well, this is business-case, depending on paid access I get more bandwidth/usage or if free I get less. But my point is on abuse, or DDoS, maybe simultaneous and repeated requests haunts the API. :D
We are not in a business case and our API is free to use. Adding userid/token will add burden on both side.
We prefer to keep it simple and throttle requests/usage globally at the server side.
And if we change our mind, we can still implement it 😉
Great! Feel free to provide feedback if any
Good information and excellent work.
Great stuff, hope to check it out soon.
Oke good
HIVE.D!
i am new here. thats why it is confusing to me. can anyone help me to make a badge for me? :(
Discord or Telegram
I think setting up the API server is such a reasonable decision because it will help us have access to the information we want about user's badges.
It is also easy to access it. Thanks for such great update.
Thank you for the information @hivebuzz. I think there are some members of the Indonesian Hive Community who are interested in this program. We are incessantly conducting a promotion of the Hive in Indonesia.
Discord or Telegram if you need more info about HiveBuzz
BTW, it would be very appreciated if you could support our proposal so we can keep up the good work!
Good
I am getting an error - can't seem to load the website link :o