ADVERTISEMENT
GameDB: Games Database API Documentation
Welcome to the comprehensive documentation for the
GameDB API endpoint. This API enables you to access a complete database of game details from a trusted data source.
Whether you are searching for a specific game or displaying general video game information, this endpoint provides live summaries, images, and additional metadata.
The API supports customizable queries by accepting dynamic search terms. If a
search parameter is provided, a dedicated /api/games route is used; otherwise, the API defaults to a general search term "video game" via the /api/default endpoint.
All requests are logged and limited by your daily quota, ensuring reliable and secure usage based on your subscription plan.
🚫 Usage Limit Alert: This API is subject to daily usage limits. Refer to the usage object in each response to monitor your quota and upgrade your plan if needed.
🚨 Parameter Restriction: The subSec parameter is not supported for the GameDB endpoint. Omit subSec from your queries to avoid errors.
🚨 Security Warning: Never expose your useruid or api key in client-side code. Always secure these credentials on your server.
Endpoint Parameters
To access the
GameDB API, you must supply the following query parameters:
| Parameter | Requirement | Description |
|---|---|---|
sectionName |
Required | Must be set to gamesDB to access the games database endpoint. |
useruid |
Required | Your unique developer ID used for authentication and quota tracking. |
api |
Required | Your secret API key. Keep it confidential. |
search |
Optional | A search term (e.g., Call of Duty or Zelda). When supplied, detailed results for matching games are returned. |
count |
Optional | Number of results to return. Defaults to 10 if not provided. |
offset |
Optional | Pagination offset (e.g., 0 for the first page, 10 for the next page). |
wikiLang |
Optional | Language code for Wikipedia summaries (e.g., en, es). Defaults to en. |
includeImages |
Optional | Boolean flag (true/false) determining if thumbnail images should be included. Defaults to true. |
summaryLength |
Optional | Maximum character length for game summaries (0 returns the full summary). |
subSec |
Not Supported | Do not include this parameter for the GameDB endpoint. |
Error Responses
{"error":"Missing required parameters"}– Returned when one or more required parameters are omitted.{"error":"Auth Failed! Please Check Your User ID & Try Again.."}– Returned when the provideduseruidis invalid or missing.{"error":"Invalid API key. Obtain an official key from https://www.hlgamingofficial.com/p/api.html"}– Returned when the suppliedapikey does not match our records.{"error":"subSec is not allowed for gamesDB."}– Returned if thesubSecparameter is present.{"error":"Server error or external API issue. Try again later."}– Indicates an internal or upstream error.
API Operations & Use Cases
The
GameDB API supports dynamic search operations for game data via two primary routes:
1. Custom Search Operation:
- If a
searchparameter is provided, the API utilizes the/api/gamesendpoint. -
Returns search-based results including:
title: Game title.summary: A brief summary from Wikipedia.image: Thumbnail image URL.url: Link to the Wikipedia page.credit: Identifier text (set to"Fetched using hl gaming official api").customSearchUrl: A custom URL of HL GAMING OFFICIAL content.
- This operation is ideal when users wish to search and display specific game data.
2. Default Operation:
- If no
searchparameter is provided, the API defaults to a general search using the term "video game". - It calls the
/api/defaultendpoint and returns a generic set of games data. - This operation is perfect for displaying general game listings when no specific query is made.
Note: Always omit the
subSec parameter when querying the GameDB endpoint.
Example API Requests
Use the example requests below as a guide for integrating the GameDB API:
1. Custom Search for a Specific Game:
curl -X GET "https://apis.hlgamingofficial.com/main/games/others/games-database/api?sectionName=gamesDB&useruid=YOUR_USER_UID&api=YOUR_API_KEY&search=Call+of+Duty&count=5&offset=0&summaryLength=120&includeImages=true"
2. Default Request with No Custom Search Term:
curl -X GET "https://apis.hlgamingofficial.com/main/games/others/games-database/api?sectionName=gamesDB&useruid=YOUR_USER_UID&api=YOUR_API_KEY&count=10&offset=0"
Example Output Responses
Here are sample responses you might receive from the GameDB API.
A. Successful Custom Search Operation:
{
"source": "HL Gaming Official",
"endpoint": "gamesDB/gamesDB",
"result": {
"games": [
{
"title": "Call of Duty",
"summary": "Call of Duty is a first-person shooter video game series known for its cinematic single-player campaigns…",
"image": "https://upload.wikimedia.org/...",
"url": "https://en.wikipedia.org/wiki/Call_of_Duty",
"credit": "Fetched using hl gaming official api",
"customSearchUrl": "https://hlgamingofficial.com/search?q=Call%20of%20Duty"
},
{
"title": "Call of Duty: Modern Warfare",
"summary": "Modern Warfare is a modern installment that reinvents multiplayer combat and immersive storytelling…",
"image": "https://upload.wikimedia.org/...",
"url": "https://en.wikipedia.org/wiki/Call_of_Duty:_Modern_Warfare",
"credit": "Fetched using hl gaming official api",
"customSearchUrl": "https://hlgamingofficial.com/search?q=Call%20of%20Duty:%20Modern%20Warfare"
}
// ... additional game objects
]
},
"usage": {
"usedToday": 5,
"dailyLimit": 1000,
"remainingToday": 995
}
}
B. Successful Default Operation (No Search Term):
{
"source": "HL Gaming Official",
"endpoint": "gamesDB/gamesDB",
"result": {
"games": [
{
"title": "Video Game",
"summary": "Video games are electronic games that involve interaction with a user interface…",
"image": "https://upload.wikimedia.org/...",
"url": "https://en.wikipedia.org/wiki/Video_game",
"credit": "Fetched using hl gaming official api",
"customSearchUrl": "https://hlgamingofficial.com/search?q=video%20game"
},
{
"title": "Arcade Game",
"summary": "Arcade games are coin-operated entertainment machines that became popular in the 20th century…",
"image": "https://upload.wikimedia.org/...",
"url": "https://en.wikipedia.org/wiki/Arcade_game",
"credit": "Fetched using hl gaming official api",
"customSearchUrl": "https://hlgamingofficial.com/search?q=Arcade%20Game"
}
// ... additional game objects
]
},
"usage": {
"usedToday": 6,
"dailyLimit": 1000,
"remainingToday": 994
}
}
Obtaining Your Credentials
To use the
GameDB API, you must possess a valid developer useruid and a secret api key.
These credentials are issued during registration and are crucial for authenticating your requests and enforcing your daily quota.
| Credential | Description |
|---|---|
useruid |
Your unique developer identifier, used for API authentication and tracking your usage. |
api |
Your secret API key. Keep this key secure and do not expose it publicly. |
API Usage Examples
Use the sample code below to quickly integrate the GameDB API into your application.
FAQ & Best Practices
Q1: What is the primary purpose of the GameDB API?
A: The GameDB API provides live game details from a centralized database. It allows developers to query game summaries, images, and related data either by a custom search term or by defaulting to general video game information.
Q2: How do I perform a custom search?
A: Include the
search parameter in your request with the desired game title or keyword. When provided, the API routes your query to the dedicated search endpoint.
Q3: What should I do if my daily quota is exceeded?
A: Each API response includes a
usage object displaying your usedToday, dailyLimit, and remainingToday values. Monitor these values and upgrade your plan if necessary.
Q4: How can I secure my API credentials?
A: Always perform API calls from your server-side code. Never expose your
useruid or api key in client-side applications.
Best Practices:
- Cache frequent responses to reduce the number of API calls.
- Gracefully handle error messages by providing a fallback in your application.
- Regularly monitor your API usage and plan for scalability.
- Keep your API credentials secure at all times.
HL Gaming Official GameDB API Documentation © 2025
Contact: Developers | Support
Contact: Developers | Support