Skip to main content

🧰 Start with SDK

Welcome to the Thirdwave JavaScript SDK! This guide will help you integrate Wallet Intelligence into your JavaScript applications seamlessly. The SDK provides easy access to comprehensive blockchain wallet analytics, enabling you to build more insightful and engaging user experiences.

To get started with implementation, please follow the guide below. For more information about Wallet Intelligence in general, visit the Wallet Intelligence Overview.

Quick Start​

To dive right in and start using the Javascript SDK, visit our GitHub repository:

👉🏻 GitHub Repository: https://github.com/thirdwaveorg/thirdwave-js-sdk

The GitHub README provides detailed instructions on installation, initialization, usage examples, and API references.

Introduction​

The Thirdwave JavaScript SDK simplifies access to in-depth wallet analytics from Wallet Intelligence within your JavaScript projects. Whether you're building a web application, backend service, or Node.js application, the SDK provides an easy way to interact with the Wallet Intelligence API offered by Thirdwave.

Before you start using the SDK, it's important to understand some core concepts.

Wallet Intelligence​

Wallet Intelligence is a suite of tools and data that provides deep insights into blockchain wallets. It helps you analyze wallet behaviors, transaction patterns, and risk profiles.

  • Understand User Behavior: Analyze how wallets interact with different blockchain networks.
  • Risk Assessment: Identify potentially fraudulent or high-risk wallets.
  • Personalization: Tailor your application's experience based on wallet activity.

Learn more here.

Field Definitions​

The SDK provides access to various metrics that describe wallet activities. Here are some key metrics:

  • Engagement Score: An integer value from 0 to 100 that quantifies a wallet's on-chain activity. Higher scores indicate active and consistent participation in transactions, helping you identify engaged users.

  • HODLer Score: A score ranging from 0 to 100 that evaluates a wallet's tendency to hold onto NFTs. A high score means the wallet typically retains its NFTs, indicating loyalty and long-term engagement.

  • Bot Warning: A binary indicator (true or false) that classifies whether a wallet is potentially a bot. This helps in enhancing security by identifying and mitigating automated or fraudulent activities.

  • Balance: Reflects the current USD value of all tokens owned by a wallet, calculated using the latest token-to-USD conversion rates. This metric allows you to segment users based on their wallet value.

  • Outbound Transaction Value: The amount of currency or tokens expended from the wallet or account over its lifetime. It sheds light on the account's consumption patterns, providing insights into expenditure behaviors or transactional habits.

For a full list of fields, refer to the Response Object documentation. For in-depth definitions and more information on methodology, visit our Field Glossary.

How the SDK Enhances Your Application​

  • Enhance Security with Bot Shield: Detect and prevent bot activities by analyzing wallet behavior patterns with features like Bot Shield. Safeguard your application from automated attacks and maintain a secure environment for genuine users. Learn More: Bot Shield Guide

  • Boost User Engagement with Dynamic Incentives: Personalize rewards and offers based on individual wallet histories, increasing user retention and driving higher conversion rates. Learn More: Dynamic Incentives Guide

  • Customize User Experiences with Wallet-Based Personalization: Leverage insights from blockchain interactions to deliver a unique experience for each user. Enhance satisfaction with relevant content and improve onboarding by adapting to individual needs. Learn More: Wallet-Based Personalization Guide

Next Steps​

  1. Get Your API Key: You'll need an API key to authenticate your requests. Sign up for free on our Developer Portal to obtain one.
  2. Visit the GitHub Repository: Follow the instructions in the GitHub README to install and set up the SDK.
  3. Explore SDK Documentation: The GitHub repository contains detailed information on installation, initialization, usage examples, and SDK functions.

Additional Resources​

  • GitHub Repository: For more detailed documentation, advanced usage, and the latest updates, visit our GitHub repo.
  • API Reference: Access the full API documentation.
  • Developer Portal: Manage your API keys and account settings on the Developer Portal. If you don’t have an account, sign up for free.

Support​

If you encounter any issues or have questions:

FAQs​

What tool should I use to access & leverage Wallet Intelligence?​

We offer several tools to help you access, explore, and integrate Wallet Intelligence data based on your role and specific needs.

Integration Tools​

Use these tools if you’re looking to integrate Wallet Intelligence data directly into your applications for deeper, customized interactions.

⚙️ REST API
Best for developers who need to integrate Wallet Intelligence data directly into their applications or services. If you require high customization and control over the data, the REST API is your go-to. Ideal for building custom analytics, dashboards, or in-app features. Learn more here.
🔗 gRPC API
For performance-focused integrations, the gRPC API offers a more efficient, low-latency way to access Wallet Intelligence data. This is ideal for applications that need rapid, real-time data access, such as live dashboards or interactive user experiences. Learn more here (placeholder link).
🧰 JavaScript SDK
Great for developers who want an integrated way to work with Wallet Intelligence data within their codebase. The SDK provides pre-built functions and methods, making integration with Thirdwave smoother and faster. Perfect for those looking to streamline code and speed up development. Learn more here.

Visualization Tools​

These tools are ideal for quick data exploration and visualization, providing insights into wallet data without extensive coding or integration.

💻 Command Line Interface (CLI)
Perfect for users who prefer a quick and easy way to visualize data in the terminal. The CLI provides straightforward access for lookups, managing configurations, and simple automation tasks. Ideal for ad-hoc queries or setting up automated data retrieval scripts. Learn more here.
📊 Audience Explorer
An intuitive visual tool for non-technical users or analysts looking to explore wallet data. Upload a list of wallets to see a dashboard summarizing insights for that cohort. Ideal for analyzing wallet demographics, behavior trends, and segmentation. Explore here.

Do I need an API key to use the SDK?​

Yes, an API key is required to authenticate your requests. You can obtain an API key for free by going to Thirdwave Lab's homepage to sign up and create an access key.