Points de terminaison API

URL de base

https://nekos.best/api/:version

Remplacez :version par l'une des versions prises en charge ci-dessous.

Versions

Version

Statut

v2

Actuelle & maintenue

Important

Avant d'effectuer des requêtes, veuillez lire la documentation sur le User-Agent. Toutes les requêtes doivent inclure un en-tête User-Agent correctement formaté.

Points de terminaison

GET /endpoints

Retourne toutes les catégories d'API disponibles et leurs formats de fichiers associés.

Exemple

https://nekos.best/api/v2/endpoints

{
  "neko": { "format": "png" },
  "...": {},
  "wink": { "format": "gif" }
}

TIP

Utilisez ce point de terminaison pour découvrir dynamiquement les catégories prises en charge au lieu de les coder en dur.

---

GET /:category

Retourne une image ou un GIF aléatoire à partir de la catégorie spécifiée, incluant les métadonnées.

Paramètres de requête

Nom	Type	Requis	Description
amount	number	Non	Nombre de résultats à retourner (1 ≤ X ≤ 20)

Défini par défaut sur 1 si non spécifié.

Exemple (résultat unique)

https://nekos.best/api/v2/neko

{
  "results": [
    {
      "artist_name": "John Doe",
      "artist_href": "https://www.example.com/en/users/1234567",
      "source_url": "https://www.example.com/en/artworks/1234567",
      "url": "https://nekos.best/api/v2/neko/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.png",
      "dimensions": {
        "width": 420,
        "height": 690
      }
    }
  ]
}

Exemple (résultats multiples)

https://nekos.best/api/v2/hug?amount=2

{
  "results": [
    {
      "anime_name": "Generic Anime Name",
      "url": "https://nekos.best/api/v2/hug/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.gif",
      "dimensions": {
        "width": 420,
        "height": 690
      }
    },
    {
      "anime_name": "Generic Anime Name",
      "url": "https://nekos.best/api/v2/hug/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.gif",
      "dimensions": {
        "width": 420,
        "height": 690
      }
    }
  ]
}

---

GET /search

Recherchez des images ou des GIFs à l'aide de métadonnées telles que les noms d'artistes ou les titres des sources.

Paramètres de requête

Nom	Type	Requis	Description
query	string	Oui	Terme de recherche
type	enum	Oui	1 = images, 2 = GIFs
category	string	Non	Restreindre les résultats à une catégorie
amount	number	Non	Nombre de résultats (1 ≤ X ≤ 20)

Exemple (recherche d'image)

https://nekos.best/api/v2/search?query=John&type=1

{
  "results": [
    {
      "artist_name": "John Doe",
      "artist_href": "https://www.example.com/en/users/1234567",
      "source_url": "https://www.example.com/en/artworks/1234567",
      "url": "https://nekos.best/api/v2/neko/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.png",
      "dimensions": {
        "width": 420,
        "height": 690
      }
    }
  ]
}

Exemple (recherche GIF avec catégorie)

https://nekos.best/api/v2/search?query=Generic&type=2&category=pat&amount=2

{
  "results": [
    {
      "anime_name": "Generic Anime Name",
      "url": "https://nekos.best/api/v2/hug/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.gif",
      "dimensions": {
        "width": 420,
        "height": 690
      }
    },
    {
      "anime_name": "Generic Anime Name",
      "url": "https://nekos.best/api/v2/hug/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.gif",
      "dimensions": {
        "width": 420,
        "height": 690
      }
    }
  ]
}

---

GET /:category/:filename.:format

Récupère directement une ressource spécifique.

Paramètres de chemin

Nom	Description
category	Nom de la catégorie
filename	Nom de fichier de la ressource (UUID)
format	Format de fichier (png, gif)

INFO

Les métadonnées pour ce point de terminaison sont retournées via des en-têtes de réponse HTTP encodés en URL.

En-têtes disponibles :

• anime_name
• artist_name
• artist_href
• source_url

Exemple

https://nekos.best/api/v2/hug/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.gif

Réponse : Données binaires d'image ou de GIF