Skip to content

Setting Up Steam API

This guide will walk you through the process of setting up Steam API for your FiveM server. Having a Steam API key is essential for proper player authentication and Steam-related features.

๐ŸŽฎ Step 1: Getting Your Steam API Key

  1. Visit Steam Dev Portal

    • Go to Steam Web API Portal
    • If youโ€™re not logged in, click โ€œSign Inโ€ at the top right
  2. Register Your Domain

    • In the โ€œDomain Nameโ€ field, enter localhost
    • This is sufficient for FiveM server usage
    • Accept the Steam Web API Terms of Use
    • Click โ€œRegisterโ€
  3. Save Your API Key

    • After registering, youโ€™ll see your API key
    • Copy it and store it securely
    • โš ๏ธ Never share your API key publicly or commit it to public repositories

๐Ÿ”ง Step 2: Server Configuration

  1. Locate Your Server Files
File Structure
๐Ÿ“ Your-Server-Folder
โ””โ”€โ”€ ๐Ÿ“„ server.cfg
  1. Edit server.cfg
    • Open your server.cfg file
    • Add this line:
server.cfg
set steam_webApiKey "YOUR_API_KEY_HERE"
- Replace `YOUR_API_KEY_HERE` with your actual Steam API key

๐Ÿš€ Step 3: Applying Changes

  1. Save Configuration

    • Save the changes to server.cfg
    • Make sure there are no extra spaces in the API key
  2. Restart Server

    • Stop your FiveM server
    • Start it again to apply the changes

โœ… Step 4: Verification Steps

To confirm your Steam API is working:

  1. Start your server and check the console.
  2. Ensure players can connect with their Steam accounts.
  3. Steam identifiers should be visible in player information.

โŒ Common Issues

  • Invalid API Key Format: Ensure no spaces before or after the key.
  • Connection Issues: Verify your server has internet access.
  • Authentication Failures: Confirm the steam_webApiKey line is in the correct location.

Need help? Join our Discord community for support!