Get Loyalty Rules

Authorizations

X-API-KEY

string

header

required

Query Parameters

organizationId

string<uuid>

Unique identifier for the organization to filter by

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId

string<uuid>

Unique identifier for the website to filter by

Example:

"123e4567-e89b-12d3-a456-426614174002"

collectionAddress

string

Address of the collection to filter by

Example:

"0x1234567890abcdef1234567890abcdef12345678"

loyaltyRuleGroupId

string<uuid>

ID of the loyalty rule group to filter results

Example:

"123e4567-e89b-12d3-a456-426614174004"

startingAfter

string

Pagination cursor to start after a specific resource ID

Example:

"123e4567-e89b-12d3-a456-426614174010"

limit

number

default:10

Maximum number of records to return (max 100)

Required range: 1 <= x <= 100

Example:

50

loyaltyRuleId

The IDs of the loyalty rule

Example:

"123e4567-e89b-12d3-a456-426614174001"

isActive

enum<string>

If true this will only return active rules, the rules for which the startTime is in the past and the endTime is in the future

Available options:

true,

false

Example:

true

allotedToUserId

IDs of the users to filter results by

Example:

"123e4567-e89b-12d3-a456-426614174005"

allotedUserGroupId

string<uuid>

ID of the user group to filter results by

Example:

"123e4567-e89b-12d3-a456-426614174006"

isSpecial

enum<string>

If true this will only return special rules, special rules are the rules that are used for anti sybil as honey pot

Available options:

true,

false

Example:

true

includeDeleted

boolean | null

default:false

Whether to include deleted/archived records

Example:

false

Response

200

data

object[]

required

Show child attributes

data.id

string<uuid>

required

Unique identifier for the loyalty rule

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.name

string

required

Name of the loyalty rule

Example:

"Loyalty Rule"

data.description

string

required

Description of the loyalty rule

Example:

"Loyalty Rule Description"

data.endTime

string | null

required

End time of the loyalty rule

Example:

"2023-10-01T12:34:56Z"

data.startTime

string | null

required

Start time of the loyalty rule

Example:

"2023-10-01T12:34:56Z"

data.rewardType

enum<string>

required

Type of the reward

Available options:

points,

multiplier,

badge

Example:

"points"

data.organizationId

string<uuid>

required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.websiteId

string<uuid>

required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174002"

data.type

string

required

Type of the loyalty rule

Example:

"purchase"

data.frequency

string

required

Frequency of the loyalty rule

Example:

"daily"

data.amount

number | null

required

Amount associated with the loyalty rule

Example:

10

data.createdAt

string<date-time>

required

Timestamp when the loyalty rule was created

Example:

"2023-10-01T12:34:56Z"

data.updatedAt

string<date-time>

required

Timestamp when the loyalty rule was last updated

Example:

"2023-10-05T15:30:00Z"

data.deletedAt

string<date-time> | null

required

Timestamp when the loyalty rule was deleted (if applicable)

Example:

null

data.loyaltyRuleChain

Loyalty Rule Chain · object[]

required

Chains attached to the loyalty rule

Show child attributes

data.loyaltyRuleChain.id

string

required

Unique identifier for the rule chain

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.loyaltyRuleChain.name

string

required

Name of the rule chain

Example:

"My Rule Chain"

data.loyaltyRuleChain.loyaltyRuleId

string

required

Unique identifier for the loyalty rule

Example:

"123e4567-e89b-12d3-a456-426614174111"

data.loyaltyRuleChain.loyaltyConditions

object[]

required

Show child attributes

data.loyaltyRuleChain.loyaltyConditions.id

string

required

Unique identifier for the condition

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.loyaltyRuleChain.loyaltyConditions.type

enum<string>

required

Type of the condition

Available options:

rule,

rules,

points,

section,

level,

api,

badge,

badges,

csv

Example:

"rule"

data.loyaltyRuleChain.loyaltyConditions.description

string | null

required

Description of the condition

Example:

"My Condition"

data.loyaltyRuleChain.loyaltyConditions.amount

number | null

required

Amount of the condition

Example:

100

data.loyaltyRuleChain.loyaltyConditions.repeatCount

number | null

required

Number of times the condition must be met

Example:

1

data.loyaltyRuleChain.loyaltyConditions.requiredCount

number | null

required

Number of times the condition must be met

