Endpoints

freestuff-api

< Home Donate Dashboard

Search…

Introduction

Endpoints

API Endpoints

All endpoints require authorization. Please read the introduction page for more information.
All successful responses are served in the following format with status 200:
{
    "success": true,
    "data": { ... }
}
All non-successful responses are served in the following format with status other than 200:
{
    "success": false,
    "error": "Error Name",
    "message": "Detailed Description"
}
(Format might vary on restricted access endpoints)
All responses contain the following response headers in addition to the endpoint specific response headers:
X-Server-Time=<timestamp UNIX> The server's timestamp of receiving the request.
X-RateLimit-Limit=<number> The max amount of requests to this endpoint per interval
X-RateLimit-Remaining=<number> The amount of remaining requests to this endpoint
X-RateLimit-Reset=<timestamp UNIX/1000> End of current interval
Retry-After=<number> Optional, only if rate-limited. The amount of seconds to wait before another request to this endpoint.
Public Access Endpoints:
get
https://api.freestuffbot.xyz
/v1/ping
Ping
get
https://api.freestuffbot.xyz
/v1/games/:category
Game List
get
https://api.freestuffbot.xyz
/v1/game/:id/:lookup
Game Details
Restricted Access Endpoints:
post
https://api.freestuffbot.xyz
/v1/game/:id/analytics
Game Announcement Analytic Data

Introduction

Next - v1

Webhooks & Events

Last modified 1yr ago

Copy link

On this page

Public Access Endpoints:

get

Ping

get

Game List

get

Game Details

Restricted Access Endpoints:

post

Game Announcement Analytic Data