Currently Limited to Highlight
This API currently only works with NFTs deployed through Highlight on EVM networks. We’re working on expanding support to other NFT platforms, so if you have a specific request let us know.Server wallets need to be manually set up for each user. Contact us to get your server wallet configured.Simulate vs Execute: GET vs POST
The API provides two modes of operation:- GET (Simulate): Returns transaction calldata without executing - perfect for previewing costs and validating parameters
- POST (Execute): Actually executes the mint transaction using your server wallet
Getting Transaction Calldata (Simulate)
Use the GET endpoint to preview what the mint transaction will look like:Executing the Mint Transaction
To actually mint the NFT, use the POST endpoint with your server wallet:Async vs Sync Execution
You can choose how to handle transaction execution:Sync Mode (Recommended)
Setasync: false
to wait for transaction confirmation and get the receipt:
Async Mode
Setasync: true
to get the transaction hash immediately and check status separately, will not work with large recipient lists:
Batch Minting
Mint to multiple Farcaster users in a single API call:Server Wallets
Server wallets are managed wallets you top up with funds that execute transactions on your behalf. Benefits include:- No gas management: We handle gas estimation and payment
- Reliable execution: Built-in retry logic and error handling
- FID resolution: Automatically resolves Farcaster IDs to wallet addresses
Getting Set Up
To use this API, you’ll need:- A server wallet configured by our team
- Your
x-wallet-id
header value - An NFT contract deployed on Highlight
- Native gas tokens on the network of your choosing (top up the address we setup for you)
Error Handling
If you don’t include the requiredx-wallet-id
header, you’ll get:
transaction_hash
or fail with an error
field.
That’s it! You’re now ready to reward your Farcaster community with NFTs using just their FIDs.
Enjoy building! 🚀
For additional help, feel free to contact us.