Skip to content

Endpoints de la API ​

URL base ​

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

Reemplaza :version por una de las versiones compatibles indicadas abajo.

Versiones ​

Versión
Estado
v2
Actual y mantenida

TIP

Te recomendamos configurar un encabezado User-Agent personalizado en tus solicitudes. Consulta la documentación de User-Agent para ver el formato sugerido.

Endpoints ​

GET /endpoints ​

Devuelve todas las categorías disponibles de la API y sus formatos de archivo asociados.

Ejemplo ​

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

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

TIP

Usa este endpoint para obtener dinámicamente las categorías disponibles en lugar de definirlas manualmente en tu código.


GET /:category ​

Devuelve una imagen o GIF aleatorio de la categoría especificada junto con sus metadatos.

Parámetros de consulta ​

NombreTipoRequeridoDescripción
amountnumberNoNúmero de resultados a devolver (1 ≤ X ≤ 20)

El valor por defecto es 1 si no se especifica.

Ejemplo (resultado único) ​

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

json
{
  "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
      }
    }
  ]
}

Ejemplo (múltiples resultados) ​

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

json
{
  "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
      }
    }
  ]
}

Busca imágenes o GIFs usando metadatos como el nombre del artista o el título de origen.

Parámetros de consulta ​

NombreTipoRequeridoDescripción
querystringSíTérmino de búsqueda
typeenumSí1 = imágenes, 2 = GIFs
categorystringNoRestringe los resultados a una categoría
amountnumberNoNúmero de resultados (1 ≤ X ≤ 20)

Ejemplo (búsqueda de imágenes) ​

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

json
{
  "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
      }
    }
  ]
}

Ejemplo (búsqueda de GIFs con categoría) ​

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

json
{
  "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 ​

Obtiene un recurso específico directamente.

Parámetros de ruta ​

NombreDescripción
categoryNombre de la categoría
filenameNombre del archivo del recurso (UUID)
formatFormato de archivo (png, gif)

INFO

Los metadatos de este endpoint se devuelven mediante encabezados de respuesta HTTP codificados en URL.

Encabezados disponibles:

  • anime_name
  • artist_name
  • artist_href
  • source_url

Ejemplo ​

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

Respuesta: Datos binarios de la imagen o GIF