API Reference

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.
Language
Credentials
Header
Click Try It! to start a request and see the response here!