# Succubus.Space API

## Hentai

<mark style="color:blue;">`GET`</mark> `https://api.succubus.space/hentai/:query`

Retrieves the desired hentai from the cache

#### Path Parameters

| Name  | Type   | Description                 |
| ----- | ------ | --------------------------- |
| query | String | Can be a search query or ID |

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "id": 1226,
  "is_visible": true,
  "name": "Itadaki! Seieki",
  "slug": "itadaki-seieki",
  "created_at": "2016-06-07T00:02:39.351Z",
  "released_at": "2014-03-27",
  "description": "When Kanzaki receives a letter from Mari Setogaya asking to meet in their school's PE storage room during the lunch break, he believes he will be receiving a love confession. He turns up eagerly, only to be attacked by his supposed admirer. The beautiful girl tries to knock him unconscious, but when she fails miserably, she explains that she is a vampire and had wanted to feed on him. Feeling pity for her hopeless state, Kanzaki reluctantly yields and allows her to drink his blood.\n\nAs it turns out, Mari cannot stand the taste of raw blood but will perish without the nutrients it contains. Kanzaki is quick to find a solution, offering her a different bodily fluid to consume—and Setogaya instantly falls head over heels with this new flavor. The two soon start meeting regularly, and as time goes by, their relationship evolves into something more than just casual \"meals\" spent together.",
  "views": 4982423,
  "interests": 2237036,
  "poster_url": "https://git-posters.pages.dev/images/itadaki-seieki.jpg",
  "cover_url": "https://git-covers.pages.dev/images/itadaki-seieki-IHqaP.jpg",
  "is_hard_subtitled": true,
  "brand": "Pashmina",
  "duration_in_ms": 1378000,
  "is_censored": false,
  "rating": "Unrated",
  "likes": 33477,
  "dislikes": 223,
  "downloads": 136836,
  "monthly_rank": 53,
  "brand_id": "65",
  "is_banned_in": "JP",
  "preview_url": null,
  "primary_color": null,
  "created_at_unix": 1465257759,
  "released_at_unix": 1395932400,
  "hentai_tags": [
    {
      "id": 147,
      "text": "comedy"
    },
    {
      "id": 256,
      "text": "school girl"
    },
    {
      "id": 75,
      "text": "monster"
    },
    {
      "id": 475,
      "text": "boob job"
    },
    {
      "id": 261,
      "text": "ntr"
    },
    {
      "id": 527,
      "text": "nekomimi"
    },
    {
      "id": 32,
      "text": "cosplay"
    },
    {
      "id": 223,
      "text": "public sex"
    },
    {
      "id": 499,
      "text": "hd"
    },
    {
      "id": 28,
      "text": "uncensored"
    },
    {
      "id": 40,
      "text": "anal"
    },
    {
      "id": 219,
      "text": "facial"
    },
    {
      "id": 169,
      "text": "blow job"
    },
    {
      "id": 110,
      "text": "big boobs"
    },
    {
      "id": 168,
      "text": "gangbang"
    },
    {
      "id": 26,
      "text": "bondage"
    },
    {
      "id": 38,
      "text": "rape"
    }
  ],
  "titles": [
    "I`ll Have Your Semen",
    "Itadaki! Seieki",
    "Vampire Vixen",
    "いただきっ! セーエキ",
    "잘먹을게 정액"
  ],
  "url": "https://hanime.tv/videos/hentai/itadaki-seieki",
  "streamURL": "https://m3u8s.highwinds-cdn.com/api/v9/m3u8s/m6Ar8g9g8m5zc4vpnr3mh3A4dAZflj1gd7rjp5lwybwgvyxl4p2fy.m3u8",
  "tags": [
    "comedy",
    "school girl",
    "monster",
    "boob job",
    "ntr",
    "nekomimi",
    "cosplay",
    "public sex",
    "hd",
    "uncensored",
    "anal",
    "facial",
    "blow job",
    "big boobs",
    "gangbang",
    "bondage",
    "rape"
  ],
  "malURL": "https://myanimelist.net/anime/22429/Itadaki_Seieki♥",
  "malID": 22429
}
```

{% endtab %}
{% endtabs %}

## Random

<mark style="color:blue;">`GET`</mark> `https://api.succubus.space/random`

