Free Fire Wishlist Checker API Documentation

Home Developers Loading...

Navigation

Overview

Authentication

Rate Limits & Plans

Supported Regions

Endpoint URL

Parameters

Request Examples

Response Schema

Example Responses

Error Responses

Best Practices

Security Recommendations

Obtaining Credentials

Support & Tester

Overview

The Free Fire Wishlist Checker API is a specialized service provided by HL Gaming Official enabling real-time retrieval of a player’s in-game wishlist items. This service fetches each item’s high-resolution icon URL and the precise release timestamp, consolidates them into a clean JSON payload, and delivers it to your application with sub-200ms latency. Use this API to enrich community portals, fan sites, or tournament dashboards with dynamic wishlist displays—showing which outfits, skins, bundles, or exclusive items a player intends to acquire.

Key Capabilities Include:

• Dynamic Wishlist Retrieval: Instantly fetch the current wishlist array for any valid Free Fire UID and region.
• High-Resolution Icons: Each wishlist item includes a direct URL to the official 512×512 icon asset via our secure image proxy.
• Release Timestamps: Human-readable release dates and times (localized in UTC) for each item, letting you display “New!” badges or sort by newest additions.
• Comprehensive Metadata: The response includes a static credits field acknowledging HL Gaming Official as the data provider, facilitating proper attribution in UIs.

// Example usage in JavaScript:
(async () => {
  const response = await fetch(
    "https://hl-gaming-official-main-v4-api.vercel.app/api" +
    "?sectionName=wishlist" +
    "&useruid=YOUR_DEV_UID" +
    "&api=YOUR_API_KEY" +
    "&uid=12345678" +
    "®ion=SG"
  );
  const data = await response.json();
  console.log("Wishlist Data:", data);
})();
      

Authentication

To securely access the Wishlist Checker API, every request must include the following two credentials:

• useruid — your developer UID, a unique identifier assigned to your HL Gaming Official account.
• api — your secret API key, used to authenticate and authorize your requests.

Important: Both parameters are mandatory. Incorrect or missing values will result in a 403 Unauthorized response.

// Including credentials in a GET request:
?useruid=dev123UID&api=abcDEFkey123

// Including credentials in a POST request:
{
  "sectionName":"wishlist",
  "useruid":"dev123UID",
  "api":"abcDEFkey123",
  "uid":"12345678",
  "region":"SG"
}
      

Rate Limits & Plans

Each developer UID is subject to daily quotas to ensure fair usage and robust performance for all clients. Quotas reset exactly 24 hours after the timestamp of your first successful call in the previous cycle. Use the usage.remainingToday field in every response to monitor your remaining calls and implement graceful fallback logic.

Plan	Calls / 24h	Price (USD/mo)
Free	100	$0
Starter	1,000	$19
Pro	5,000	$49
Enterprise	Unlimited	Contact Sales

Developer Tip: Caching wishlist responses client-side for short intervals (5–10 minutes) can significantly reduce API usage and latency for frequently accessed UIDs.

Supported Regions

The API supports validation and wishlist retrieval across Garena’s global Free Fire server clusters. Specify the region parameter exactly as listed below (case-sensitive).

Code	Region Name	Timezone
IND	India	GMT+5:30
EU	Europe	GMT+1
NP	Nepal	GMT+5:45
BD	Bangladesh	GMT+6
SG	Singapore (SEA)	GMT+8
ME	Middle East (MENA)	GMT+3
TH	Thailand	GMT+7
VN	Vietnam	GMT+7
ID	Indonesia	GMT+7
TW	Taiwan	GMT+8
RU	Russia	GMT+3
PK	Pakistan	GMT+5
US	North America	GMT−5

Note: Using an invalid or unsupported region code will result in a 400 Bad Request error.

Endpoint URL

https://hl-gaming-official-main-v4-api.vercel.app/api
  ?sectionName=wishlist
  &useruid={YOUR_DEV_UID}
  &api={YOUR_API_KEY}
  &uid={FREEFIRE_UID}
  ®ion={REGION_CODE}
      

Supports both GET and POST methods for maximum integration flexibility.

Parameters

