نقاط نهاية API

العنوان الرئيسي (Base URL)

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

استبدل :version بإحدى النسخ المدعومة أدناه.

الإصدارات

الإصدار

الحالة

v2

الحالي والمُدار

هام

قبل إجراء أي طلبات، يرجى قراءة توثيق User-Agent. يجب أن تتضمن جميع الطلبات ترويسة User-Agent منسقة بشكل صحيح.

نقاط النهاية

GET /endpoints

ترجع جميع فئات API المتاحة وصيغ الملفات المرتبطة بها.

مثال

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

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

TIP

استخدم نقطة النهاية هذه لاكتشاف الفئات المدعومة ديناميكيًا بدلاً من كتابتها بشكل ثابت.

---

GET /:category

ترجع صورة أو GIF عشوائية من الفئة المحددة، بما في ذلك البيانات الوصفية.

معلمات الاستعلام

الاسم	النوع	مطلوب	الوصف
amount	number	لا	عدد النتائج المراد إرجاعها (1 ≤ X ≤ 20)

القيمة الافتراضية هي 1 إذا لم يتم تحديدها.

مثال (نتيجة واحدة)

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
      }
    }
  ]
}

مثال (نتائج متعددة)

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

البحث عن الصور أو صور GIF باستخدام البيانات الوصفية مثل أسماء الفنانين أو عناوين المصادر.

معلمات الاستعلام

الاسم	النوع	مطلوب	الوصف
query	string	نعم	عبارة البحث
type	enum	نعم	1 = صور، 2 = صور GIF
category	string	لا	تقييد النتائج بفئة معينة
amount	number	لا	عدد النتائج (1 ≤ X ≤ 20)

مثال (بحث الصور)

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
      }
    }
  ]
}

مثال (بحث GIF مع الفئة)

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

يسترجع عنصرًا معينًا مباشرة.

معلمات المسار

الاسم	الوصف
category	اسم الفئة
filename	اسم ملف العنصر (UUID)
format	صيغة الملف (png, gif)

INFO

يتم إرجاع البيانات الوصفية لنقطة النهاية هذه عبر ترويسات استجابة HTTP المرمزة بـ URL.

الترويسات المتاحة:

• anime_name
• artist_name
• artist_href
• source_url

مثال

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

الاستجابة: بيانات الصورة الثنائية أو GIF