Introduction

The Borg API give you full access to our different services that power hive.one.

This documentation describes all of the available API calls and properties of the returned objects. If you have any questions, please reach out to api@hive.one

Getting Started

Obtaining an API Key

You can get an API Key by creating an account at api.signup.borg.id. You will automatically be given an API key.

<aside> <img src="https://beestat.io/img/notion/info.svg" alt="https://beestat.io/img/notion/info.svg" width="40px" /> Anyone with this API Key can use the Borg API as you. If it is compromised, please create a new API key

</aside>

Authorising Requests

You must send your API Key with each request you make by using the Authorization HTTP Header like so:

Authorization: Token API_KEY_HERE

API Reference

Our API is powered by different services:

Borg IDs and Twitter IDs

When requesting a specific Identity there are several methods to specify which identity you are requesting:

  1. Using a borg id: borg:1234
  2. Using a Social Platform ID: twitter:1234