_images/Nookipedia_Leaf.png

async-nookipedia

Welcome to the async-nookipedia docs. An API wrapper for the private Nookipedia API for the Nookipedia Wiki.

async-nookipedia is not created or managed by nookipedia.

Installation

async-nookipedia can be installed via pip as it’s available on pypi.

pip install async-nookipedia

Basic Usage

import asyncio
from nookipedia import Nookipedia


api_key = "API_KEY"

async def main():
    api = Nookipedia(api_key=api_key, cached_api=True)
    villager = await api.get_villager('marshal')
    print(villager.name)
    bug = await api.get_bug('spider')
    print(bug.name)
    fish = await api.get_fish('sea bass')
    print(fish.name)


loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Caching

If cache_api=True is used the API requests made to nookipedia will be automatically stored in-memory until the “api-cache-expire” time is reached.

“api-cache-require” is a timestamp for when the cache on nookipedia’s end expires.

API Reference

Indices and tables

Issues and Support

If you’re having any issues with the API wrapper open an Issue on github or send me a DM on discord - maku#0001.