Example:

1

data.loyaltyRuleChain.loyaltyConditions.csvUrl

string<uri> | null

required

URL of the CSV file

Example:

"https://example.com/csv"

data.loyaltyRuleChain.loyaltyConditions.association

object[]

required

Show child attributes

data.loyaltyRuleChain.loyaltyConditions.association.id

string

required

Unique identifier for the association

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.loyaltyRuleChain.loyaltyConditions.association.loyaltyRuleGroupId

string | null

required

Unique identifier for the loyalty rule group

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.loyaltyRuleChain.loyaltyConditions.association.loyaltyRuleId

string | null

required

Unique identifier for the loyalty rule

Example:

"123e4567-e89b-12d3-a456-426614174111"

data.loyaltyRuleChain.loyaltyConditions.association.loyaltyCurrencyId

string | null

required

Unique identifier for the loyalty currency

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.loyaltyRuleChain.loyaltyConditions.association.loyaltyBadgeId

string | null

required

Unique identifier for the loyalty badge

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.loyaltyRuleChain.loyaltyConditions.association.loyaltyRule

object

required

Show child attributes

data.loyaltyRuleChain.loyaltyConditions.association.loyaltyRule.name

string

required

Name of the loyalty rule

Example:

"My Loyalty Rule"

data.collectionAddress

string

Optional address of the collection

Example:

"0x1234567890abcdef1234567890abcdef12345678"

data.mediaUrl

string | null

URL of the media associated with the loyalty rule

Example:

"https://assets.snagsolutions.io/media.png"

data.metadata

Metadata · object

Optional metadata for the loyalty rule

Show child attributes

data.metadata.{key}

object

Show child attributes

data.metadata.{key}.isCheckInOnEveryTxn

boolean

If enabled, the first transaction done on the platform will complete this rule

Example:

true

data.metadata.{key}.onlyNonListed

boolean

Flag indicating whether to include only non-listed items.

Example:

true

data.metadata.{key}.hasPaidFullRoyalty

boolean

Indicates if the full royalty has been paid for items.

Example:

false

data.metadata.{key}.royaltyAddress

string

Wallet address of the user can only be used if userId is not provided

Example:

"0x1234567890abcdef1234567890abcdef12345678"

data.metadata.{key}.royaltyPercentage

number

Royalty percentage of the item.

Required range: 1 <= x <= 100

Example:

5

data.metadata.{key}.hasVerifiedTwitter

boolean

Indicates if the user has a verified Twitter account.

Example:

true

data.metadata.{key}.onlyRewardExistingUser

boolean

Indicates if only existing users are rewarded.

Example:

true

data.metadata.{key}.hasNeverSold

boolean

Indicates if the item has never been sold.

Example:

false

data.metadata.{key}.onlyNative

boolean

Flag indicating whether to include only native tokens.

Example:

true

data.metadata.{key}.hasFillSource

boolean

Flag indicating whether the fill source is included.

Example:

true

data.metadata.{key}.fillSource

string

Fill source of the order for the token sale

Example:

"opensea.io"

data.metadata.{key}.liquidity

Liquidity · object

Liquidity pool details.

Show child attributes

data.metadata.{key}.liquidity.network

enum<string>

Blockchain network of the liquidity pool.

Available options:

abstract,

abstractTestnet,

apechain,

arbitrum,

avalanche,

avalancheFuji,

base,

baseSepolia,

berachain,

berachainArtio,

berachainBepolia,

binance,

bscTestnet,

campTestnet,

fantom,

fantomTestnet,

flowMainnet,

mainnet,

nexusTestnet,

optimism,

polygon,

polygon_mumbai,

skaleNebula,

skaleEuropa,

skaleCalypso,

solana,

sophon,

sophonTestnet,

sui,

superseed,

superseedSepolia,

vanar,

xai,

zksync,

coti,

cotiTestnet,

morph,

morphTestnet,

morphHolesky,

ultra,

ultraTestnet,

nitrograph,

sepolia,

optimism_sepolia,

arbitrumSepolia,

goerli,

optimism_goerli,

arbitrumGoerli,

basecamp,

somnia,

zkverify,

polkadot,

kusama,

flow_cadence

Example:

"mainnet"

data.metadata.{key}.liquidity.protocol

string

Protocol of the liquidity pool.

Example:

"Uniswap V2"

data.metadata.{key}.liquidity.onlyRewardInRangeLiquidity

boolean

Indicates if only in-range liquidity is rewarded.

Example:

true

data.metadata.{key}.liquidity.liquidityPerDay

number

Liquidity provided per day in USD

Example:

1000

data.metadata.{key}.liquidity.customFunction

string

Custom function to calculate the the reward amount based on the liquidity provided per day. X is the reward amount, Y is the liquidity provided per day in USD.

Example:

"x = y * 1000"

data.metadata.{key}.liquidity.calculationType

enum<string>

Calculation type of the liquidity pool.

Available options:

fixed,

custom

Example:

"fixed"

data.metadata.{key}.liquidity.pools

Liquidity Pools · object[]

Array of liquidity pools associated with the rule.

Maximum array length: 20

Show child attributes

data.metadata.{key}.liquidity.pools.id

string

required

Unique identifier of the liquidity pool.

Example:

"0xabcdefabcdefabcdefabcdefabcdefabcdef"

data.metadata.{key}.twitterUsername

string

Twitter username of the user.

Example:

"@example_user"

data.metadata.{key}.twitterUserId

string

Unique identifier of the Twitter user.

Example:

"1234567890"

data.metadata.{key}.twitterHashtag

string

Hashtag associated with the Twitter post.

Example:

"#loyalty"

data.metadata.{key}.enableVerifiedMultiplier

boolean

Flag indicating whether the verified multiplier is enabled.

Example:

true

data.metadata.{key}.verifiedMultiplier

number | null

Multiplier applied to rewards for verified users.

Example:

1.5

data.metadata.{key}.isMultiplierApplied

boolean

Indicates if the multiplier has been applied to rewards.

Example:

true

data.metadata.{key}.onlyKnownUsers

boolean

Flag indicating whether to include only known users.

Example:

false

data.metadata.{key}.firstReferralReward

number | null

Percentage reward given to a user for their first referral.

Example:

10

data.metadata.{key}.referrerReward

number | null

Lump sum reward given to a referrer.

Example:

50

data.metadata.{key}.referrerRewardLoyaltyCurrencyId

string | null

Loyalty currency ID of the referrer reward.

Example:

"1234567890"

data.metadata.{key}.secondReferralReward

number | null

Percentage reward given for a second-level referral.

Example:

5

data.metadata.{key}.enableStreaks

boolean | null

Flag indicating whether streaks are enabled.

Example:

true

Promotional code associated with the rule.

Example:

"PROMO123"

Type of the promotional code.

Available options:

code,

csv,

generate

Example:

"code"

Numbers of the promotional code to be generated.

Example:

10

URL of the CSV file containing promo codes.

Example:

"https://example.com/promo_codes.csv"

data.metadata.{key}.enableJoinDiscordServers

boolean | null

Flag indicating whether joining Discord servers is required.

Example:

true

data.metadata.{key}.discordServersToJoin

Discord Servers to Join · object[] | null

Array of Discord servers, channels, and roles to join.

Show child attributes

data.metadata.{key}.discordServersToJoin.id

string

ID of the Discord server to join.

Example:

"123456789012345678"

data.metadata.{key}.discordServersToJoin.channels

Channels · object[]

Array of Discord channels to join.

Show child attributes

data.metadata.{key}.discordServersToJoin.channels.id

string

ID of the Discord channel.

Example:

"987654321098765432"

data.metadata.{key}.discordServersToJoin.channels.text

string

Phrase of text to be present in the discord message

Example:

"Hello"

data.metadata.{key}.discordServersToJoin.channels.emojis

Emojis · object[]

Array of emojis used in the channel.

Show child attributes

data.metadata.{key}.discordServersToJoin.channels.emojis.id

string

ID of the emoji used in the channel.

Example:

"1f600"

data.metadata.{key}.discordServersToJoin.roles

Roles · object[]

Array of roles to assign in the Discord server.

Show child attributes

data.metadata.{key}.discordServersToJoin.roles.id

string

required

ID of the role in the Discord server.

Example:

"role123"

data.metadata.{key}.streakArray

Streak Array · object[] | null

Array of streak milestones and corresponding rewards.

Show child attributes

data.metadata.{key}.streakArray.streakMilestone

number

required

Milestone required to achieve the streak.

Example:

5

