EcoNuker

EcoNuker is a Python library for interacting with the EcoNuker API, which provides routes for items, servers, and more!

The base URLs are: https://econuker.xyz/api and https://beta.econuker.xyz/api (beta version)

PyPi: https://pypi.org/project/econuker/

Installation

You can install the EcoNuker-API library using pip:

pip install econuker

Usage

Initialize a Client or AsyncClient class. Make sure to pass auth_token and beta if needed.

You can now use the client to make requests.

Example

# Python Example
from econuker import Client
beta = True # False
authtoken = None # "your auth token here"

if __name__ == "__main__":
    client = Client(auth_token=authtoken, beta=beta)
    status = client.status()
    print(status.name)

Async Example

# Python Async Example
from econuker import AsyncClient
beta = True # False
authtoken = None # "your auth token here"

if __name__ == "__main__":
    client = AsyncClient(auth_token=authtoken, beta=beta)
    async def asyncfunction():
        status = await client.status()
        print(status.name)
        return status
    asyncio.run(asyncfunction())

Downtime Notifier Example

# Python Downtime Notifier Example
import econuker
from econuker import AsyncClient
beta = True # get notified about downtime of our Beta bot.
authtoken = None

down = False

import guilded # pip install guilded.py
import asyncio
client = guilded.Client()
channelid = "" # the channel you want downtime notifications to be sent to! Make sure your bot has permissions.

async def monitorbot(client:AsyncClient):
    global down
    bot_name = await client.status().name
    while True:
        check = await client.ping()
        if not check:
            if not down:
                channel = await bot.fetch_channel(channelid)
                await channel.send(f'{bot_name} is down!')
                down = True
        if check and down:
            down = False
            channel = await bot.fetch_channel(channelid)
            await channel.send(f'{bot_name} is online!')
        await asyncio.sleep(10)

@bot.event
async def on_ready():
    print(f'Ready! Logged in as {bot.user.name}')
    try:
        client
    except:
        client = AsyncClient(beta=beta, auth_token=authtoken)
        bot.loop.create_task(monitorbot(client))

bot.run('guilded bot token here')

Documentation

For detailed documentation on the EcoNuker API, read https://docs.econuker.xyz/

For detailed documentation on how to use the EcoNuker-API library, please wait while we write it lol.

Methods

A list of methods you can call with either Client or AsyncClient.

• .status() (class StatusData)
  • .name (string)
  • .status (string)
  • .servers (integer)
  • .latency (float)
  • ._raw (dict)
• .ping() (bool)
• .verify(auth_token) (Union(class Token, False))
  • .authtoken (string)
  • .authlevel (string)
  • ._raw (dict)
• .fetch_servers() (class ServersResult)
  • .count (integer)
  • .server_ids (list)
  • ._raw (dict)
• .fetch_server(id) (class ServerResult)
  • .name (string)
  • .id (string)
  • .owner (class Owner)
    • .name (string)
    • .id (string)
    • .nick (Union(string, None))
    • .profile (string)
    • ._raw (dict)
  • .url (Union(string, None))
  • .verified (bool)
  • .created_at (integer)
  • .timezone (string)
  • .slug (Union(string, None))
  • .about (Union(string, None))
  • ._raw (dict)
• .fetch_items(hidden=True) (class ItemsResult)
  • ._raw (dict)
• .fetch_item(id, name) (class ItemResult)
  • .id (string)
  • .name (string)
  • .rarity (string)
  • .description (string)
  • .desc (string)
  • .aliases (list)
  • .price (class ItemPrice)
    • .sell (str)
    • .buy (str)
    • .worth (str)
    • ._raw (dict)
    • ._price_parts (list) ([sell, buy])
  • ._raw (dict)
  • ._data (list)

License

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