API Response Codes

When calling this product's API, you may encounter the following response codes. Here are the related error causes and their solutions.

HTTP Protocol CODE

code	msg	Explanation	Solution
0	Success	Data retrieved successfully
40301	Invalid app_id	app_id does not exist	Check console app_id
40302	Unauthorized API	API not authorized	Contact sales to enable API permissions
40303	Invalid Secret	app_secret is incorrect	Check app_secret
40304	IP Restricted	IP not authorized	Add IP to whitelist in console
40001	Invalid Parameter	Parameter error	Parameter format/value error
40002	Missing Parameter	Missing parameter	Missing required parameter
40404	Invalid Path	Path error	Check API documentation
42901	API Rate Limited	API request rate limit reached	API-level rate limit, reduce frequency or upgrade product
42902	Global Rate Limit	Global request rate limit reached	Global rate limit, optimize calling strategy or upgrade product
60000	Network Error	System network exception	Please retry later or contact us urgently
60001	Timeout	Network timeout	Wait 1 minute then retry & check local network & contact us

WebSocket Protocol Error Codes

This document describes the possible error responses you may encounter when using our API to establish WebSocket connections. Each error includes an HTTP status code and a descriptive message to help you identify and resolve connection issues.

Authentication Errors

Missing Parameters (400)

{
    "error": "Missing required parameters: app_id, app_secret"
}

Ensure both app_id and app_secret are provided in the WebSocket connection request

These parameters must be included in the connection URL or headers

Invalid Authentication (401)

{
    "error": "Invalid app_secret"
}

The provided app_secret does not match your app_id

Please verify you are using the correct secret

Access Control Errors

Path Error (403)

{
    "error": "Path not accessible"
}

Your account does not have permission to access this path

Contact sales for verification if you have questions

IP Restriction (403)

{
    "error": "IP not allowed"
}

Your IP address is not in the whitelist

Check your personal console to see if the access IP is configured in the whitelist

Invalid Format (400)

{
    "error": "Invalid sport_id"
}

The provided sport_id format is incorrect

Please check if the sport_id format is correct

Permission Issue (403)

{
    "error": "Sport ID not accessible"
}

Your account does not have permission to access the requested sport_id

Check your subscription plan or contact sales to enable access permissions

Duplicate Subscription (403)

{
    "error": "Duplicate sport subscription from same IP"
}

Your IP address already has a WebSocket connection for this sport_id

Each IP address can only connect once per sport

Need Help?

If you continue to encounter WebSocket connection issues or need clarification on any error messages, please contact the sales team with your app_id and the error message you received.

CODE&Error Codes

API Response Codes#

HTTP Protocol CODE#

WebSocket Protocol Error Codes#

Authentication Errors#

Missing Parameters (400)#

Invalid Authentication (401)#

Access Control Errors#

Path Error (403)#

IP Restriction (403)#

Sport ID Related Errors#

Invalid Format (400)#

Permission Issue (403)#

Duplicate Subscription (403)#

Need Help?#