Skip to content
PredictHQ API Client for JavaScript
JavaScript CSS HTML
Branch: master
Clone or download

README.md

PredictHQ logo

PredictHQ API Client for Javascript

Version Build Status Coverage Status

PredictHQ is the demand intelligence company combining real-world events into one global source of truth to help businesses better understand demand and plan for the future.

Installation

npm install predicthq

Usage

We support all the endpoints available in our API.

  • oauth2
  • accounts
  • events
  • places

Please refer to our API Documentation for a description of each endpoint.

Initialising the SDK

const phq = require('predicthq');

// Initialises PredictHQ client library using your access token
// Note: You can find/create your access token at https://control.predicthq.com/clients
const client = new phq.Client({access_token: 'Acc3sS-t0keN'});

ES6 Usage

import Client from 'predicthq';
// Initialises PredictHQ client library using your access token
// Note: You can find/create your access tnoken at https://control.predicthq.com/clients
const client = new Client({access_token: 'Acc3sS-t0keN'});

NodeJS

You will need to bring your own fetch library

//  npm install node-fetch
const nodeFetch = require('node-fetch');

const phq = require('predicthq');

// Initialises PredictHQ client library using your access token
// Note: You can find/create your access token at https://control.predicthq.com/clients
const client = new phq.Client({access_token: 'Acc3sS-t0keN', fetch: nodeFetch});

Events endpoint

Additional examples are available in usecases/events directory.

// Basic event search without any parameters. By default, it will return the first ten events.
client.events.search()
    .then(
        (results) => {
            for (const event of results) {
                console.info(event);
            }
        }
    ).catch(
        err => console.error(err)
    );
You can’t perform that action at this time.