FRP LogoFuture Reportbot

Basics

Welcome to the documentation for our HTTP API. Below you'll find the essential details for interacting with the API, including the base URL, versioning, available methods, authentication headers, and some known limitations.

🛠 Base URL

All requests to the API should be made to the following base URL:

https://api.fbot.cc/v1
  • Future updates may introduce new versions (e.g., v2), which will be announced in advance.
  • Ensure that you're using HTTPS for all communications with the API to guarantee data security.

🔑 Authentication

All API requests must include authentication headers. We use token-based authentication. You should provide your token in the request headers:

Authorization: Bearer <your-frp-key>

Example requests:

  fetch('https://api.fbot.cc/v1/stats', {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer <your-frp-key>'
    }
  })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error(error))

Without proper authentication, you will receive a 401 Unauthorized response.


⚠️ Known Limitations

  • Rate Limiting: The API enforces rate limiting to prevent abuse. Each client can make up to 100 requests per minute. Exceeding this limit will result in a 429 Too Many Requests error.

  • Error Handling: The API always returns a JSON response, and will contain a success and message field in all request. If an error occurs, the success field will be false, and the message field will contain a brief description of the error. ex:

{
  "success": false,
  "message": "Invalid Steam ID"
}

On this page