All Benefits for NFTs by Wallet

get https://www.themiracle.io/api/v1/wallet/{blockchain}/{walletAddress}/benefits

Personalize your application by making benefits available to your users and their specific wallet address. This endpoint includes all benefits gathered from sources coming from Official, Third Party and Community Sources.

Examples

Retrieve benefits for a certain Wallet and certain collection:
Request:

GET https://www.themiracle.io/api/v1/wallet/ethereum/0xB1355446Ca119B5886246C05ee3961613E4D9C6E/benefits
  ?limit=20
  &offset=0
  &benefit=play
  &category=Game Integration
  &collection=Naka
  &validFrom=2023-01-01
  &validTo=2024-12-01
  &contract=0xd774557b647330c91bf44cfeab205095f7e6c367
  &contractSlug=nakamigos
  &expired=0

Explanation:
Parameters Breakdown:

limit=20: Return up to 20 benefits.
offset=0: Start from the first result.
benefit=play: Search for benefits containing "play".
category=Game Integration: Filter by the "Game Integration" category.
collection=Naka: Filter benefits for the "Naka" collection.
validFrom=2023-01-01 and validTo=2024-12-01: Date range filter.
contract=0xd774557b647330c91bf44cfeab205095f7e6c367: Filter by specific NFT contract.
contractSlug=nakamigos: Filter by contract slug.
expired=0: Exclude expired benefits.

Query Params

contract

string

Filter by NFT contract address

collections

array of strings

The collection name. An Array of Collections Names which can take part in this benefit.

collections

contractSlug

string

For EVM collection the contractSlug is the same as on Opensea. For Solana and Ordinals you can find the Slug on MagicEden.

expired

int32

0 excludes expired benefits, 1 includes expired benefits

sortBy

string

Order of the items are returned in the response. Options are: validFrom, validTo, name

sortDirection

string

Allowed values: ASC or DESC

limit

int32

Defaults to 20

Amount of items returned in response. Default and max limit is 20

benefit

string

Search for benefits that match a string in their longtitle. Example: airdrop

category

string

The category identifier. Supported category filters can be found under the "Supported Category Filters" tab.

validFrom

string

Filter by valid from date

validTo

string

Filter by valid to date

offset

int32

Defaults to 0

Use continuation token to request next offset of items.

Responses

xxxxxxxxxx
curl --request GET \
  --url 'https://www.themiracle.io/api/v1/wallet/blockchain/walletAddress/benefits?limit=20&offset=0' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: b7aa19fe-b26b-4cb7-b165-cf0ae8bb77c3'

xxxxxxxxxx
}
{
  "longTitle": "Get highlighted in the weekly \"From The Bodega\" features",
  "longDescription": "Heads up Apes, if you have an MBA license and would like to be highlighted in one of the upcoming weekly “From The Bodega” features along with the monthly spaces:\n\n- Head over to the BAYC Discord (link below)\n- Fill out the pinned form in the Made By Apes channel",
  "thumbnail": "https://pbs.twimg.com/media/GNKKmIzXsAAk5Xn?format=jpg&name=medium",
  "validFrom": "2024-05-08T00:00:00+00:00",
  "validTo": "2048-05-23T00:00:00+00:00",
  "url": "https://discord.com/invite/bayc",
  "location": "Online",
  "actionDate": "2048-05-23T00:00:00+00:00",
  "process": "Go to Discord",
  "collections": [
    {
      "name": "Bored Ape Yacht Club",
      "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
      "chain": "ethereum",
      "url": "https://www.themiracle.io/collections/1055",
      "contractSlug": "boredapeyachtclub"
    }
  ],
  "official": true,
  "timeZone": null,
  "categories": [
    {
      "name": "Licensing"
    }

200200

400400