Introduction
Authentication
This API uses the OAuth2 Client Credentials flow for authentication. For more details, refer to the OAuth2 Client Credentials documentation.
- API client credentials will be provided via email.
- The JSON response will contain an access token, which must be included in all subsequent requests as an
Authorization
HTTP header. - If any request returns a
401
or403
status code, the access token is either invalid or expired and must be regenerated. - API accounts can be restricted to access specific data only. If a GraphQL query or subscription attempts to access unauthorized data, the API will return an unauthorized error.
Versioning
All API routes follow the CalVer versioning scheme.
- Version format:
YYYY-MM-DD
- Each breaking change results in a new version to maintain backward compatibility with previous versions.
- The documentation supports version switching in the top menu.
- All changes are listed in the Changelog.
Rate Limiting
All API routes are rate-limited per API customer.
- The current rate limit is 5 requests per second.
- If the limit is exceeded, the API responds with HTTP status 429 (Too Many Requests).
Communication
All incidents, maintenance updates and deprecation warnings are communicated at ProDB Status Page.
Recommendation
We recommend subscribing to updates to stay informed about any changes.
API Endpoints
Error Response Codes
Scenario | Status Code | Description |
---|---|---|
Internal error | 500 | Internal server error |
Rate limit exceeded | 429 | Too many requests; wait before retrying |
Unauthorized due to IP restriction | 403 | IP not allowed; access restricted by whitelist |
Authentication required but not provided or invalid token | 401 | Authentication failed; valid token required |
Authentication
- URL:
https://api.prodb.eslgaming.com/{version}/oauth/token
- See details in the Authentication section.
GraphQL
Queries
- URL:
https://api.prodb.eslgaming.com/{version}/graphql
- More details in the GraphQL section.
Subscriptions (WebSocket Protocol)
- URL:
https://api.prodb.eslgaming.com/{version}/graphql/ws
- Protocol specification: graphql-ws
Images
-
URL:
https://api.prodb.eslgaming.com/{version}/images/{id}/{resolution}
-
Description: Returns images based on the given parameters.
-
Parameters:
id
(String): Unique identifier of the image, corresponding to theid
field of the Image GraphQL Type.resolution
(String): Desired resolution. Refer to theresolutions
field in the Image GraphQL Type for available resolutions. (Default:THUMB
)
-
Responses:
302
: Image exists in the specified resolution; API redirects to the download link.404
: Image does not exist in the specified resolution.