Get a user's RewardKit profile

curl --request GET \
  --url https://api-v2.boost.xyz/reward-kit

import requests

url = "https://api-v2.boost.xyz/reward-kit"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api-v2.boost.xyz/reward-kit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.boost.xyz/reward-kit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.boost.xyz/reward-kit"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-v2.boost.xyz/reward-kit")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.boost.xyz/reward-kit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "activeBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "maxRewardUsdValue": 123,
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>",
        "description": "<string>",
        "category": "defi"
      },
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "projectUrl": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "claimCount": 1,
      "totalBudget": "<string>",
      "rewardsDistributed": "<string>",
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "incentiveId": 1,
        "signature": "<string>",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenSymbol": "<string>",
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "chainId": 123,
        "tokenImage": "<string>",
        "decimals": 123,
        "marketCap": 123,
        "priceChange24Hr": 123,
        "volume24Hr": 123,
        "priceUsd": 123,
        "holders": 123
      },
      "verificationLevel": "<string>",
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "claimedBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "maxRewardUsdValue": 123,
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>",
        "description": "<string>",
        "category": "defi"
      },
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "projectUrl": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "claimCount": 1,
      "totalBudget": "<string>",
      "rewardsDistributed": "<string>",
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "incentiveId": 1,
        "signature": "<string>",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenSymbol": "<string>",
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "chainId": 123,
        "tokenImage": "<string>",
        "decimals": 123,
        "marketCap": 123,
        "priceChange24Hr": 123,
        "volume24Hr": 123,
        "priceUsd": 123,
        "holders": 123
      },
      "verificationLevel": "<string>",
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "claimableBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "maxRewardUsdValue": 123,
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>",
        "description": "<string>",
        "category": "defi"
      },
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "projectUrl": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "claimCount": 1,
      "totalBudget": "<string>",
      "rewardsDistributed": "<string>",
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "incentiveId": 1,
        "signature": "<string>",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenSymbol": "<string>",
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "chainId": 123,
        "tokenImage": "<string>",
        "decimals": 123,
        "marketCap": 123,
        "priceChange24Hr": 123,
        "volume24Hr": 123,
        "priceUsd": 123,
        "holders": 123
      },
      "verificationLevel": "<string>",
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "totalClaimedAmountUsd": 1,
  "totalClaimableAmountUsd": 1
}

{
  "error": "<string>"
}

GET

reward-kit

Get a user's RewardKit profile

curl --request GET \
  --url https://api-v2.boost.xyz/reward-kit

import requests

