async-universalis 3.0.1.dev0

A bare-bones wrapper package to utilitize Universalis API in python.

Universalis API wrapper

A simple and light weight wrapper for Universalis marketboard information.

Key Features

• Pythonic API wrapper using async and await functionality.
• Support for bulk item searching.
• JSON Responses are converted into useful classes.
  • Listings and History are sorted by timestamp.
• The ability to search by Final Fantasy 14 DataCenters or World.

Currently Supported Endpoints

• https://docs.universalis.app/#current-item-price
  • UniversalisAPI.get_current_data() and UniversalisAPI.get_bulk_current_data()
• https://docs.universalis.app/#market-board-sale-history
  • UniversalisAPI.get_history_data() and UniversalisAPI.get_bulk_history_data()

Example

A basic example of usage.

• We are looking up a single item (Fire Cluster[14]) for the Final Fantasy 14 World Zalera,

import aiohttp
from universalis import UniversalisAPI, World


async def sample() -> None:
    item_id = 14  # Fire Cluster
    # You only need to pass in a aiohttp.ClientSession if
    # you already have one you are using elsewhere in your code base or have a Pool/etc..
    session = aiohttp.ClientSession()
    market = UniversalisAPI(session=session)

    # You are able to limit the number of listings and history results by setting
    # "num_history" or "num_listing".
    entries = 50

    # You can filter the data prior by only getting a specific Final Fantasy 14 World
    # By default it will search an entire Datacenter which can be accessed via `<UniversalisAPI>.default_datacenter`
    # Or you can pass a WorldEnum object as the `world_or_dc` parameter.
    world = World.Zalera
    cur_data: CurrentData = await market.get_current_data(
        item=item_id,
        num_history_entries=entries,
        num_listings=entries,
        world_or_dc=world,
    )

    # Maybe you want the single cheapest listing, simple call `sort_listings` and get the first entry.
    sorted_list: list[CurrentDataEntries] = sorted(cur_data)
    cheapest: CurrentDataEntries = sorted_list[0]
    # Then the most expensive listing would be at the end.
    # Example: expensive: CurrentDataEntries = sorted_list[-1]
    # CurrentDataEntries has a pre-defined `__repr__()` and `__str__()`` to return useful attributes if desired.
    print(cheapest.world_name, cheapest.price_per_unit, cheapest.quantity)
    # or
    # print(cheapest)

    # You can also get the most expensive entry by setting
    # the reverse parameter to "True". Thus flipping the order of the listings.
    sorted_list = sorted(cur_data, reverse=True)
    expensive: CurrentDataEntries = sorted_list[0]
    print(expensive)


# This example shows using it as a context manager.
async def sample_two() -> None:
    item_id = 14 # Fire Cluster
    async with UniversalisAPI() as market:
        # By default any searches will use `Datacenter.Crystal`
        res: CurrentData = await market.get_current_data(item=item_id)
        print(sorted(res.listings))
 

Additional Information

See Universalis docs for more information.

Need Help? -> Feel free to create an Issue~