Skip to main content

mcStalker is an Asynchronous API Wrapper for the MCStalker (https://mcstalker.com) API. It uses modern Pythonic structures to efficiently request information. It features optional caching, is modular, and is easy to integrate.

Project description

The MCStalker API Wrapper

Async-Friendly wrapper for the MCStalker API.

N|Solid

SOURCE - https://github.com/TheOnlyWayUp/mcStalkerApiWrapper

Wiki - https://github.com/TheOnlyWayUp/mcStalkerApiWrapper/wiki

Discord - https://discord.gg/bQhzbg27cm


Endpoints currently supported -

  • /stats
  • /searchusername
  • /searchserver
  • /filterservers

YOU NEED AN API KEY TO USE THIS WRAPPER.

You can get a key at https://mcstalker.com/register

Imports -

  • Non Cached
  from mcStalker.mcStalker import Player
  from mcStalker.mcStalker import Server
  from mcStalker.mcStalker import Stats
  • Cached
  from mcStalker.cachedMCStalker import Player
  from mcStalker.cachedMCStalker import Server
  from mcStalker.cachedMCStalker import Stats

Usage -

Stats -

    from mcStalker.mcStalker import Stats #Not cached
    from mcStalker.cachedMCStalker import Stats #Cached
    stats = Stats(apiKey)
    asyncio.run(stats.returnStats() -> Stats._Stats Object)

Player -

    from mcStalker.mcStalker import Player #Not cached
    from mcStalker.cachedMCStalker import Player #Cached
    player = Player(apiKey)
    asyncio.run(player.returnPlayer(username) -> Player._Player Object)

Server -

    from mcStalker.mcStalker import Server #Not cached
    from mcStalker.cachedMCStalker import Server #Cached
    server = Server(apiKey)
    asyncio.run(server.returnServer(ip) -> Server._Server Object)
    asyncio.run(server.returnTopServers() -> [Server._Server Object, Server._Server Object, ...])

Created by TheOnlyWayUp#1231 - https://github.com/TheOnlyWayUp/

MCStalker created by SSouper - https://github.com/SSouper

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcStalker-0.1.7.tar.gz (8.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page