data.metadata.{key}.streakArray.streakAmount

number

required

Reward amount for achieving the streak milestone.

Example:

10

data.metadata.{key}.dripQuestsToComplete

Drip Quests to Complete · object[] | null

Array of drip quests required to complete the rule.

Show child attributes

data.metadata.{key}.dripQuestsToComplete.id

string

required

ID of the drip quest to complete.

Example:

"drip123"

data.metadata.{key}.collection

Collection · object[]

Array of collections associated with the rule.

Show child attributes

data.metadata.{key}.collection.address

string

Blockchain address of the collection.

Example:

"0xabcdefabcdefabcdefabcdefabcdefabcdef"

data.metadata.{key}.collection.network

enum<string>

Blockchain network of the collection.

Available options:

abstract,

abstractTestnet,

apechain,

arbitrum,

avalanche,

avalancheFuji,

base,

baseSepolia,

berachain,

berachainArtio,

berachainBepolia,

binance,

bscTestnet,

campTestnet,

fantom,

fantomTestnet,

flowMainnet,

mainnet,

nexusTestnet,

optimism,

polygon,

polygon_mumbai,

skaleNebula,

skaleEuropa,

skaleCalypso,

solana,

sophon,

sophonTestnet,

sui,

superseed,

superseedSepolia,

vanar,

xai,

zksync,

coti,

cotiTestnet,

morph,

morphTestnet,

morphHolesky,

ultra,

ultraTestnet,

nitrograph,

sepolia,

optimism_sepolia,

arbitrumSepolia,

goerli,

optimism_goerli,

arbitrumGoerli,

basecamp,

somnia,

zkverify,

polkadot,

kusama,

flow_cadence

Example:

"mainnet"

data.metadata.{key}.collection.multiplier

number

Multiplier applied to the rewards for this collection.

Example:

2

data.metadata.{key}.range

Range · object[]

Array defining ranges and corresponding rewards.

Show child attributes

data.metadata.{key}.range.startRange

number

required

Start value of the range.

Example:

1

data.metadata.{key}.range.endRange

number

required

End value of the range.

Example:

10

data.metadata.{key}.range.amount

number

required

Reward amount for this range.

Example:

5

data.metadata.{key}.range.loyaltyBadgeId

string<uuid>

ID of the loyalty badge for this range.

Example:

"badge123"

data.metadata.{key}.range.loyaltyMultiplierAmount

number

Amount of the loyalty multiplier for this range.

Example:

1.5

data.metadata.{key}.customRewardsApiKey

string

API key for custom rewards integration.

Example:

"api-key-1234"

data.metadata.{key}.link

string | null

Optional link associated with the metadata.

Example:

"https://example.com"

Social media platform associated with the rule.

Available options:

Custom,

Discord,

EpicGames,

Instagram,

Steam,

Telegram,

TikTok,

Twitch,

X(Twitter),

YouTube,

Google,

GitHub

Example:

"X(Twitter)"

Name of the social platform.

Example:

"Twitter"

URL of the social platform's logo.

Example:

"https://example.com/logo.png"

data.metadata.{key}.rewardPerImpression

boolean | null

Flag indicating if rewards are given per impression.

Example:

true

data.metadata.{key}.minQty

number | null

Minimum quantity constraint for token holding.

Example:

1

data.metadata.{key}.maxQty

number | null

Maximum quantity constraint for token holding.

Example:

10

data.metadata.{key}.snapshotProposals

Snapshot Proposals · object[] | null

Array of snapshot proposals for the rule.

Show child attributes

data.metadata.{key}.snapshotProposals.id

string

required

ID of the snapshot proposal.

Example:

"proposal123"

data.metadata.{key}.snapshotProposals.space

string

required

Space associated with the snapshot proposal.

Example:

"space123"

data.metadata.{key}.cta

Call-to-Action · object

Object containing details for the call-to-action.

Show child attributes

data.metadata.{key}.cta.label

string | null

Label for the call-to-action.

Example:

"Click Here"

data.metadata.{key}.cta.href

string | null

Link for the call-to-action.

Example:

"https://example.com"

data.metadata.{key}.hasSaleCurrency

boolean

Flag indicating if the sale currency is included.

Example:

false

data.metadata.{key}.isTokenHoldMultiplier

boolean

default:true

Flag indicating if the token hold multiplier is applied.

