HL Gaming Official Free Fire API — Node.js Client

Official Node.js client for the HL Gaming Official Free Fire API.
Easily fetch player stats, guild info, pet data, and account usage details using your API key.

Installation

Using npm: npm install hl-gaming-official-ff-data

Using yarn: yarn add hl-gaming-official-ff-data

Quick Start

const HLFFClient = require('hl-gaming-official-ff-data');

const client = new HLFFClient({ apiKey: "your-real-api-key", region: "pk" });

client.getPlayerData("9351564274", "yourDeveloperUserUID") .then(data => { console.log("Player Name:", data.result.AccountInfo.AccountName); console.log("Level:", data.result.AccountInfo.AccountLevel); console.log("Guild:", data.result.GuildInfo.GuildName); console.log("Pet:", data.result.petInfo.name); console.log("Usage Left:", data.usage.remainingToday); }) .catch(err => { console.error("API Error:", err.message || err); });

Constructor Options

new HLFFClient({ apiKey: "your-api-key", // REQUIRED region: "pk" // Optional: defaults to "pk" });

Methods

getPlayerData(playerUid, userUid, [region])

Param | Type | Description -----------|--------|----------------------------------------- playerUid | string | Free Fire player UID userUid | string | Your developer UID (to track usage) region | string | Optional: pk, bd, in, etc.

Other available methods:

• getAllData(playerUid, userUid, options)
• getAccountInfo(playerUid, userUid, options)
• getAccountProfile(playerUid, userUid, options)
• getGuildInfo(playerUid, userUid, options)
• getPetInfo(playerUid, userUid, options)
• getSocialInfo(playerUid, userUid, options)
• banCheck(playerUid, userUid, options)
• apiStatus(userUid, options)

Error Handling

All methods return Promises. If the API responds with an error or invalid credentials, you’ll get a proper JavaScript error object with full details.

Security Tips

• Never expose your API Key in frontend/browser apps.
• Use .env to store keys locally and load them via dotenv.

Documentation Links

• Full API Docs: https://www.hlgamingofficial.com/p/api.html
• Free Fire Account Doc: https://www.hlgamingofficial.com/p/hl-gaming-official-free-fire-account.html
• Developers: https://www.hlgamingofficial.com/p/developers.html
• Contact: https://www.hlgamingofficial.com/p/contact-us.html
• Feedback: https://www.hlgamingofficial.com/p/feedback.html

License

MIT License
© 2025 Haroon Brokha / HL Gaming Official