AlfaFrens API
Welcome to the AlfaFrens API Documentation
The AlfaFrens API allows you to access AlfaFrens user data, channel subscriptions, and other related information. This documentation provides detailed information on all available endpoints and how to use them.
This API is currently in version 0. It is currently a read-only API giving access to the most important data. We expect to release a more detailed version in the future.
Getting Started
To get started with the AlfaFrens API, you'll need to understand the structure of the API and the various endpoints available. Below, you'll find links to the documentation for each endpoint.
API Endpoints
User Data
- Get User Data by FID: Retrieve user data using their Farcaster ID.
- Get User Data by Address: Retrieve user data using their wallet address.
Channel Ownership
- Check if User is Channel Owner by FID: Determine if a user is the owner of a channel using their Farcaster ID.
Channel Subscriptions
- Check if a User is Subscribed to a Channel: Check if a user is subscribed to a channel.
- Check if User is Subscribed to Channel by FID: Check if a user is subscribed to a channel using their Farcaster ID.
- Get User Subscribed Channels: Retrieve channels that a user is subscribed to.
Channel Data
- Get Detailed Channel Data: Retrieve detailed information about a channel.
- Get Channel Owner: Retrieve the owner of a specific channel.
- Get Owners of Multiple Channels: Retrieve owners of multiple channels.
- Get Detailed Channel Information such as Subscribers and Stakes: Retrieve detailed information about a channel's subscribers and stakes.
- Get Channel Handles Based on Provided Channel Addresses: Retrieve channel handles based on provided channel addresses.
Further Information
For more details on the API, including usage examples and response formats, please refer to the individual endpoint documentation linked above.
We hope you find this documentation helpful. If you have any questions or need further assistance, please ask in the Superfluid Discord channel #dev-support or contact a DevRel team member.
Happy coding with AlfaFrens API!