--- title: "Get a list of Boosts" method: GET path: "/boosts" tags: ["Boost"] --- # Get a list of Boosts `GET /boosts` Accepts pagination, and filter options to return a list of boosts ## Query parameters - `page` integer, nullable — The desired page to return from the query - `pageSize` integer, nullable — The amount of items to return from the query, defaults to 10, and must be <= 100 - `budgetAccount` string — Filter boosts by budget account address(es). Accepts a single address or comma-separated list of addresses - `owner` string — Filter boosts by a specific owner address - `autoboostId` string — Filter boosts by a specific autoboost ID - `chainId` integer, nullable — Only retrieve Boosts for a specific chain ID. You must supply this parameter if also specifying `targetContract` - `targetContract` string — Retrieve rewards configured with actions that target a specific contract i.e., Zora's address for all rewards that require a mint in order to claim a reward. If you supply this parameter, you must also supply chainId - `tokens` string — Retrieve rewards configured with specific token addresses - `distributionChannel` string — Filter boosts by comma separated list of distribution channels - `sortBy` 'active' | 'recently-deployed' — Sort by active or recently deployed - `tokenWhitelist` boolean, nullable — Filter boosts by token whitelist - `actionTemplateOnly` string — Is the Boost action template only, or has a more customized action configuration - `showActiveOnly` string — Is the Boost active only, or has a more customized action configuration ## Response `200` Returns a list of Boosts - object - `boosts` object[], required — An array of rewards matching provided criteria - `id` string, required — System ID in the format chainId:boostCoreAddress:identifier - `action` string, required — The address of the action - `allowList` object, nullable, required — An object containing information on who is elligible to claim incentives - `owner` string, required — The owner of the allow list, who can modify allowed users - `contractAddress` string, required — The contract address of the allow list - `type` 'SimpleAllowList' | 'SimpleDenyList' | 'OpenAllowList' | 'OffchainAccessList', required — The type of the allow list - `addresses` string[], nullable — List of addresses allowed or denied - `boostIndex` string, required — The index of the Boost - `budget` string, required — The address of the backing budget contract - `incentiveCount` string, required — The total number of incentives attached to the Boost - `owner` string, required — The owner of the Boost - `validator` string, required — The address of the validator who can sign claim payloads - `blockTimestamp` string, required — The timestamp of the block in which the Boost was created - `txHash` string, required — The hash of the transaction that created the Boost - `chainId` integer, required — The ID of the chain on which the Boost was created - `actionSteps` object[], nullable — A list of action steps associated with the Boost that must be completed before the Boost's incentives can be claimed - `chainId` integer, required - `claimant` string - `signature` string, required - `signatureName` string, required - `signatureType` 'event' | 'function', required - `actionType` number, required - `targetContract` string, required - `parameters` object, required - `filterType` number, required - `fieldType` number, required - `fieldIndex` number, required - `filterData` string, required - `protocolFee` string, required — A BigInt representing fees to collect on value distribution - `maxParticipants` string, required — Maximum amount of participants allowed - `incentives` union[], required — A list of the incentives associated with the Boost - union - object — An incentive that when claimed, adds the claimant's address to a Boost Protocol AllowList. - `type` 'AllowListIncentive', required — The type of the incentive, in this case "AllowListIncentive" - `allowListAddress` string, required — The address of the allow list to target - `limit` string, required — The maximum number of users that can claim the incentive - object — An ERC20 incentive implementation with reward amounts adjusting dynamically based on claim volume. - `type` 'CGDAIncentive', required — The type of the incentive, in this case "CGDAIncentive" - `asset` string, required — The address of the asset to target - `initialReward` string, required — The initial reward amount that will scale over time - `rewardDecay` string, required — The amount to subtract from the current reward after each claim - `rewardBoost` string, required — The amount by which the reward increases for each hour without a claim (continuous linear increase) - `totalBudget` string, required — The total budget for the incentive - object — A simple ERC20 incentive implementation that allows claiming of tokens - `type` 'ERC20Incentive', required — The type of this incentive, in this case "ERC20Incentive" - `asset` string, required — The address of the underlying token - `strategy` number, required — The strategy for the incentive (POOL=0, RAFFLE=1) - `reward` string, required — The fixed reward amount per claim - `limit` string, required — Maximum number of claims remaining - `claimedAmount` string — The total amount of tokens claimed - `totalClaims` string — The total number of claims made - `totalAmountClaimed` string — The total amount of tokens claimed - `metadata` object, nullable — Additional metadata about the underlying token - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining balance of the underlying token for this incentive - object — A simple on-chain points incentive implementation that allows claiming of soulbound tokens - `type` 'PointsIncentive', required — The type of this incentive, in this case "PointsIncentive" - `venue` string, required — The address of the backing token contract - `selector` string, required — The function selector of the transfer function on the underlying venue contract - `reward` string, required — The fixed amount of points rewarded per claim - `limit` string, required — The maximum number of claims allowed - object — A modified ERC20 incentive implementation that allows claiming of variable token amounts with a spending limit - `type` 'ERC20VariableIncentive', required — The type of this incentive, in this case "ERC20VariableIncentive" - `asset` string, required — The address of the ERC20 token contract - `reward` string, required — The scalar value specifying how much of the claim amount is transferred to the claimant - `limit` string, required — The total amount of tokens that can be claimed - `claimedAmount` string — The total amount claimed - `totalAmountClaimed` string — The total amount claimed - `totalClaims` string — The total number of claims - `metadata` object, nullable — Additional metadata about the underlying token - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining balance of the token for this incentive - object — An ERC20 incentive with variable reward amounts - `type` 'ERC20VariableCriteriaIncentive', required — The type of the incentive, in this case, "ERC20VariableCriteriaIncentive" - `asset` string, required — The address of the ERC20 token used as the asset for the incentive - `reward` string, required — The scalar value to multiply the claim amount by - `limit` string, required — The total token budget for this incentive - `maxReward` string, required — The maximum amount of tokens that can be claimed in a single claim transaction - `criteria` object, required — Criteria determining how to extract the reward value from a transaction, by pulling a number out of either event log data or function arguments - `criteriaType` 0 | 1, required — Extract claimable amount from event data or function arguments - `signature` string, required — The 4 byte signature of the event or function - `fieldIndex` number, required — The index of the function argument, or event log to extract the numerical claimable amount - `targetContract` string, required — The target contract that contains the function or event signature - `claimedAmount` string — The amount of tokens claimed by the user - `totalAmountClaimed` string — The total amount of tokens claimed between all claims - `totalClaims` string — The total number of claims made against this incentive - `metadata` object, nullable — Optional token metadata - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining token balance for this incentive - `rebatePercentage` number — The rebate percentage for the Boost if applicable - object — An ERC20 incentive with variable reward amounts - `type` 'ERC20VariableCriteriaIncentiveV2', required — The type of incentive, in this case, "ERC20VariableCriteriaIncentiveV2" - `asset` string, required — The address of the ERC20 token used as the asset for the incentive - `reward` string, required — The scalar value to multiply the claim amount by - `limit` string, required — The total token budget for this incentive - `maxReward` string, required — The maximum amount of tokens that can be claimed in a single claim transaction - `criteria` object, required — Criteria determining how to extract the reward value from a transaction, by pulling a number out of either event log data or function arguments - `criteriaType` 0 | 1, required — Extract claimable amount from event data or function arguments - `signature` string, required — The 4 byte signature of the event or function - `fieldIndex` number, required — The index of the function argument, or event log to extract the numerical claimable amount - `targetContract` string, required — The target contract that contains the function or event signature - `valueType` 0 | 1, required — The type of value used for the scalar value (RAW or WAD). - `claimedAmount` string — The amount of tokens claimed by the user - `totalAmountClaimed` string — The total amount of tokens claimed between all claims - `totalClaims` string — The total number of claims made against this incentive - `metadata` object, nullable — Optional token metadata - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining token balance for this incentive - `rebatePercentage` number — The rebate percentage for the Boost if applicable - object — An ERC20 incentive with reward amounts pegged to the value of a configured peg asset - `type` 'ERC20PeggedIncentive', required — The type of incentive, in this case "ERC20PeggedIncentive" - `asset` string, required — The reward asset address - `peg` string, required — The address of the peg asset, zero address for the native token - `reward` string, required — The amount of the pegged asset to reward a corresponding amount of the reward asset - `limit` string, required — The total budget of the reward asset - `claimedAmount` string — The total amount of the reward asset claimed - `totalClaims` string — The total number of claims made for this incentive - `totalAmountClaimed` string — The total amount of the reward asset claimed - `metadata` object, nullable — Metadata for the reward asset - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining balance of the reward asset for this incentive - object — An ERC20 incentive with variable reward amounts pegged to the value of a configured peg asset - `type` 'ERC20PeggedVariableCriteriaIncentive', required — The incentive type, in this case "ERC20PeggedVariableCriteriaIncentive" - `asset` string, required — The address of the reward asset - `peg` string, required — The address of the peg asset - `reward` string, required — The amount to scale the pegged asset value to reward a corresponding amount of the reward asset - `limit` string, required — The total reward asset budget - `maxReward` string, required — The maximum reward asset amount that can be claimed in a single transaction - `criteria` object, required — Criteria determining how to extract the reward value from a transaction, by pulling a number out of either event log data or function arguments - `criteriaType` 0 | 1, required — Extract claimable amount from event data or function arguments - `signature` string, required — The 4 byte signature of the event or function - `fieldIndex` number, required — The index of the function argument, or event log to extract the numerical claimable amount - `targetContract` string, required — The target contract that contains the function or event signature - `claimedAmount` string — The total amount claimed - `totalAmountClaimed` string — The total amount claimed - `totalClaims` string — The total number of claims - `metadata` object, nullable — Metadata about the incentive - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining balance of the reward asset spendable by this incentive - `rebatePercentage` number — The rebate percentage for the Boost if applicable - object - `type` 'ERC20PeggedVariableCriteriaIncentiveV2', required — The incentive type, in this case "ERC20PeggedVariableCriteriaIncentiveV2" - `asset` string, required — The address of the reward asset - `peg` string, required — The address of the peg asset - `reward` string, required — The amount to scale the pegged asset value to reward a corresponding amount of the reward asset - `limit` string, required — The total reward asset budget - `maxReward` string, required — The maximum reward asset amount that can be claimed in a single transaction - `criteria` object, required — Criteria determining how to extract the reward value from a transaction, by pulling a number out of either event log data or function arguments - `criteriaType` 0 | 1, required — Extract claimable amount from event data or function arguments - `signature` string, required — The 4 byte signature of the event or function - `fieldIndex` number, required — The index of the function argument, or event log to extract the numerical claimable amount - `targetContract` string, required — The target contract that contains the function or event signature - `valueType` 0 | 1, required — The type of value used for the scalar value (RAW or WAD). - `claimedAmount` string — The total amount claimed - `totalAmountClaimed` string — The total amount claimed - `totalClaims` string — The total number of claims - `metadata` object, nullable — Metadata about the incentive - `id` string, required — The system ID of the token - `chainId` number, required — The chain ID where this token is deployed - `address` string, required — The address of the token - `decimals` number, required — The number of decimal places for the token, typically 18 - `name` string, required — The display name for the token - `symbol` string, required — The token's symbol, "DEGEN" for example - `imageUri` string, required — A URI pointing to an image representing the token - `remainingBalance` string — The remaining balance of the reward asset spendable by this incentive - `rebatePercentage` number — The rebate percentage for the Boost if applicable - `createdAtChainBlockNumbers` object, nullable — A record of the chain block numbers at which the Boost was created - `usdSpend` number — The total USD amount spent on the Boost to fund incentives - `tokenSpend` number — Total token spend amount - `createdAtBlockTimestamp` string, required — The block timestamp at which the Boost was created - `isActive` boolean — Whether the Boost is active and still eligible to be claimed - `availableBudgetUsd` string, nullable — The current available budget for incentives in USD - `templateId` string, nullable — System ID of the template defining what actions must be taken to claim the Boost - `actionTemplateId` string, nullable — System ID for the action template used to create this Boost - `nftImageUri` string, nullable — URI of the NFT image associated with the Boost - `nftName` string, nullable — Name of the NFT associated with the Boost - `boostName` string, nullable — Human readable name of the Boost, typically describing what action must be taken to claim incentives - `projectImageUri` string, nullable — An image URI associated with Boost incentive projects - `tokenImageUri` string, nullable — An image URI associated with Boost incentive tokens - `totalBoosts` integer, required — The total number of rewards matching the provided criteria ## Other responses - `400` — Validation failed --- [API](https://skmtc.dev/boost/apis/boost-v2-api.md) · [All operations](https://skmtc.dev/boost/apis/boost-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/boost/boost-v2-api/revisions/23f55c70a429/schema)