hotstreak v1.0.69

HotStreak JavaScript SDK

The HotStreak JavaScript SDK provides convenient access to HotStreak's real-time market feeds.

Installation

Install the package with:

yarn add hotstreak
# or
npm i hotstreak --save

Usage

To import the package:

import HotStreak from 'hotstreak';
// or
const HotStreak = require('hotstreak');

HotStreak needs to be initialized with:

1. The URL of the environment you want to point to as baseUrl

2. Credentials

   • Server (i.e. node) - pass key and secret directly
   • Client (i.e. browser, mobile device, etc.) - generate a JWT signed with secret on server. Then pass the JWT to your client. The JWT payload must contain your API key, and may contain a subject identifiying your client

   { iss: key, subject: 'optional_client_id', exp: TIMESTAMP_IN_FUTURE }

🚨 You should NOT deploy your API secret to the client directly!

// server initialization
const hotstreak = new HotStreak({
  baseUrl: 'BASE_URL',
  key: 'YOUR_KEY',
  secret: 'YOUR_SECRET'
});

// client initialization
const jwt = await getJwtFromYourServer();
const hotstreak = new HotStreak({
  baseUrl: 'BASE_URL',
  token: jwt
});

Subscribing to a game:

const leagues = await hotstreak.fetchLeagues();
// TODO: push leagues to your store

hotstreak.subscribe(leagues[0], (game, markets) => {
  // TODO: push game & markets to your store
  console.log(game);
  console.log(markets);
});

Unsubscribing from a game:

hotstreak.unsubscribeFromChannel(game.broadcastChannel);

Making a Prediction:

const prediction = hotstreak.predict(game, market, 'over');

Prediction Web Hook:

Results are communicated via a POST web hook registered with your API KEY. Example web hook payload

{
  "prediction_id": "Prediction:P87Fbd",
  "sequence": 4,
  "timestamp": 1598983584.4778883,
  "state": "finalized",
  "actual_outcome": "over",
  "predicted_outcome": "over",
  "category": "rebounds",
  "current": 1.0,
  "subject": null,
  "meta": null,
  "id": "0c9a89371d6f96bd2c674b1bd58c58e311526a3f"
}