> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snagsolutions.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Snag Docs

> Snag is the leading onchain loyalty platform, helping Web3 brands incentivize engagement, automate rewards and track user contributions. Power growth with customizable point-based programs and integrated marketplace features.

<head>
  <script type="application/ld+json">
    {JSON.stringify({
            "@context": "https://schema.org",
            "@graph": [
              {
                "@type": "Organization",
                "@id": "https://www.snagsolutions.io/#organization",
                "name": "Snag Solutions",
                "url": "https://www.snagsolutions.io/",
                "logo": "https://assets.snagsolutions.io/public/docs/snag-logo-dark-no-bg.svg",
                "sameAs": ["https://x.com/Snag_Solutions", "https://www.linkedin.com/company/snag-solutions", "https://github.com/Snag-Solutions"]
              },
              {
                "@type": "WebSite",
                "@id": "https://docs.snagsolutions.io/#website",
                "name": "Snag Docs",
                "url": "https://docs.snagsolutions.io/",
                "publisher": {"@id": "https://www.snagsolutions.io/#organization"}
              },
              {
                "@type": "SoftwareApplication",
                "name": "Snag",
                "applicationCategory": "BusinessApplication",
                "operatingSystem": "Web",
                "description": "Onchain loyalty platform for Web3 brands. Track, evaluate, and reward user engagement across social, onchain, and gaming platforms with 50+ rule types, a rewards shop, and Stratus serverless cloud.",
                "url": "https://www.snagsolutions.io/",
                "offers": {"@type": "Offer", "price": "0", "priceCurrency": "USD"},
                "aggregateRating": {"@type": "AggregateRating", "ratingValue": "4.8", "ratingCount": "50", "bestRating": "5"},
                "author": {"@id": "https://www.snagsolutions.io/#organization"}
              },
              {
                "@type": "FAQPage",
                "mainEntity": [
                  {"@type": "Question", "name": "What is Snag?", "acceptedAnswer": {"@type": "Answer", "text": "Snag is an onchain loyalty platform that helps Web3 brands incentivize engagement, automate rewards, and track user contributions. It provides 50+ built-in loyalty rule types, supports 15+ blockchain networks, and offers 6 authentication providers."}},
                  {"@type": "Question", "name": "What blockchain networks does Snag support?", "acceptedAnswer": {"@type": "Answer", "text": "Snag supports 15+ blockchain networks including Ethereum, Base, Arbitrum, Polygon, ZKSync, Solana, Berachain, ApeChain, SKALE, XAI, HYCHAIN, Camp Network, Vanar Chain, and more."}},
                  {"@type": "Question", "name": "What types of loyalty rules does Snag offer?", "acceptedAnswer": {"@type": "Answer", "text": "Snag offers 50+ loyalty rule types spanning social engagement (X, Discord, Telegram, YouTube, TikTok, Instagram, Reddit, GitHub), onchain actions (token holds, mints, swaps, smart contract events), gaming integrations (Steam, Epic), and custom logic via Stratus serverless functions."}},
                  {"@type": "Question", "name": "Does Snag have an API and SDK?", "acceptedAnswer": {"@type": "Answer", "text": "Yes. Snag provides a comprehensive REST API and a TypeScript SDK (@snagsolutions/sdk) for type-safe integration. The API covers loyalty programs, minting, user management, badges, leaderboards, and more."}}
                ]
              }
            ]
          })}
  </script>
</head>

<video autoPlay muted loop playsInline className="w-full aspect-video" src="https://assets.snagsolutions.io/public/docs/welcome-gif.webm" />

## What is Snag?

Snag is an onchain loyalty and engagement platform that helps Web3 brands track, evaluate, and reward user contributions across social, onchain, and gaming platforms. Brands use Snag to launch white-label loyalty programs with customizable point systems, NFT rewards shops, leaderboards, and achievement badges -- all without writing backend infrastructure from scratch.

Snag provides:

