⏩Quick Start

Getting started with Spindl is as simple as installing the JS SDK. You can browse more details and configuration in the JS SDK Documentation.

Spindl is in closed beta. To get access, please fill out our beta waitlist, and we'll get back to you soon.

Install SDK

Default

npm install @spindl-xyz/attribution
yarn add @spindl-xyz/attribution

Lite

npm install @spindl-xyz/attribution-lite
yarn add @spindl-xyz/attribution-lite

Initialize SDK

import spindl from "@spindl-xyz/attribution";
// import spindl from "@spindl-xyz/attribution-lite" // only for lite version customers

spindl.configure({
  sdkKey: "<your SDK API key here>",
});

spindl.enableAutoPageViews();

// Call this whenever a wallet address is connected or changed
function onWalletConnect(address: string) {
  spindl.attribute(address);
}

React, Next.js and HTML Examples

• check out our sdk-examples repo for easy ways to implement our sdk.

Check if Events Are Sent Correctly

Once you start sending events, you can go to your organization Event Logs page of our web app to validate that events are being passed in correctly