Skip to main content
Access to the FNLB Gateway API is free, but currently restricted.To request access, please send a brief description of your use case to support@fnlb.net.Access will not be granted without prior approval.

​
Overview

The Gateway API provides both a REST interface and a persistent WebSocket connection for streaming real-time events related to your bots and accounts. Common use cases include:
  • Tracking your connected bots and their status (online, busy, etc).
  • Monitoring party members and join or leaves.
  • Receiving cosmetic updates as they happen.
  • Building custom dashboards and notification systems.

​
How it Works

The Gateway acts as a bridge between the FNLB backend and your applications. When a bot status changes or a party event occurs, the Gateway captures this information and makes it available via:
  1. REST Interface: Best for on-demand state retrieval (e.g., “Who is in the party right now?”). View REST Docs.
  2. WebSocket (Coming Soon): Best for real-time reactivity (e.g., “Tell me immediately when a friend request is received”).
Using the Gateway reduces the number of calls you need to make to the main API, helping you stay within rate limits.