hive-api-client v6.0.0

Hive API Client

Getting started

Installation

This client is distributed as an npm package. To install it into an npm project, run the following command:

$ npm install hive-api-client

API key

To use this client, you will need a Hive API key. Each project that you create will be associated with a unique API key that identifies your project. You can find this API key on the dashboard of your project.

Usage

After installing the npm package, require the package in your node.js file

const hive = require('hive-api-client');

Then instantiate an Api object, using your project's API key

const hive_api = new hive.Api({api_key: 'YOUR_API_KEY'});

Now you can use the API! For example, if you wanted to check the progress of a task using task_progress (replacing TASK_ID with the unique ID of a task you want to check).

result = await hive_api.task_progress({task_id: 'TASK_ID'})
console.log(result);