Use Cases

Use Case 1: Look up Icebreaker data for any wallet or Farcaster address

Want to learn context about a wallet address or fid? You can easily look up information that a user has set up on their Icebreaker profile connected to their wallet or fid.

For example, see all of the verifiable credentials associated with this user to enhance or gate your product experience.

Request

curl --request GET \
     --url https://app.icebreaker.xyz/api/v1/ens/j4ck.eth \
     --header 'accept: application/json'

Response

{
  "profiles": [
    {
      "profileID": "0xABC123...",
      "walletAddress": "0xABC123...",
      "avatarUrl": "https://app.icebreaker.xyz/avatar/0xABC123...",
      "displayName": "Jack",
      "bio": "I'm a software engineer",
      "location": "San Francisco, CA",
      "channels": [
        {
          "type": "ENS",
          "isVerified": true,
          "isLocked": false,
          "value": "j4ck.eth",
          "url": "https://app.ens.domains/j4ck.eth"
        }
      ],
      "credentials": [
        {
          "name": "IcebreakerEAS",
          "chain": "ethereum",
          "source": "IcebreakerEAS",
          "reference": "0xABC123..."
        }
      ]
    }
  ]
}

Use Case 2: Sign in with Icebreaker

Allow a user to bring all of their Icebreaker information directly into your application with Sign In With Icebreakerthrough Privy!

Privy embedded wallets can be made interoperable across apps. In this setup, embedded wallets foster a cross-app ecosystem where users can easily port their embedded wallets from one app to another.

Using cross-app wallets, users can seamlessly move assets between different apps and can easily prove ownership of, sign messages, or send transactions with their existing embedded wallets.

You can learn more about how this works and the integration process by visiting Privy's Docs

Use Case 3: Embed Icebreaker in your app

Want to enrich your user's profile in your application? You can use your API to import a user's connected social accounts to make your profile's better! By embedding Icebreaker, you can seamlessly integrate and display a user's verified social accounts. This not only provides a richer user experience but also helps in building a more connected and interactive community within your app. With a single API call, you can unlock a wealth of social data to elevate your users' profiles.

Bountycaster using Icebreaker data to enrich profiles

Use Case 4: Enhance event experiences

Icebreaker allows you to both retrieve and post data about a given wallet address and event. Want to get more context about if a user attended an event and whether they connected with other's at the event? Or share your event data with the wallet address to provide proof of attendance?

Furthermore, we can also make suggestions for who users should meet at a given event through our Who To Meet recommendation engine. Display these inside of your application to help your users meet exceptional people!

All of this is possible with Icebreaker APIs!

Request

curl --request GET \
     --url https://app.icebreaker.xyz/api/v1/events/farcon2024/0x794ceC5ee2659859050D29d858CF46191649E1fa \
     --header 'accept: application/json'

Response

{
  "name": "FarCon 2024",
  "description": "Commemorative dynamic NFT for [FarCon 2024](https://farcon.xyz/) in Venice, CA. FarCon is a curated, multi-day experience designed to convene, connect, and celebrate the driving forces behind Farcaster’s ecosystem: all of us. \n\nVenice Beach, May 2 - 5, 2024.\n\nCheck your email, [farcon.xyz](https://farcon.xyz/), or [/farcon](https://warpcast.com/~/channel/farcon) for more information and updates. \n\nPowered by [Unlock Protocol](https://unlock-protocol.com/) x [Icebreaker](https://icebreaker.xyz).",
  "displayProperties": [
    "Attended",
    "Side events",
    "Connections",
    "Checkin badges",
    "Attended FarCon 1",
    "Pass type"
  ],
  "properties": {
    "Attended": "Yes",
    "Side events": 0,
    "Connections": 20,
    "Checkin badges": "1/7",
    "Attended FarCon 1": "No",
    "Pass type": "Summit",
    "Artist": "@heavygweit, @bias",
    "Event location": "Venice Beach, Los Angeles, CA, USA",
    "Event start date": "May 2, 2024",
    "Event end date": "May 5, 2024"
  },
  "animation_url": "https://icebreaker-nft-images.s3.amazonaws.com/farcon2024_4_summit.mp4",
  "image": "https://icebreaker-nft-images.s3.amazonaws.com/farcon2024_4_summit.webp",
  "background_color": "#000000",
  "external_url": "https://farcon.xyz/"
}