Example:

true

data.metadata.{key}.saleCurrency

string

Currency associated with sales.

Example:

"USD"

data.metadata.{key}.isRetroactive

boolean | null

Flag indicating if rewards are applied retroactively.

Example:

true

data.metadata.{key}.timeDelayToVerifySeconds

number

Time delay in seconds to verify actions.

Example:

300

data.metadata.{key}.referralRequirements

Referral Requirements · object

Object defining referral requirements.

Show child attributes

data.metadata.{key}.referralRequirements.points

object

Show child attributes

data.metadata.{key}.referralRequirements.points.amount

number | null

Points required for referral.

Example:

50

data.metadata.{key}.referralRequirements.points.loyaltyCurrecyId

string | null

ID of the loyalty currency for referral.

Example:

"currency123"

data.metadata.{key}.referralRequirements.achievePoints

boolean | null

Flag indicating if achieving points is required.

Example:

true

data.metadata.{key}.referralRequirements.completeProfile

boolean | null

Flag indicating if completing the profile is required.

Example:

false

data.metadata.{key}.referralRequirements.connectTwitter

boolean | null

Flag indicating if connecting Twitter is required.

Example:

true

data.metadata.{key}.referralRequirements.connectDiscord

boolean | null

Flag indicating if connecting Discord is required.

Example:

true

data.metadata.{key}.referralRequirements.connectEmail

boolean | null

Flag indicating if connecting email is required.

Example:

true

data.metadata.{key}.multiplierLoyaltyCurrencyIds

string[] | null

Array of loyalty currency IDs used for multipliers.

Example:

["currency123", "currency456"]

data.metadata.{key}.verifyPlaceHolderText

string | null

Placeholder text for verification input fields.

Example:

"Enter your verification code here."

data.metadata.{key}.verificationTextMinimumLength

integer | null

Minimum length of the verification text.

Example:

10

data.metadata.{key}.buttonText

string | null

Text displayed on the action button.

Example:

"Verify Now"

data.metadata.{key}.telegramChannelId

string | null

ID of the Telegram channel.

Example:

"telegram-channel-123"

data.metadata.{key}.twitterAccountUrl

string

URL of the associated Twitter account.

Example:

"https://twitter.com/example_user"

data.metadata.{key}.twitterPostUrl

string

URL of the associated Twitter post.

Example:

"https://twitter.com/example/status/1234567890"

data.metadata.{key}.checkLike

boolean | null

Flag indicating if liking the post is required.

Example:

true

data.metadata.{key}.checkRepost

boolean | null

Flag indicating if reposting is required.

Example:

true

data.metadata.{key}.checkComment

boolean | null

Flag indicating if commenting is required.

Example:

true

data.metadata.{key}.checkText

Text to check in the Twitter post, username, or bio.

Example:

"loyalty"

data.metadata.{key}.requirePostLink

boolean | null

Flag indicating if the post link is required.

Example:

true

data.metadata.{key}.requirePostMediaLink

boolean | null

Flag indicating if media metadata is required.

Example:

true

data.metadata.{key}.rewardCriteria

enum<string> | null

Criteria to evaluate the reward.

Available options:

IMPRESSIONS_COUNT,

ELIGIBLE_POST

Example:

"IMPRESSIONS_COUNT"

data.metadata.{key}.smartContract

Smart Contract · object

Object containing details of the associated smart contract.

Show child attributes

data.metadata.{key}.smartContract.contractId

string | null

ID of the smart contract.

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.metadata.{key}.smartContract.event

string | null

Event emitted by the smart contract.

Example:

"Transfer"

data.metadata.{key}.smartContract.type

enum<string> | null

default:event

Type of the smart contract interaction.

Available options:

function,

event

Example:

"event"

data.metadata.{key}.smartContract.criteria

enum<string> | null

Criteria to evaluate the smart contract event.

Available options:

everyEvent,

byParameter

Example:

"everyEvent"

data.metadata.{key}.smartContract.params

Smart Contract Parameters · object[] | null

Array of parameters for the smart contract.

Show child attributes

data.metadata.{key}.smartContract.params.name

string | null

Name of the smart contract parameter.

Example:

"value"

data.metadata.{key}.smartContract.params.condition

string | null

Condition to check for the parameter.

Example:

">="

data.metadata.{key}.smartContract.params.value

