API エンドポイント

ベース 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

このエンドポイントのメタデータは URL エンコードされた HTTP レスポンスヘッダー 経由で返されます。

利用可能なヘッダー:

• anime_name
• artist_name
• artist_href
• source_url

例

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

レスポンス: 画像または GIF のバイナリデータ