Retrieve a random hentai

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "id": 1346,
  "is_visible": true,
  "name": "Futabu! 1",
  "slug": "futabu-1",
  "created_at": "2016-09-11T09:02:33.255Z",
  "released_at": "2014-02-20",
  "description": "Niimura Akane is a normal girl whose curiosity has lead her to join the Futa Club as someone in charge of service duties. Thus begins her daily happenings with the four futanari within the club.",
  "views": 2646778,
  "interests": 1981495,
  "poster_url": "https://git-posters.pages.dev/images/futabu-1-ynSjj.jpg",
  "cover_url": "https://git-covers.pages.dev/images/futabu-1-x.jpg",
  "is_hard_subtitled": true,
  "brand": "MediaBank",
  "duration_in_ms": 1540000,
  "is_censored": true,
  "rating": "Unrated",
  "likes": 13616,
  "dislikes": 158,
  "downloads": 75988,
  "monthly_rank": 299,
  "brand_id": "57",
  "is_banned_in": "JP",
  "preview_url": null,
  "primary_color": null,
  "created_at_unix": 1473584553,
  "released_at_unix": 1392908400,
  "hentai_tags": [
    {
      "id": 147,
      "text": "comedy"
    },
    {
      "id": 475,
      "text": "boob job"
    },
    {
      "id": 463,
      "text": "hand job"
    },
    {
      "id": 444,
      "text": "inflation"
    },
    {
      "id": 255,
      "text": "orgy"
    },
    {
      "id": 73,
      "text": "loli"
    },
    {
      "id": 20,
      "text": "creampie"
    },
    {
      "id": 523,
      "text": "censored"
    },
    {
      "id": 223,
      "text": "public sex"
    },
    {
      "id": 40,
      "text": "anal"
    },
    {
      "id": 219,
      "text": "facial"
    },
    {
      "id": 169,
      "text": "blow job"
    },
    {
      "id": 179,
      "text": "futanari"
    },
    {
      "id": 521,
      "text": "glasses"
    },
    {
      "id": 110,
      "text": "big boobs"
    }
  ],
  "titles": [
    "Futa Club!",
    "Futabu!",
    "ふた部!",
    "후타부"
  ],
  "url": "https://hanime.tv/videos/hentai/futabu-1",
  "streamURL": "https://m3u8s.highwinds-cdn.com/api/v9/m3u8s/n2tpA01mfzf7315vzndnr8t06yZklgAzk0n48Asx6v2nl2r292hAq.m3u8",
  "tags": [
    "comedy",
    "boob job",
    "hand job",
    "inflation",
    "orgy",
    "loli",
    "creampie",
    "censored",
    "public sex",
    "anal",
    "facial",
    "blow job",
    "futanari",
    "glasses",
    "big boobs"
  ]
}
```

{% endtab %}
{% endtabs %}

## Get HAnime.tv data

<mark style="color:blue;">`GET`</mark> `https://api.succubus.space/hanime/:query`

Retrieves data directly from HAnime.tv

#### Path Parameters

| Name  | Type   | Description                        |
| ----- | ------ | ---------------------------------- |
| query | string | Can be a search query or HAnime ID |

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "id": 1226,
  "is_visible": true,
  "name": "Itadaki! Seieki",
  "slug": "itadaki-seieki",
  "created_at": "2016-06-07T00:02:39.351Z",
  "released_at": "2014-03-27",
  "description": "Based on the erotic manga by Doumou.\n\nSuccubus Setogaya Mari is a part-vampire who takes her nourishment not from blood but from drinking semen. As she performs oral sex for energy, various things can happen; for example, her breasts might simply grow during the act.\n",
  "views": 4982391,
  "interests": 2237032,
  "poster_url": "https://git-posters.pages.dev/images/itadaki-seieki.jpg",
  "cover_url": "https://git-covers.pages.dev/images/itadaki-seieki-IHqaP.jpg",
  "is_hard_subtitled": true,
  "brand": "Pashmina",
  "duration_in_ms": 1378000,
  "is_censored": false,
  "rating": "Unrated",
  "likes": 33476,
  "dislikes": 223,
  "downloads": 136835,
  "monthly_rank": 53,
  "brand_id": "65",
  "is_banned_in": "JP",
  "preview_url": null,
  "primary_color": null,
  "created_at_unix": 1465257759,
  "released_at_unix": 1395932400,
  "hentai_tags": [
    {
      "id": 147,
      "text": "comedy"
    },
    {
      "id": 256,
      "text": "school girl"
    },
    {
      "id": 75,
      "text": "monster"
    },
    {
      "id": 475,
      "text": "boob job"
    },
    {
      "id": 261,
      "text": "ntr"
    },
    {
      "id": 527,
      "text": "nekomimi"
    },
    {
      "id": 32,
      "text": "cosplay"
    },
    {
      "id": 223,
      "text": "public sex"
    },
    {
      "id": 499,
      "text": "hd"
    },
    {
      "id": 28,
      "text": "uncensored"
    },
    {
      "id": 40,
      "text": "anal"
    },
    {
      "id": 219,
      "text": "facial"
    },
    {
      "id": 169,
      "text": "blow job"
    },
    {
      "id": 110,
      "text": "big boobs"
    },
    {
      "id": 168,
      "text": "gangbang"
    },
    {
      "id": 26,
      "text": "bondage"
    },
    {
      "id": 38,
      "text": "rape"
    }
  ],
  "titles": [
    "I`ll Have Your Semen",
    "Itadaki! Seieki",
    "Vampire Vixen",
    "いただきっ! セーエキ",
    "잘먹을게 정액"
  ],
  "url": "https://hanime.tv/videos/hentai/itadaki-seieki",
  "streamURL": "https://m3u8s.highwinds-cdn.com/api/v9/m3u8s/m6Ar8g9g8m5zc4vpnr3mh3A4dAZflj1gd7rjp5lwybwgvyxl4p2fy.m3u8",
  "tags": [
    "comedy",
    "school girl",
    "monster",
    "boob job",
    "ntr",
    "nekomimi",
    "cosplay",
    "public sex",
    "hd",
    "uncensored",
    "anal",
    "facial",
    "blow job",
    "big boobs",
    "gangbang",
    "bondage",
    "rape"
  ]
}
```

{% endtab %}
{% endtabs %}

## Force scrape data

<mark style="color:blue;">`GET`</mark> `https://api.succubus.space/scrape/:query`