url = "https://api-v2.boost.xyz/reward-kit"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api-v2.boost.xyz/reward-kit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.boost.xyz/reward-kit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.boost.xyz/reward-kit"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-v2.boost.xyz/reward-kit")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-v2.boost.xyz/reward-kit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "activeBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "maxRewardUsdValue": 123,
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>",
        "description": "<string>",
        "category": "defi"
      },
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "projectUrl": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "claimCount": 1,
      "totalBudget": "<string>",
      "rewardsDistributed": "<string>",
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "incentiveId": 1,
        "signature": "<string>",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenSymbol": "<string>",
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "chainId": 123,
        "tokenImage": "<string>",
        "decimals": 123,
        "marketCap": 123,
        "priceChange24Hr": 123,
        "volume24Hr": 123,
        "priceUsd": 123,
        "holders": 123
      },
      "verificationLevel": "<string>",
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "claimedBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "maxRewardUsdValue": 123,
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>",
        "description": "<string>",
        "category": "defi"
      },
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "projectUrl": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "claimCount": 1,
      "totalBudget": "<string>",
      "rewardsDistributed": "<string>",
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "incentiveId": 1,
        "signature": "<string>",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenSymbol": "<string>",
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "chainId": 123,
        "tokenImage": "<string>",
        "decimals": 123,
        "marketCap": 123,
        "priceChange24Hr": 123,
        "volume24Hr": 123,
        "priceUsd": 123,
        "holders": 123
      },
      "verificationLevel": "<string>",
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "claimableBoosts": [
    {
      "id": "8453:0x378632819f39c74c4f56b1429e760739c5fb51b7:1",
      "chainId": 123,
      "incentives": [
        {
          "assetAddress": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "rewardPercentage": 50,
          "rebatePercentage": 7,
          "rewardAmount": "<string>",
          "rewardAmountFormatted": "<string>",
          "maxReward": "<string>",
          "maxRewardUsdValue": 123,
          "rewardUsdValue": 123,
          "tokenSymbol": "<string>",
          "tokenImageUri": "<string>",
          "metadata": {
            "id": "<string>",
            "chainId": 123,
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "imageUri": "<string>"
          }
        }
      ],
      "actionTemplate": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "<string>",
        "actionType": "mint",
        "projectImage": "<string>",
        "description": "<string>",
        "category": "defi"
      },
      "txHash": "<string>",
      "boostName": "<string>",
      "nftImageUri": "<string>",
      "nftName": "<string>",
      "tokenImageUri": "<string>",
      "blockTimestamp": "<string>",
      "projectUrl": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "claimCount": 1,
      "totalBudget": "<string>",
      "rewardsDistributed": "<string>",
      "signature": {
        "claimant": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "incentiveId": 1,
        "signature": "<string>",
        "referrer": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      },
      "actionTokenMetadata": {
        "tokenSymbol": "<string>",
        "tokenContract": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
        "chainId": 123,
        "tokenImage": "<string>",
        "decimals": 123,
        "marketCap": 123,
        "priceChange24Hr": 123,
        "volume24Hr": 123,
        "priceUsd": 123,
        "holders": 123
      },
      "verificationLevel": "<string>",
      "usdDistributed24Hr": 12345.67,
      "usdDistributed1Hr": 1234.56
    }
  ],
  "totalClaimedAmountUsd": 1,
  "totalClaimableAmountUsd": 1
}

{
  "error": "<string>"
}

Query Parameters

budgetAccount

string

Filter boosts by budget account address(es). Accepts a single address or comma-separated list of addresses

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7,0x1234567890123456789012345678901234567890"

owner

string

Filter boosts by a specific owner address

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

autoboostId

string

Filter boosts by a specific autoboost ID

chainId

integer | null

Only retrieve Boosts for a specific chain ID. You must supply this parameter if also specifying targetContract

Required range: x >= 0

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

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

tokens

string

Retrieve rewards configured with specific token addresses

Example:

"chainId:tokenAddress,chainId:tokenAddress:collection,..."

distributionChannel

string

Filter boosts by comma separated list of distribution channels

Example:

"distributionChannel=public,farcaster"

sortBy

enum<string>

Sort by active or recently deployed

Available options:

active,

recently-deployed

tokenWhitelist

boolean | null

default:true

Filter boosts by token whitelist

creatorAddress

string

Filter rewards by a reward's creator address

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

claimantAddress

string

required

Show relevant rewards for this user's address

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

actionType

any

Filter by the type of actions that must be taken to claim the reward, eg: "mint", "swap"

Example:

"swap,mint"

excludeActionType

any

Exclude rewards with these action types, eg: "mint", "swap"

Example:

"mint,create-any-token"

includeTokenMetadata

boolean | null

Include token metadata (price, market cap, etc.) for swap actions. Defaults to false.

Example:

true

Response

Returns a user's RewardKit profile

Rewards and metadata that correspond to the RewardKit for a user's address

activeBoosts

object[]

required

An array of active RewardKit rewards that match a filter criteria, but are not yet claimable or claimed

Show child attributes

claimedBoosts

object[]

required

An array of claimed RewardKit rewards that match a filter criteria

Show child attributes

claimableBoosts

object[]

required

An array of claimable RewardKit rewards that match a filter criteria

Show child attributes

totalClaimedAmountUsd

number

required

The total amount of USD claimed by the user via rewards that match a filter criteria

Required range: x >= 0

totalClaimableAmountUsd

number

required

The total amount of USD claimable by the user via rewards that match a filter criteria

Required range: x >= 0

Get a single RewardKit reward Try to get claim signature without known transaction

⌘I