Get Started
Use your API key from the “Hi, <username>” menu. All responses are JSON.
Resolve Endpoint
GET /api.php?action=resolve&api_key=YOUR_KEY&cfx_url=XXXXXX
Example response:
{ "success": true, "resolved_ip": "123.45.67.89:30120", "hostname": "MyServer", "players_online": 16, "max_players": 32, "geo": { "city": "Toronto", "country": "Canada", "isp": "MyISP" }, "lookup_count": 10 }
Status Codes
- 200 OK — success
- 400 Bad Request — missing/invalid params
- 404 Not Found — couldn’t resolve
- 429 Too Many Requests — rate limit
- 500 Server Error — unexpected
Rate Limits
Free: 20 requests / 5 minutes per key. Premium: unlimited (when enabled).