farcaster 0.5.0

farcaster-py is a Python SDK for the Farcaster Protocol

farcaster-py

farcaster-py is a modern Python SDK for the Farcaster protocol

Full documentation can be found here

Installation

pip install -U farcaster

or install with Poetry:

poetry add farcaster

Usage

To use the Farcaster API you need to have a Farcaster account. We will use the mnemonic or private key of the Farcaster custody account (not your main wallet) to connect to the API.

First install dotenv:

pip install python-dotenv # Or 'poetry add python-dotenv'

Next, save your Farcaster mnemonic or private key to a .env file. Now you can initialize the client, and automatically connect to the Farcaster API!

import os
from farcaster import MerkleApiClient
from dotenv import load_dotenv

load_dotenv()

client = MerkleApiClient(mnemonic=os.environ.get("<MNEMONIC_ENV_VAR>"))

print(client.get_healthcheck())

Examples

Get a cast

response = fcc.get_cast("0x321712dc8eccc5d2be38e38c1ef0c8916c49949a80ffe20ec5752bb23ea4d86f")
print(response.cast.author.username) # "dwr"

Publish a cast

from farcaster.models import CastsPostRequest

cast_body = CastsPostRequest(text="Hello world!")
response = fcc.post_cast(cast_body)
print(response.cast.hash) # "0x...."

Get a user by username

response = fcc.get_user_by_username("mason")
print(response.user.username) # "mason"

Get a user's followers using a fid (farcaster ID)

response = fcc.get_followers(fid=50)
print(response.users) # [user1, user2, user3]

Get users who recently joined Farcaster

response = fcc.get_recent_users()
print(response.users) # [user1, user2, user3]

Get your own user object

response = fcc.get_me()
print(response.user.username) # "you"

Recast a cast

response = fcc.recast("0x....")
print(response.cast.hash) # "0x...."

and many, many more things. The full specification can be found on the Reference page.

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.