Forest REST API endpoints generated from the OpenAPI schema.
The Forest API is a JSON REST API behind the Forest app: tokens and trading pairs, projects and campaigns, game settlement, the vibe builder, vault auctions, competitions, and account data. This reference is generated from the OpenAPI schema, so every page reflects the current public API surface.
Endpoints marked with a lock require a Bearer JWT obtained by signing in with an Ethereum wallet (SIWE):
Authorization: Bearer <jwt>Sessions are refreshed via POST/auth/refresh and ended with POST/auth/logout.
Endpoints without a lock are public reads and need no credentials.
Game settlement endpoints (burns, settlements, swap session executions, identity redeem) are not called with a user JWT. They are server-to-server and authenticated with an HMAC signature over the raw request body:
X-Forest-Settlement-Signature: v1=<hmac-sha256 of the raw body>The signing secret is issued per project and must never reach a browser or game iframe. See Game Actions for the signing walkthrough.
Errors are JSON with the HTTP status code mirrored in the body:
{
"statusCode": 401,
"message": "Unauthorized"
}Validation failures (400) return message as an array of field-level problems. Codes follow standard HTTP semantics: 401 missing/invalid token, 403 authenticated but not allowed, 404 unknown resource, 409 conflicting write.
List endpoints paginate with query parameters — most commonly page + perPage or limit + offset, with orderBy/direction for sorting. The exact parameters and defaults are listed on each endpoint page.
Every endpoint page has an interactive playground: fill parameters, attach your Bearer token, and send real requests from the browser. Each page also offers Copy Markdown — and the whole API surface is available to AI tools via llms.txt.
Select a resource from the sidebar to get started.