Introduction

This page defines available functions for the private Nookipedia API. A less intuitive public API is available here.

At this time, we are not accepting new applications for legacy API keys. Please use the link above to learn how to request access to the new API.

Basic API Requests

The most basic request takes the format of a request to:

https://nookipedia.com/api/endpoint/

If your request accepts a parameter (such as a villager name), it can be submitted as such:

https://nookipedia.com/api/endpoint/parameter/

All endpoints return a JSON response. The format of the response data will vary by endpoint, but all endpoints define a "message" attribute that will contain data about the request. If there is an error in a request, an "error" attribute will be defined instead.

For use in debugging and testing, we provide a test endpoint ("test") which optionally can accept a variable. This endpoint will return a message attribute, along with your parameter if provided.

https://nookipedia.com/api/test/

https://nookipedia.com/api/test/Apollo/

API Authorization

For all requests that are not directed at the test endpoint, you are required to specify an API key. This key will be provided to you by Nookipedia staff. The API key may be specified either as a request header (X-API-KEY) or as a query string variable (api_key).

To specify the key as a header element (recommended), set an X-API-KEY header using your HTTP client of choice. Using curl, for example:

curl -H 'X-API-Key: KEY' https://nookipedia.com/api/endpoint/

If you are specifying the API key as a query string variable, it should be placed after the input parameter. If you are not specifying a parameter, you will need to include a trailing slash. For example:

https://nookipedia.com/api/endpoint//?api_key=KEY

https://nookipedia.com/api/endpoint/parameter/?api_key=KEY

Endpoint List