Forcefully scrape an entry to update the cache

#### Path Parameters

| Name  | Type   | Description                 |
| ----- | ------ | --------------------------- |
| query | string | Can be a search query or ID |

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "id": 1226,
  "is_visible": true,
  "name": "Itadaki! Seieki",
  "slug": "itadaki-seieki",
  "created_at": "2016-06-07T00:02:39.351Z",
  "released_at": "2014-03-27",
  "description": "When Kanzaki receives a letter from Mari Setogaya asking to meet in their school's PE storage room during the lunch break, he believes he will be receiving a love confession. He turns up eagerly, only to be attacked by his supposed admirer. The beautiful girl tries to knock him unconscious, but when she fails miserably, she explains that she is a vampire and had wanted to feed on him. Feeling pity for her hopeless state, Kanzaki reluctantly yields and allows her to drink his blood.\n\nAs it turns out, Mari cannot stand the taste of raw blood but will perish without the nutrients it contains. Kanzaki is quick to find a solution, offering her a different bodily fluid to consume—and Setogaya instantly falls head over heels with this new flavor. The two soon start meeting regularly, and as time goes by, their relationship evolves into something more than just casual \"meals\" spent together.",
  "views": 4982423,
  "interests": 2237036,
  "poster_url": "https://git-posters.pages.dev/images/itadaki-seieki.jpg",
  "cover_url": "https://git-covers.pages.dev/images/itadaki-seieki-IHqaP.jpg",
  "is_hard_subtitled": true,
  "brand": "Pashmina",
  "duration_in_ms": 1378000,
  "is_censored": false,
  "rating": "Unrated",
  "likes": 33477,
  "dislikes": 223,
  "downloads": 136836,
  "monthly_rank": 53,
  "brand_id": "65",
  "is_banned_in": "JP",
  "preview_url": null,
  "primary_color": null,
  "created_at_unix": 1465257759,
  "released_at_unix": 1395932400,
  "hentai_tags": [
    {
      "id": 147,
      "text": "comedy"
    },
    {
      "id": 256,
      "text": "school girl"
    },
    {
      "id": 75,
      "text": "monster"
    },
    {
      "id": 475,
      "text": "boob job"
    },
    {
      "id": 261,
      "text": "ntr"
    },
    {
      "id": 527,
      "text": "nekomimi"
    },
    {
      "id": 32,
      "text": "cosplay"
    },
    {
      "id": 223,
      "text": "public sex"
    },
    {
      "id": 499,
      "text": "hd"
    },
    {
      "id": 28,
      "text": "uncensored"
    },
    {
      "id": 40,
      "text": "anal"
    },
    {
      "id": 219,
      "text": "facial"
    },
    {
      "id": 169,
      "text": "blow job"
    },
    {
      "id": 110,
      "text": "big boobs"
    },
    {
      "id": 168,
      "text": "gangbang"
    },
    {
      "id": 26,
      "text": "bondage"
    },
    {
      "id": 38,
      "text": "rape"
    }
  ],
  "titles": [
    "I`ll Have Your Semen",
    "Itadaki! Seieki",
    "Vampire Vixen",
    "いただきっ! セーエキ",
    "잘먹을게 정액"
  ],
  "url": "https://hanime.tv/videos/hentai/itadaki-seieki",
  "streamURL": "https://m3u8s.highwinds-cdn.com/api/v9/m3u8s/m6Ar8g9g8m5zc4vpnr3mh3A4dAZflj1gd7rjp5lwybwgvyxl4p2fy.m3u8",
  "tags": [
    "comedy",
    "school girl",
    "monster",
    "boob job",
    "ntr",
    "nekomimi",
    "cosplay",
    "public sex",
    "hd",
    "uncensored",
    "anal",
    "facial",
    "blow job",
    "big boobs",
    "gangbang",
    "bondage",
    "rape"
  ],
  "malURL": "https://myanimelist.net/anime/22429/Itadaki_Seieki♥",
  "malID": 22429
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.succubus.space/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.