npm

Need private packages and team management tools?Check out npm Orgs. »

predicthq

0.1.1 • Public • Published

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

var phq = require('predicthq')

client = new phq.Client({access_token: "ACCESS_TOKEN"})

// the search() method returns an EventResultSet which allows you to iterate over the 1st page of items
client.events.search({q: 'Madonna', rank_level: 5, country:'AU', 'start.gte' : '2016-01-01'})
    .then(function(results){
        var events = results.toArray()
        for(var i=0; i < events.length; i++){
           console.info(events[i].rank, events[i].category, events[i].title, events[i].start, events[i].location)
        }
    })

88 'concerts' 'Madonna' '2016-03-27T10:00:00Z' [ 153.073, -27.3431 ]
88 'concerts' 'Madonna' '2016-03-26T10:00:00Z' [ 153.073, -27.3431 ]
88 'concerts' 'Madonna' '2016-03-16T17:30:00Z' [ 153.073, -27.3431 ]
88 'concerts' 'Madonna' '2016-03-16T10:00:00Z' [ 153.073, -27.3431 ]
89 'concerts' 'Madonna' '2016-03-12T09:00:00Z' [ 144.978, -37.8218 ]

# you can skip results with the offset parameter and limit the number of results with the limit parameter
# the following skips the first 10 results and limits the results to 5 items
client.events.search(({q: 'Madonna', offset: 10, limit: 5})
    .then(function(results){
        var events = results.toArray()
        for(var i=0; i < events.length; i++){
           console.info(events[i].rank, events[i].category, events[i].title, events[i].start, events[i].location)
        }
    })

ES6 Usage

import Client from 'predicthq'

let client = new Client({access_token="ACCESS_TOKEN"})

client.events.search({'within': '1km@42.35996,-71.06009', 'start.gte': '2016-03-08', 'start.lt': '2016-03-09'})
    .then((results)=>{
        for (let event of results)
            console.info(event.title)
    })

NodeJS

You will need to bring your own fetch library

// npm install node-fetch
global.fetch = require('node-fetch')
var phq = require('predicthq')
var client = new phq.Client({access_token: "ACCESS_TOKEN"})

// or
var fetch = require('node-fetch')
var phq = require('predicthq')
var client = new phq.Client({access_token: "ACCESS_TOKEN", fetch: fetch})

Endpoints

  • events
  • accounts
  • places

For a description of all available endpoints, refer to our API Documentation.

Keywords

none

install

npm i predicthq

Downloadsweekly downloads

60

version

0.1.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability