This API lets you perform direct CFX-to-IP lookups, fetch live server details, retrieve player lists, and more. Simply use our endpoints with your assigned API key.
Pro Tip: Append ?cfx_url=XXXXXX
to query your desired server code.
GET /api?action=resolve&api_key=YOUR_API_KEY&cfx_url=XXXXXX
Example Response:
{ "success": true, "cfx_code": "3d3ezo", "resolved_ip": "123.45.67.89:30120", "hostname": "MyServer", "players_online": 16, "max_players": 32, "server_owner": "OwnerName", "geo": { "query": "123.45.67.89", "country": "Canada", "region": "ON", "regionName": "Ontario", "city": "Toronto", "isp": "MyISP", "org": "MyOrganization", "as": "AS1234 MyAS", "asname": "MYASNAME" }, "lookup_count": 10 }
Retrieve an array of players from an IP:port.
GET /api?action=players&api_key=YOUR_API_KEY&server_ip_port=IP:PORT
Response Example:
{ "success": true, "players": [ { "id": 1, "name": "PlayerOne", "ping": 40 }, { "id": 2, "name": "PlayerTwo", "ping": 60 } ] }
Code | Description |
---|---|
200 OK | Successful request |
400 Bad Request | Invalid parameter(s) |
429 Too Many Requests | Rate limit exceeded |
500 Server Error | Internal server error |
Free plan: 20 requests per 15 seconds.
Premium plan: Unlimited requests (coming soon).