Quick Links

Forest Docs Creator Playbook Forest Playkit Quickstart Whitepaper

Getting Started

Technical Documentation

Agents

Get agent details GET List agent sessions GET Create a new agent session POST Get session details GET List session messages GET Send a message to the agent POST Retry a message previously sent to the agent PUT Sse Agent GET

Auth

Generate a nonce POST Verify a user's signature POST Refresh user's access token POST Logout user POST

Seeds

Get seed balance for current user GET Get seed ledger activity for current user GET

Tokens

List tokens GET Create a token POST Get token stats GET Get a token GET Update a token PATCH Delete a token DELETE Get token derived stats GET Get token holders GET

Pairs

List pairs GET Search pairs GET Get a pair GET Get OHLCV candles for a pair GET Get recent swaps for a pair GET Get History Pair GET

Vault

List auctions GET Get auction detail GET Get auction bidders GET Get aggregated chart data for an auction GET Get auction activity feed GET Place or increase a bid POST Get current user position GET Request claim signature for auction rewards POST

Projects

List projects GET Create a project POST Get a project GET Update a project PATCH Delete a project DELETE Upload project image POST Batch upload project images POST

App Templates

List app templates GET Get an app template GET

Playables / HTML

Get settings GET Get public playable state GET Authorize an HTML game action POST Issue a single-use identity code POST Invoke generated HTML runtime method POST Submit an HTML game settlement POST Redeem an identity code POST Submit a signed HTML game burn POST Execute an HTML swap session POST Get HTML settlement secret status GET Create or rotate HTML settlement secret POST

Playables

Invoke a sandbox runtime method from the test harness POST Read the sandbox play-money balance GET Get Transactions Html Sandbox Preview GET Get Burns Html Sandbox Preview GET Get Burn Summary Html Sandbox Preview GET Issue an identity code for the sandbox player POST Authorize an action for the sandbox player POST Authorize for the project POST

Playables / Game

Get game balance GET Record a deposit POST Record a vault fund POST Request a claim POST Confirm claim result POST Release claim reservation POST Get player game transactions GET Get player burns GET Get player burn summary GET Get vault funding transactions GET

Playables / Coin Flip

Get settings GET Make a bet POST Get bet history GET

Playables / Lucky Reel

Get settings GET Make a bet POST Get bet history GET

Swap Sessions

Request a swap session transaction POST Create a swap session POST Get current user swap session GET Confirm swap session revoke POST Get project swap sessions GET Get project swap-session executor wallet GET

Buyback

Get next buyback execution time GET Get buyback history for a token GET

Get current user GET Get current user username settings GET Set the current user username PATCH Get or generate the current user referral code GET Get referral stats (seeds earned + referees count) GET Claim being referred by another user POST Mark welcome flow as dismissed POST List current user tokens GET Get portfolio overview GET Get recent portfolio activity GET

Competitions

Get competitions GET Get competition reward stats GET Get competition data by id GET Get user leaderboard stats GET

News

List News GET Get news by slug GET

Ongoing Events

List ongoing events GET

Quests

List active quests for a namespace GET Claim a quest reward POST

Builder

Get builder credit balance GET Claim a confirmed credit purchase POST List builder sessions GET Create a new builder session POST Get builder session GET Trash a builder session DELETE Sse Builder GET Send a builder prompt POST Retry a builder prompt POST

API Reference Record a deposit POST

Record a deposit

Verifies on-chain transaction and records the deposit

POST

/playables/{projectId}/{gameEntity}/deposit

Verifies on-chain transaction and records the deposit

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

projectId*string

gameEntity*string

Game entity slug

Value in

"coinflip"
"luckyreel"
"html"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/playables/string/coinflip/deposit" \  -H "Content-Type: application/json" \  -d '{    "txHash": "string"  }'

{  "balance": "string",  "totalDeposited": "string",  "totalWithdrawn": "string",  "totalWagered": "string",  "totalWon": "string"}

API Reference

Get game balance GET

Returns the computed game balance for the current user

Record a vault fund POST

Verifies on-chain transaction and records a Game Vault funding transfer. Does not affect user game balance.

Record a deposit

200application/json

201application/json

401

500

Record a deposit

200application/json

201application/json

401

500

`application/json`

`application/json`

`application/json`

`application/json`