Build · API & SDK

Build a custom experience on Claimr's campaign platform

Use the REST API for server-side operations and the SDK for supported client-side integration and Widget control.

REST API

User & wallet dataRewards & pointsReferralsCampaignsWebhooks

SDK

connect_wallet()complete_task()login()on_points_updateon_user_info

Two ways to build with Claimr

Pick server-side, client-side, or both — the same infrastructure sits underneath either path.

REST API

Server-side integration — read user and wallet data, award XP, manage referrals and invite codes and subscribe to webhooks.

User & wallet dataRewards & pointsReferralsCampaignsWebhooks
View API Reference

SDK

Client-side integration — control the Claimr Widget from your own code and react to user events as they happen.

connect_wallet()complete_task()login()on_points_updateon_user_info
View SDK Guide

Two integration surfaces, one backend

  1. 01

    REST API

    Server-side calls to read user data, award rewards, manage referrals and invite codes and register webhooks.

  2. 02

    SDK

    Client-side methods and event callbacks to control the Widget and react to user actions in your own UI.

  3. 03

    Shared engine

    Both surfaces read and write against the same tracking, intelligence and automation engine as the Widget.

  4. 04

    Webhooks

    Register once and get notified the instant a tracked event fires, instead of polling for changes.

What's covered

User & wallet data

Fetch user profiles, XP balances, activity and wallet-linked referral IDs.

Rewards & points

Award XP and process point withdrawals programmatically.

Referrals & invite codes

Set referrers, check invite code status and pull referral data.

Campaigns & leaderboards

Read campaign info, stats and leaderboard standings.

Custom events

Push custom product events and stream values into Claimr.

Widget control

Call SDK methods and hook into Widget events from your own frontend code.

Frequently asked questions

No — the REST API and SDK are independent. Use the API alone for backend integrations, or add the SDK when you also want to control the Widget from your own frontend.

Build it your way