v0.1.0 - In Development

API Reference

Initialization & Configuration

The Pulse Deck SDK enables zero-config declarative embedding into your frontend application using simple HTML data attributes. Bind interactions natively to your market components without writing boilerplate JavaScript.

Include the Pulse Deck SDK script at the end of your document body and configure it globally using your publishable API key.

HTML Document Body 
<script src="https://cdn.pulsedeck.com/sdk/v1/pulse-deck-sdk.js"></script>
<script>
  PulseDeck.configure({
    publishableKey: 'pk_live_YOUR_PUBLISHABLE_KEY'
  });
</script>

Inline Embedded Graphs

ATTR data-pdkg-market-embed="[market_id]"

Defines the container scope for an inline embedded knowledge graph. Attach this to the wrapper div of a market card.

HTML Wrapper 
<div data-pdkg-market-embed="pd-mkt-3022" class="market-card">
  <!-- Market Content -->
</div>
ATTR data-pdkg-btn-embed="[market_id]"

Declares the specific trigger element (such as a generic span or button) within the market container that activates the inline embedded pulse graph.

HTML Trigger 
<span data-pdkg-btn-embed="pd-mkt-3022"></span>
ATTR data-pdkg-market-pop="[market_id]"

Defines a market container that will launch a full-screen pop-up modal view of the knowledge graph. Ideal for compact grid layouts or tight mobile lists.

HTML Pop-up Wrapper 
<div data-pdkg-market-pop="33345" class="grid-card">
  <!-- Card Content -->
</div>
ATTR data-pdkg-btn-pop="[market_id]"

Initializes the explicit trigger element for the modal pop-up graph experience.

HTML Pop-up Trigger 
<span data-pdkg-btn-pop="33345"></span>