Skip to content

API एंडपॉइंट्स ​

बेस URL ​

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

:version की जगह नीचे दिए गए समर्थित वर्ज़न में से किसी एक का उपयोग करें।

वर्ज़न ​

वर्ज़न
स्थिति
v2
वर्तमान और सक्रिय रूप से मेंटेन किया गया

TIP

हम सुझाव देते हैं कि रिक्वेस्ट भेजते समय कस्टम User-Agent हेडर सेट करें। सुझाए गए फॉर्मेट के लिए User-Agent डॉक्यूमेंटेशन देखें।

एंडपॉइंट्स ​

GET /endpoints ​

सभी उपलब्ध API कैटेगरी और उनके संबंधित फाइल फॉर्मेट लौटाता है।

उदाहरण ​

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

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

TIP

समर्थित कैटेगरी को हार्डकोड करने के बजाय डायनामिक रूप से प्राप्त करने के लिए इस एंडपॉइंट का उपयोग करें।


GET /:category ​

निर्दिष्ट कैटेगरी से मेटाडेटा के साथ एक रैंडम इमेज या GIF लौटाता है।

क्वेरी पैरामीटर्स ​

नामप्रकारआवश्यकविवरण
amountnumberनहींलौटाए जाने वाले परिणामों की संख्या (1 ≤ X ≤ 20)

यदि निर्दिष्ट न किया जाए, तो डिफ़ॉल्ट मान 1 होता है।

उदाहरण (एक परिणाम) ​

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

उदाहरण (कई परिणाम) ​

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

आर्टिस्ट के नाम या सोर्स टाइटल जैसे मेटाडेटा के आधार पर इमेज या GIF खोजें।

क्वेरी पैरामीटर्स ​

नामप्रकारआवश्यकविवरण
querystringहांखोज शब्द या वाक्यांश
typeenumहां1 = इमेज, 2 = GIF
categorystringनहींपरिणामों को किसी एक कैटेगरी तक सीमित करें
amountnumberनहींपरिणामों की संख्या (1 ≤ X ≤ 20)

उदाहरण (इमेज खोज) ​

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

उदाहरण (कैटेगरी के साथ GIF खोज) ​

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 ​

किसी विशिष्ट एसेट को सीधे प्राप्त करता है।

पाथ पैरामीटर्स ​

नामविवरण
categoryकैटेगरी का नाम
filenameएसेट का फाइल नाम (UUID)
formatफाइल फॉर्मेट (png, gif)

INFO

इस एंडपॉइंट के लिए मेटाडेटा URL-encoded HTTP रिस्पॉन्स हेडर्स के ज़रिए लौटाया जाता है।

उपलब्ध हेडर्स:

  • anime_name
  • artist_name
  • artist_href
  • source_url

उदाहरण ​

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

रिस्पॉन्स: बाइनरी इमेज या GIF डेटा