API Documentation

Everything you need to integrate with the ViceForge Data API.

Interactive API Explorer

Try out every endpoint directly in your browser with our Swagger UI.

All public data endpoints require an API key passed via the X-API-Key header.

curl -H "X-API-Key: vf_live_your_key_here" \
  https://api.rddm.viceforge.app/api/v1/public/locations

1. Create an account at viceforge.app

2. Go to API Dashboard and generate a key

3. Copy your key immediately (shown only once)

4. Include it in every request as X-API-Key header

Tier	Per Minute	Per Day	Webhooks
Free	10	100	0
Basic	100	10,000	3
Pro	1,000	100,000	10
Enterprise	Custom	Unlimited	Unlimited

When rate limited, you'll receive a 429 response with Retry-After, X-RateLimit-Limit, and X-RateLimit-Remaining headers.

Code	Description
400	Bad Request — invalid parameters
401	Unauthorized — missing or invalid API key
403	Forbidden — tier too low for this endpoint
404	Not Found — resource does not exist
429	Too Many Requests — rate limit exceeded (check Retry-After header)
500	Internal Server Error — contact support

All list endpoints support pagination via query parameters:

GET /api/v1/public/locations?page=2&limit=20

Response:
{
  "data": [...],
  "total": 142,
  "page": 2,
  "pages": 8
}

Webhooks deliver real-time events to your server via HTTP POST. Available on Basic+ tiers.

Available events:

Manage webhooks via the API or your dashboard. Failed webhooks are retried 3 times before being disabled.