Skip to main content

API Endpoints

Use Ham APIs to build. While we currently do not have an official bounty program we will always reward projects built that enhance the ecosystem. If you've built something like this let us know on Warpcast!

You can also query Ham data using Airstack

Endpoints

Verify the status of a Ham tip or Floaty by cast or tweet ID

GET - https://farcaster.dep.dev/ham/verify-tip/:messageID

Get the leaderboard of Floaty senders for a given token. Replace :tokenAddress with the token contract address and use the page query parameter to paginate results.

GET - https://farcaster.dep.dev/floaties/sent/leaderboard/:tokenAddress?page=1

Get tip information for a given FID including their daily allocation, ham score, HAM balance, and rank

GET - https://farcaster.dep.dev/ham/user/:FID

Get how many Floaties have been tipped for all supported coins. Sorted in descending order by amount tipped.

GET - https://farcaster.dep.dev/floaties/leaderboard

Get leaderboard of users who have received floaties for a given coin.

GET - https://farcaster.dep.dev/floaties/leaderboard/:tokenAddress?page=1

Retrieves all Floaty balances for a specified Ethereum address.

GET - https://farcaster.dep.dev/floaties/balance/:address

Retrieves all Floaty balances for a specified FID.

GET - https://farcaster.dep.dev/floaties/balance/fid/:fid

Returns the Ham list leaderboard in a paginated list format. Use the page query parameter to move through pages.

GET - https://farcaster.dep.dev/ham/ham-scores?page=1