* **50+ loyalty rule types** spanning social quests (X, Discord, Telegram, YouTube, TikTok, Instagram, Reddit, GitHub), onchain actions (token holds, mints, swaps, [smart contract events](/loyalty/rules/contract-event)), DeFi interactions ([Uniswap](https://docs.uniswap.org/) liquidity, [Snapshot](https://docs.snapshot.org/) governance), and custom logic via [Stratus serverless functions](/stratus/functions)
* **15+ blockchain networks** including Ethereum, Base, Arbitrum, Polygon, ZKSync, Solana, Berachain, ApeChain, SKALE, XAI, HYCHAIN, Camp Network, and Vanar Chain
* **6 authentication providers** -- [Dynamic](/user-auth/dynamic), [Thirdweb](/user-auth/thirdweb), [Privy](/user-auth/privy), [Immutable Passport](/user-auth/immutable), [Sequence](/user-auth/sequence), and [Auth0](/user-auth/auth0) -- supporting wallet, email, and social login
* **REST API and TypeScript SDK** ([`@snagsolutions/sdk`](/api-reference/sdk)) for full programmatic control
* **Stratus onchain cloud** with [serverless functions](/stratus/functions), [event subscriptions](/stratus/subscriptions), [gasless relayers](/stratus/relayers), and [ERC-20 token sync](/stratus/onchain-points)

## Introduction

This documentation covers everything you need to integrate Snag's loyalty and marketplace solutions. Whether you're setting up your first loyalty program through the [admin dashboard](https://admin.snagsolutions.io), integrating via the [REST API](/api-reference/introduction), or building custom onchain logic with [Stratus](/stratus/stratus-overview), you'll find step-by-step guides, API references, and code examples here.

## Getting Started

<CardGroup cols={2}>
  <Card title="Set up Overview" icon="rocket-launch" iconType="light" href="setup/setup-overview">
    Launch checklist: branding, hostname, loyalty program, and go-live.
  </Card>

  <Card title="API Reference" icon="code" iconType="light" href="api-reference">
    REST API authentication, endpoints, and base URL configuration.
  </Card>

  <Card title="SDK Reference" icon="box-open" iconType="light" href="api-reference/sdk">
    TypeScript SDK for type-safe interaction with Snag APIs.
  </Card>

  <Card title="Loyalty Program" icon="stars" iconType="light" href="loyalty/loyalty-overview">
    Configure reward programs and automate incentives.
  </Card>
</CardGroup>

## Core Platform

<CardGroup cols={2}>
  <Card title="Stratus" icon="file-code" iconType="light" href="stratus/stratus-overview">
    Serverless functions, event subscriptions, gasless relayers, and ERC-20 token sync.
  </Card>

  <Card title="User Auth" icon="user" iconType="light" href="user-auth/auth-overview">
    Wallet, email, and social login via 6 authentication providers.
  </Card>

  <Card title="Rewards Shop" icon="gift" iconType="light" href="create/rewards-shop">
    Create NFT contracts, mint assets, and list for purchase, auction, or sweepstakes.
  </Card>

  <Card title="Badges" icon="badge-check" iconType="light" href="create/badges">
    Achievement badges that track user progress and gamify engagement.
  </Card>
</CardGroup>

## Key Use Cases

Snag supports a wide range of Web3 engagement strategies:

* **Community growth** -- Reward users for following social accounts, joining Discord or Telegram, and referring friends with trackable referral codes
* **Onchain engagement** -- Incentivize token holds, NFT mints, smart contract interactions, DeFi liquidity provision, and governance participation
* **Gaming integration** -- Track Steam wishlists, Epic account connections, and custom in-game actions via the API
* **Content creation** -- Reward users for posting on X, TikTok, Instagram, YouTube, and Reddit with impression-based multipliers
* **Developer contributions** -- Track GitHub stars, forks, PRs, and collaborator status for open-source projects
* **Custom workflows** -- Build any reward logic with [Stratus functions](/stratus/functions), [external rules](/loyalty/external-rules), or direct API integration

## Developer Resources

<CardGroup cols={2}>
  <Card title="AI Coding Assistant" icon="robot" iconType="light" href="/ai-coding-assistant">
    Connect Cursor, Claude Code, or Copilot to Snag Docs via MCP server for context-aware coding help.
  </Card>

  <Card title="Developer Getting Started" icon="terminal" iconType="light" href="/loyalty/development/getting-started">
    Set up your API key and make your first Snag API call.
  </Card>

  <Card title="Create Rules via API" icon="wand-magic-sparkles" iconType="light" href="/loyalty/create-rule-using-api">
    Automate rule creation and management programmatically.
  </Card>

  <Card title="Leaderboards" icon="ranking-star" iconType="light" href="/loyalty/leaderboards">
    Build dynamic rankings with sorted user balances and pagination.
  </Card>
</CardGroup>

## Common Docs

* [Available loyalty rules](/loyalty/available-loyalty-rules) -- Browse 50+ rule types
* [Rules configuration](/loyalty/rules-configuration) -- Reward amounts, schedules, and evaluation settings
* [Create your first rule](/loyalty/create-your-first-rule) -- Step-by-step tutorial
* [User profiles](/setup/user-profiles) -- Configure profile fields and display settings
* [Rewards shop](/create/rewards-shop) -- NFT contracts, minting, and listings
* [Snag reporting](/data/snag-reporting) -- Looker-powered analytics dashboards
* [Billing FAQ](/billing/faq) -- Usage tracking, payments, and plan management

## Need help?

Visit our [contact us](https://www.snagsolutions.io/contact) page to connect with our team.
