Introduction

The Nekos.moe (opens new window) API allows developers to provide the same features in their applications as we do on the site. Nekos.moe is an open-source website, so if you wish to see exactly how things work visit the API repo (opens new window).

Using the API

WARNING

The Nekos.moe API is still in development. Breaking changes may happen with little warning

All API request use the base URL https://nekos.moe/api/{version}/

API version	Status
v1	Pre-release

All 3rd-party applications using the API should set a user agent that identifies their application.
Example: User-Agent: NekosBot (nekosbot.com, v1.2.4)

Ratelimits

The Nekos.moe API enforces ratelimits to prevent API abuse. Ratelimit information is provided in the headers of all responses to ratelimited endpoints.
All times are in milliseconds.

Examples:

X-RateLimit-Limit: 5
X-RateLimit-Remaining: 3
X-RateLimit-Reset: 1615865451733

X-RateLimit-Limit: 5
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1615865451733
Retry-After: 1354

Authentication

Some requests require authentication. To authenticate with the API you must create an account (opens new window) and obtain it's token.

To obtain your token through the API jump to Auth Routes. An easier method is to log in to that account and grab the token from your browser's local storage.

API tokens should be sent in the Authorization header of requests.