Parameter	Required	Type	Description
sectionName	Yes	string	Fixed value: wishlist
useruid	Yes	string	Your HL Gaming Official developer UID
api	Yes	string	Your secret API key
uid	Yes	string	Target Free Fire player UID
region	Yes	string	Two-letter region code (case-sensitive)

Request Examples

GET Example

curl "https://hl-gaming-official-main-v4-api.vercel.app/api?
  sectionName=wishlist
  &useruid=dev123UID
  &api=abcDEFkey123
  &uid=12345678
  ®ion=SG"
      

POST Example

curl -X POST https://hl-gaming-official-main-v4-api.vercel.app/api \
  -H "Content-Type: application/json" \
  -d '{
    "sectionName":"wishlist",
    "useruid":"dev123UID",
    "api":"abcDEFkey123",
    "uid":"12345678",
    "region":"SG"
  }'
      

Response Schema

{
  "source": "Wishlist Service",     // Identifies this service
  "result": {
    "credits": "HL GAMING",          // Attribution string
    "wishlist": [                    // Array of wishlist items
      {
        "icon":        string,       // URL to high-res item icon
        "releaseTime": string        // Human-readable UTC timestamp
      },
      ...
    ]
  },
  "usage": {
    "usedToday": number,             // Calls this cycle
    "dailyLimit": number,            // Plan limit
    "remainingToday": number         // Calls left
  }
}
      

Example Responses

Populated Wishlist

{
  "source":"Wishlist Service",
  "result":{
    "credits":"HL GAMING",
    "wishlist":[
      {
        "icon":"https://.../resource/203000208.jpg",
        "releaseTime":"1/21/1970, 2:20:01 AM"
      },
      {
        "icon":"https://.../resource/203000723.jpg",
        "releaseTime":"1/20/1970, 5:54:39 PM"
      }
      // … additional items …
    ]
  },
  "usage":{"usedToday":10,"dailyLimit":999,"remainingToday":989}
}
      

Empty Wishlist

{
  "source":"Wishlist Service",
  "result":{
    "credits":"HL GAMING",
    "wishlist":[ ]
  },
  "usage":{"usedToday":12,"dailyLimit":999,"remainingToday":987}
}
      

Error Responses

400 Bad Request

{ "error": "Missing required parameters." }

403 Unauthorized

{ "error": "Unauthorized." }

404 Not Found

{ "error": "User not found." }

429 Too Many Requests

{ "error": "Quota exceeded." }

502 Bad Gateway

{ "error": "Wishlist Service unavailable." }

500 Internal Server Error

{ "error": "Internal server error." }

Best Practices

• Cache responses locally for 5–10 minutes when wishlist changes infrequently.
• Validate uid format and region against supported codes before calling.
• Implement exponential backoff for 502 and 500 errors.

Security Recommendations

• Use HTTPS exclusively to protect credentials in transit.
• Store useruid and api securely on server-side environments.
• Rotate your API key every 90 days and revoke old keys promptly.

Obtaining Your Credentials

To get your useruid and api key, log in to the HL Gaming Official portal:

https://www.hlgamingofficial.com/p/api.html
      

1. Navigate to the “API Credentials” section after signing in.
2. Copy the Developer UID into your useruid field.
3. Copy the API Key into your api field.

Tip: Never share or commit your API key in public repositories or client-side code.

Support & API Tester

For interactive testing and developer assistance, use our live tester and support portal:

https://www.hlgamingofficial.com/p/contact-us.html
      

If you encounter any issues or need further help, please contact our support team via Support & API.

Free Fire Wishlist Checker – API Tester

Retrieve any Free Fire player’s wishlist by entering your HL GAMING credentials, the target UID, and region.

Your Developer UID:

API Key:

Free Fire UID:

Region Code:

 Waiting for input...
  

🚫 API Usage Limit: Free plans are limited to 25 API requests per day. This includes all operations such as checking ban status, rank verification, and other related endpoints. To increase your request limit and unlock additional features such as advanced rank metadata, detailed ban history, and real-time moderation integration, please consider upgrading your plan.

HL Gaming Official Free Fire Wishlist Checker API Documentation Documentation © 2025
Contact: Developers | Support