The Stayforge API provides programmatic access to the Stayforge platform via a RESTful interface. This repository serves as the official documentation hub and issue tracker.
- Documentation: Official Guides & API Reference
- Specification: openapi.json / openapi.yaml
- Community: Discord：https://discord.gg/JYFEttnydq
Manage your keys in here: https://dash.stayforge.io/settings/apikeys
Then, Put APIKey to Header X-API-Key:
curl -X GET "https://api.stayforge.net/v1/endpoint" \
-H "X-API-Key: YOUR_API_KEY_HERE" \
-H "Content-Type: application/json"We are currently developing official SDKs for multiple languages, including Node.js, Python, Go, Java, and C#, all generated from and strictly aligned with this OpenAPI specification.
Before the official SDKs are released, you can already start integrating with our APIs by leveraging community-maintained OpenAPI tooling. In particular, for TypeScript projects, we recommend using openapi-typescript to generate type-safe client definitions directly from our OpenAPI schema, enabling rapid and reliable development.
Tip
Need help or found a bug?
For real-time support, join our Discord.
To report bugs or documentation inconsistencies, please open a GitHub Issue.
- 📄 Documentation Metadata – Links and schemas for the official Stayforge API.
- 🐛 Issue Tracking – A centralized place to report bugs or unclear API behavior.
- ✨ Feedback – Suggestions for improving examples or explanations.
We welcome contributions to improve our documentation!
Please use our Issue Templates for:
- Bug Report — For errors or inconsistencies in the documentation.
- Feature Request — For suggestions or improvements.
- Documentation Issue — For unclear, missing, or misleading documentation.
- Fork the repository.
- Make changes (Markdown or schema updates).
- Open a Pull Request with a clear description of the improvement.
Stayforge API Documentation is maintained by the Stayforge Team.