steam-api is a Python library for interacting with the Steam Web API. It provides easy-to-use asynchronous functions for retrieving various Steam user details, such as total playtime, Steam ID, owned games, profile picture, level, badges, and country flag.

• Retrieve total playtime for a user
• Resolve Steam vanity URLs to Steam IDs
• Get the number of owned games
• Fetch profile picture and profile URL
• Get player level and badges
• Retrieve country flag based on user location

You can install steam-api using pip. If you want to use the latest development version, you can install it from the repository.

pip install steam-api

Clone the repository and install it in editable mode:

git clone https://github.com/Xhand98/steam-api.git
cd yourrepository
pip install -e .

First, set up your environment with the Steam API key:

export STEAM_API_KEY='your_api_key_here'

Here is a basic example of how to use the steam-api library:

import asyncio
from steam-api import SteamAPI

async def main():
    api_key = "your_api_key_here"
    steam-api = SteamAPI(api_key)
  
    steam_id = "76561198006409530"  # Replace with actual Steam ID

    try:
        hours = await steam-api.get_hours(steam_id)
        print(f"Total hours played: {hours}")

        steam_id_resolved = await steam-api.get_steamid("vanity_url_here")
        print(f"Resolved Steam ID: {steam_id_resolved}")

        games_count = await steam-api.get_games(steam_id)
        print(f"Number of owned games: {games_count}")

        pic_info = await steam-api.get_pic(steam_id)
        print(f"Profile picture URL: {pic_info['avatar']}")
        print(f"Profile URL: {pic_info['profileurl']}")
        print(f"Persona name: {pic_info['personaname']}")

        level = await steam-api.get_level(steam_id)
        print(f"Player level: {level}")

        badges_count = await steam-api.get_badges(steam_id)
        print(f"Number of badges: {badges_count}")

        country_flag = await steam-api.get_country(steam_id)
        print(f"Country flag: {country_flag}")

    finally:
        await steam-api.close_client()

# Run the async main function
asyncio.run(main())

For detailed information on available functions and their parameters, refer to the source code or the docs.

If you want to contribute to steam-api, please follow these guidelines:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes and commit (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

This project is licensed under the MIT License. See the LICENSE file for details.

For any questions or issues, please open an issue on the GitHub repository or contact [email protected].