Introduction

NekoNya's API is a RESTful API, which means that you can use it to get data from our database. The API is open-source and available on GitHub, so you can contribute to it by submitting a pull request.

The API is available at https://nekonya.classydev.fr/api. The current version is v1.

What does it do?

That is a pretty surprising question, as if you're here, you already know what it does. But let's explain it for the newcomers.

The API allows you to essentially get random images of nekos, kitsunes, pats, and more. You can also owoify text and use a cute 8ball to get answers to your most delightful questions.

How to use it?

The API is pretty simple to use. You can use it with any programming language that supports HTTP requests (any library that does it work). Here is an example in JavaScript, using the fetch API:

fetch('https://nekonya.classydev.fr/api/v1/random/neko')
  .then((res) => res.json())
  .then((data) => console.log(data)); // { url: 'https://nekonya.classydev.fr/images/nekos/...' }

You can also use the API with a library like Axios:

axios.get('https://nekonya.classydev.fr/api/v1/random/neko')
  .then((res) => console.log(res.data)); // { url: 'https://nekonya.classydev.fr/images/nekos/...' }

Errors

If an error occurs, the API will return a JSON object with the following properties:

Property	Description
error	The error object.
error.message	The error message.
error.code	The error code.
error.type	The error type. This is useful for the backend itself or if you want to make anything big with the API.

If this error is a validation error, the JSON object will also containe a errors property, which is an array of validation errors (from express-validator#array).

Rate Limit

There is no rate limit currently on the API. However, be aware of cloudflare's rate limit.

What next?

If you think making requests manually is such a hassle, you can use our official clients to make requests easily.

See the most used route documentation here.