Foundry REST API

Foundry REST API bridges your Foundry VTT world to a relay server over WebSocket, exposing your world data - actors, items, scenes, rolls, macros, chat, and more - through a clean REST API. Build dashboards, Discord bots, Stream Deck / MIDI triggers, automations, and other integrations.

Video walkthrough: Sign-up, self-hosting, and building integrations

How to use

• Install this module and enable it in your world.
• Get a free API key from the public relay at foundryrestapi.com - or self-host your own.
• In Module Settings, enter your API key and the relay URL (wss://foundryrestapi.com).
• Read the documentation for every endpoint.

Join the Discord · Relay server & docs