v0.1.0 - In Development

Implementation Documentation

Quickstart Guide

Pulse Deck runs as an overlay on your existing prediction market platform. It provides interactive knowledge graph bindings for leading platforms out of the box.

Installation Method A: NPM Package

Terminal
npm install @pulsedeck/sdk

Installation Method B: Script Embedder (CDN)

Include the Pulse Deck SDK seamlessly at the end of your document body. This approach requires zero build configuration.

HTML Document Body
<script src="https://cdn.pulsedeck.com/sdk/v1/pulse-deck-sdk.js"></script>

Initializing the SDK

Provide the SDK with your platform bindings so it knows where to route trades and render visualizations.

Option 1: JS / React Setup

index.ts
import { PulseDeck } from '@pulsedeck/sdk';

const engine = new PulseDeck({
    apiKey: 'pk_live_your_key_here',
    platform: 'custom',
    behavior: {
        autoInjectBadges: true,
        enableHoverPeek: true
    }
});

// Start the engine
engine.mount('#market-widget');

Option 2: Browser Script Setup

Use the global PulseDeck object to bootstrap inline integrations seamlessly utilizing HTML data attributes.

HTML Configuration
<script>
  PulseDeck.configure({
    publishableKey: 'pk_live_YOUR_PUBLISHABLE_KEY'
  });
</script>

Real-Time Indicators

The SDK automatically attaches sentiment cues to your market elements. When an exogenous shock is detected via our Edge AI pipeline, affected UI nodes immediately receive dynamic indicators.

  • Green: Indicates a positive catalyst for the market resolution.
  • Red: Indicates a negative catalyst or decreased probability.
  • Grey: Indicates indirect tertiary propagation.

Note:

Documentation is under development.