Required Information:

How to find these credentials:

Privy

Snag Docs

Welcome

Overview

Stratus overview

Subscriptions

Webhooks

Get started

Once you're marketplace is live, here’s everything you need to know to announce it to your community! Feel free to insert screenshots of your marketplace throughout the thread to enhance product visibility!

Launch marketplace

Snag API

Snag SDK

This is a list of deprecated APIs with a timeline for removal. We support deprecated APIs for 2 months before permanent removal.

API Deprecation

This endpoint enables you to upload a file to the resource. Returns a presigned URL and the asset's public URL. Call PUT with the file as the body to upload the asset using the presigned URL.

Get Asset upload URL

Returns a list of auction bids with optional filtering and pagination.

Get auction bids

Returns a list of auctions with optional filtering and pagination.

Get auctions

This endpoint is used to get user metadata

Get user metadata

This endpoint is used to create user metadata

Create user metadata

Get users

This endpoint returns the total user count

User count

This endpoint allows you to create a user

Connect a user to User Group

This endpoint allows you to disconnect a user from another user

Disconnect a user from User Group

This endpoint allows you to connect your Twitter account to a Snag account

Connect Twitter

Get loyalty accounts

Returns the user's rank determined by their loyalty points for the specified loyalty currency. This can be a slow operation for large organizations. We recommend caching when possible.

Get the rank of a user based on their loyalty points

Get loyalty currencies

Create a loyalty currency

Get Loyalty Multipliers

Create a new loyalty multiplier for a wallet.

Create Loyalty Multiplier

Delete a loyalty multiplier by its external identifier.

Delete Loyalty Multiplier by External Identifier

Update Loyalty Multiplier

Delete Loyalty Multiplier by ID

Retrieve configured loyalty rule edits with optional pagination and filters

Get Loyalty Rule Edits

Restore Loyalty Rule Edit

Get Loyalty Rule Groups

Retrieve configured loyalty rules with optional pagination and filters

Get Loyalty Rules

Create Loyalty Rule

Update Loyalty Rule

Delete Loyalty Rule

Verify a loyalty rule based on user action and reward them if applicable. This endpoint currently only supports following rule types code_entry, text_input, link_click, discord_member, connect_wallet, check_in, external_rule, drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name, drip_x_text_in_comment, drip_x_tweet, telegram_join

Complete Loyalty Rule

This will return the processing status of quests for a specific user

Get Processing status for a specific user on loyalty rules

Create a loyalty transaction to update account balances.

Create Loyalty Transaction

Fetch loyalty transaction entries for wallets or users, representing account balance changes.

Get Loyalty Transaction Entries

Get Loyalty Rule Chains

This endpoint allows you to fetch badge(s) data.

Get badges (all or by id)

This endpoint allows you to configure a new badge.

Create new badge

This endpoint allows you to update an existing badge.

Update badge (by id)

This endpoint allows you to delete a badge.

Delete badge (by id)

This endpoint allows you to reward a badge for an account

Reward badge for account

This endpoint allows you to revoke a badge from an account

Revoke badge from account

Returns minting assets and any relevant context

Get minting assets

This endpoint allows you to fetch questions for a loyalty rule.

Get questions for a loyalty rule

This endpoint allows you to create a new question.

Create a new question

This endpoint allows you to update an existing question.

Update an existing question

Retrieve responses submitted by the authenticated user, optionally filtered by question IDs

Get user's question responses

This endpoint allows you to submit a response to a question.

Submit a response to a question

This endpoint allows you to create a referral code

Create referral code

This endpoint allows you to get referrals

Get referrals

This endpoint allows you to create a referral user

Create referral user

Returns a list of websites. Includes optional query parameters for filtering and pagination.

Get websites

Create website

Retrieves collections for a specific website.

Get Website Collections

Create Website Collection

Retrieves roles of users for a specific website. If userId is provided, retrieves the role of that specific user for the website.

Get roles of users for a website

Assign roles to users for a specific website

Assign roles to users for a website

Snag supports multiple authentication providers, allowing users to log in via wallets, email and social accounts. Our team will configure authentication for your platform based on the details you provide.

User authentication overview

Dynamic

Thirdweb

Immutable Passport

Sequence Wallet

Auth0

Contact Us

Loyalty Rules

API Reference

User Auth

Admin Dashboard

Explore Snag

This recipe is a quickstart guide to setting up your Snag Loyalty program, covering the loyalty currency configuration and initial rules set up.

Loyalty overview

After you have enabled loyalty program on your admin page, you will need to create a loyalty currency.

Set up loyalty currency

Available loyalty rules

These fields are common across all loyalty rules and define the general properties of a rule. They ensure consistency in rule setup and provide essential metadata for execution.

Rules configuration

Multipliers

Additional context for X (Twitter) rules logic

X rules logic

Create your first rule

Token Hold

Refer Friends

This recipe explains how to create or update user accounts via the Snag API.

Managing user accounts

This recipe explains how to use Snag social integration API to let your users connect their social accounts to their Snag profile.

Managing social accounts

This recipe explains how to submit and verify loyalty rule completion via the Snag API.

Verifying rule completion

This recipe explains how to manually update user loyalty points balances (i.e. not as part of a rule completion or spend action; an example use-case is to reset all user point balances to 0).

Updating balances

This recipe explains the concept of an external rule, how to configure it with Snag and how to issue rewards to your users.

External rules

This recipes explains how to link multiple wallets to allow for aggregate points earning/spending/visiblility.

Multi-wallet support

This recipe explains how to leverage the Snag API to fetch loyalty points balances for your users, which can be used to build features like a leaderboard in your application.

Leaderboards

Internal currency integration

The following will guide you through creating a user profile on Snag powered marketplaces, and the functionality available within profiles.

User profiles

The following will walk you through how to set up a banner.

Banners

The following is a quickstart guide to creating contracts, minting assets, and listing assets on your marketplace frontend as a mint or auction.

User Authentication

Auth Providers

Privy

Required Information:

How to find these credentials:

User Authentication

Auth Providers

​Required Information:

​How to find these credentials:

Required Information:

How to find these credentials: