Comment on page
⚙
Foraging API
Swagger UI
Access the Foraging APIs
Unlike the other API endpoints that rely on on-chain token IDs for identifying unique NFTs, the off-chain foraging endpoints use a combination of different IDs to return results. It’s important to know which ID to use and when.
An on-chain token ID that can be found using chain explorers.
A universal placeholder that identifies an item in the foraging system before a unique instance of the item being crafted. BaseIDs can be found in the Crafting > Blueprints section of the Appendix documentation (use the HEX Base ID value).
A specific instance of an item in the off-chain foraging game.
When an Item is crafted, the system uses the BaseID to create an InternalID of that item’s instance. When the item is moved on-chain, a TokenID is minted along with it.
Blueprints are minted directly to wallets and so do not have an InternalID.
Some APIs reference time periods displayed as a Unix Epoch. This timestamp can be found by using a converter.
Returns detailed information on bird stats, including traits. The trait details include information on applicable bonuses to foraging, as well as rarity information.
The chikn token ID the operation should be performed on. No token ID lists all birds.
Results page for birds (if no TokenID is specified)
Number of results per page (if no TokenID is specified)
Returns detailed information on bird stats, including traits. The trait details include information on applicable bonuses to foraging, as well as rarity information.
The roostr token ID the operation should be performed on. No token ID lists all birds.
Results page for birds.
Number of results per page.
Returns detailed information on a FarmLand token, including fertility, available item slots, WormFarm information, size, and tile details with breakdowns of resource availability and rarity.
The FarmLand token ID the operation should be performed on.
Returns information on the forage state of a FarmLand token. FarmLand being actively foraged details information sorted by bird including start and end time, bird trait bonuses, and any active items.
The FarmLand token ID the operation should be performed on.
Returns information on a WormFarm associated with a FarmLand token, including depth dug, depth filled with worm, cooldowns, worm deployed, and max worm capacity.
The FarmLand token ID the operation should be performed on.
Lists all wallets that have interacted with the off-chain foraging APIs.
Results page for wallets.
Number of results per page.
Lists the off-chain foraging stats of a wallet, including off-chain token balances, silo capacities, resources used in crafting, and resource balances.
The wallet address the operation should be performed on.
Lists the off-chain Item inventory of a wallet. Item results include the TokenID (if available), the InternalID, the baseID, number of uses, max use, details on the last item use, and crafting costs.
The wallet address the operation should be performed on.
Results page for Items.
Number of results per page.
Lists the results of historical forages by a wallet grouped by bird. Results include the trait bonus of the bird, any equipped bird items, forage start and end time (in Unix timestamp), tiles foraged, the number of rolls per tile, forage results, and claim time.
The wallet address the operation should be performed on.
Results page for history.
Number of results per page.
Limit results to those before the forageEnd time. Note that the time must be converted to a Unix timestamp.
Returns information on blueprints using a BaseID, including supply, crafting costs, description, max forage uses, and type. This endpoint can also be used with an Item BaseID.
The BaseID of the Item or Blueprint the operation should be performed on.
Returns information on blueprints using an on-chain TokenID, including supply, crafting costs, description, max forage uses, and type.
The BaseID of the blueprint the operation should be performed on.
Returns information on items using an on-chain TokenID, including supply, total minted, uses, max uses, description, type, and on which token the Item is equipped.
The TokenD of the Item the operation should be performed on.
Returns information on Items using an InternalID, including supply, total minted, uses, max uses, description, type, and on which token the Item is equipped.
The InternalID of the blueprint the operation should be performed on.
Last modified 1mo ago