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 [email protected]

Getting Started

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:

• Data Service
  • Responsible for providing access to cached Provider data
• Influence Service
  • Responsible for providing access to cached Influence data

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
3. Using a Social Platform Username: twitter:jack

Our endpoints will always return the borg ID for identities.