string | null

Value of the parameter.

Example:

"100"

data.metadata.{key}.smartContract.addressMapping

string | null

Mapping of addresses for the smart contract.

Example:

"0x123...789"

data.metadata.{key}.smartContract.amountMultiplier

Amount Multiplier · object

Object containing details of the amount multiplier from the event.

Show child attributes

data.metadata.{key}.smartContract.amountMultiplier.valueMapping

string | null

Mapping of the value for the smart contract.

Example:

"amount"

data.metadata.{key}.walletType

enum<string> | null

Type of wallet associated with the rule.

Available options:

evm,

solana,

imx,

sui,

ton,

cosmos,

ultra,

agw,

flow_cadence,

substrate

Example:

"evm"

data.metadata.{key}.imageUrl

string | null

URL of the image associated with the rule.

Example:

"https://example.com/image.png"

data.metadata.{key}.trackAllContracts

boolean | null

Flag indicating if all contracts are tracked.

Example:

true

data.metadata.{key}.onlyRewardSingleTokenOwnership

boolean | null

give points for only one token ownership per contract

Example:

true

data.metadata.{key}.skipMultiplier

boolean | null

Flag indicating if the multiplier is skipped.

Example:

true

data.metadata.{key}.completeProfileConditions

Complete Profile Conditions · object

Conditions for completing the profile.

Show child attributes

data.metadata.{key}.completeProfileConditions.{key}

boolean

Example:

{ "twitter": true, "discord": false }

data.metadata.{key}.steamAppId

string | null

ID of the Steam app.

Example:

"1234567890"

data.metadata.{key}.githubRepoUrl

string | null

URL of the GitHub repository to check for star.

Example:

"https://github.com/owner/repo"

data.metadata.{key}.trackProgress

boolean | null

Flag indicating if the progress is tracked. If enabled, the rule can only be completed once the progress is 100%.

Example:

true

data.metadata.{key}.rewardPerAction

boolean | null

Flag indicating if the reward is rewarded per action.

Example:

true

data.metadata.{key}.rewardByBatch

boolean | null

Flag indicating if the reward is rewarded by batch.

Example:

true

data.metadata.{key}.batchSize

number | null

Number of tokens per batch.

Example:

100

data.metadata.{key}.youtubeVideoId

string | null

ID of the Youtube video.

Example:

"1234567890"

data.metadata.{key}.youtubeChannelId

string | null

ID of the Youtube channel.

Example:

"1234567890"

data.metadata.{key}.isRestrictedToNewUsers

boolean

Flag indicating if the rule is restricted to new users.

Example:

false

data.metadata.{key}.rewardBadgePerRange

boolean

Flag indicating if the rule can also reward badges per range.

Example:

false

data.metadata.{key}.swap

Swap Metadata · object

Metadata for swap loyalty rules

Show child attributes

data.metadata.{key}.swap.provider

enum<string>

Available options:

any,

relay,

lifi

data.metadata.{key}.swap.relayReferrerId

string

data.metadata.{key}.swap.tokenMode

enum<string>

Available options:

any,

specific

data.metadata.{key}.swap.swappedToChain

number

data.metadata.{key}.swap.requireCrossChainSwap

boolean

data.metadata.{key}.swap.swappedToTokens

object[]

Show child attributes

data.metadata.{key}.swap.swappedToTokens.address

string

required

data.metadata.{key}.swap.swappedToTokens.chainId

string

required

data.metadata.{key}.swap.trackTokenAmount

boolean

data.metadata.{key}.rewardPerValue

boolean

Flag indicating if the rule should reward based on value of traded tokens instead of count.

Example:

false

data.metadata.{key}.conditionDescription

string

Description of the external rule condition (only for external rules)

Example:

"Complete the specific task on external platform"

data.metadata.{key}.directRpc

boolean

Flag indicating if the rule should use direct RPC to get the balance of tokens.

Example:

false

data.metadata.{key}.erc20Type

enum<string>

Type of ERC20 token for the loyalty rule.

Available options:

erc20,

native

Example:

"erc20"

Example:

{ "key": "value" }

hasNextPage

boolean

required

API Documentation

Asset

Auction

Identity

Loyalty

Badge

Social Posts

Minting

Question

Referrals

Website

Landing Page

Token Claims

Authorizations

Query Parameters

Response