scathach-api

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>scathach-api</title><meta name="description" content="Documentation for scathach-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script><link rel="stylesheet" href="assets/custom.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base="."> <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">scathach-api</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> <div class="container container-main"> <div class="col-8 col-content"> <div class="tsd-page-title"> <h2>scathach-api</h2></div> <div class="tsd-panel tsd-typography"><div align="center"> <a href="https://sinkaroid.github.io/scathach-api"> <img width="480" src="https://cdn.discordapp.com/attachments/952117487166705747/962346332268400700/sca.png" alt="logo"></a><h2>scathach-api</h2> Scathach bot is a lewd bot, then this wrapper exists for it <a href="https://github.com/sinkaroid/scathach-api/actions/workflows/get.yml"><img src="https://github.com/sinkaroid/scathach-api/actions/workflows/get.yml/badge.svg" alt="Test get"></a> <a href="https://sinkaroid.github.io/scathach-api"><img src="https://github.com/sinkaroid/scathach-api/actions/workflows/docs.yml/badge.svg" alt="Documentation"></a> <hr> </div> <a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;"> <h2>Getting started</h2> </a> Previous versions is completely ended for its services. <blockquote> This version is completely rewritten and just focused on minigame API, If you still rely on the old version install with <code>npm install scathach-api@0.0.9 / yarn add scathach-api@0.0.9</code> </blockquote> This resources mostly hand-picked but also automate pick and does not low quality content <a href="#features" id="features" style="color: inherit; text-decoration: none;"> <h2>Features</h2> </a> <img align="right" src="https://cdn.discordapp.com/attachments/952117487166705747/962562849874542642/tong.png" width="440"></img> <ul> <li>Fate Grand Order sex</li> <li>Genshin Impact sex</li> <li>Azur Lane sex</li> <li>Hololive sex</li> <li>Arknights sex</li> <li>Fire Emblem sex</li> <li>Girls' Frontline sex</li> <li>Kancolle sex</li> <li>Random gif sex</li> <li>Get wholesome waifu</li> <li>Fgo reaction</li> <li>Anime sex like <code>nekos.life</code> do, but more juicier</li> </ul> <hr> <a href="#🚀installation" id="🚀installation" style="color: inherit; text-decoration: none;"> <h2>🚀Installation</h2> </a> <code>npm install scathach-api@latest / yarn add scathach-api@latest</code> <a href="#usage" id="usage" style="color: inherit; text-decoration: none;"> <h2>Usage</h2> </a> <blockquote> Documentation: <a href="https://sinkaroid.github.io/scathach-api">https://sinkaroid.github.io/scathach-api</a> </blockquote> CommonJS should do with <code>require('scathach-api')</code> <ul> <li>Api key is optional: <a href="https://scathach.dev/dashboard">https://scathach.dev/dashboard</a></li> </ul> <pre><code class="language-js">import Scathach from 'scathach-api' const config = { useragent: '<user-agent>', apikey: '<scathach.dev api>' // optional }; const sca = new Scathach(config); sca.getFgo().then((res) => { console.log('fgo', res) }); // => Random normalizes FGO sex data sca.getGenshin().then((res) => { console.log('genshin', res) }); // => Random normalizes Genshin impact sex data sca.getAzur().then((res) => { console.log('azur', res) }); // => Random normalizes Azurlane sex data sca.getHololive().then((res) => { console.log('hololive', res) }); // => Random normalizes Hololive sex data sca.getArknights().then((res) => { console.log('arkinghts', res) }); // => Random normalizes Arkinghts sex data sca.getFireEmblem().then((res) => { console.log('fire_emblem', res) }); // => Random normalizes Fire emblem sex data sca.getGirlsFrontline().then((res) => { console.log('gfl', res) }); // => Random normalizes Girls' frontline sex data sca.getKancolle().then((res) => { console.log('kancolle', res) }); // => Random normalizes Kancolle girls sex data sca.getReaction('smug').then((res) => { console.log('smug', res) }); // => Random smug reaction sca.searchR34('futanari', 100).then((res) => { console.log('futanari', res) }); // => Bulk image request from r34, not an object, ready to extends sca.getAnimeSex('hentai').then((res) => { console.log('anime sex', res) }); // => Get random anime sex like nekos.life do but more juicier </code></pre> <a href="#results-example" id="results-example" style="color: inherit; text-decoration: none;"> <h2>Results example</h2> </a> <ul> <li>Fgo</li> </ul> <pre><code class="language-js">fgo { data: { character: 'nero claudius', approver: '@sinkaroid', favorites: 0, rating: 'questionable', category: 'fgo' }, info: '0.83', image: 'https://tomoe.scathach.software/original/3e/36/3e36f644a051bee376f1dda8c3717880.jpg', size: 'original', type: 'jpg', nsfw: true, fetch: 'rUFcyOimM2' } </code></pre> <ul> <li>Genshin</li> </ul> <pre><code class="language-js">genshin { data: { character: 'kujou sara', approver: '@sinkaroid', favorites: 0, rating: 'explicit', category: 'genshin_impact' }, info: '0.85', image: 'https://tomoe.scathach.software/original/59/91/599160ee0840872d78250edcf4fd2d5c.png', size: 'original', type: 'png', nsfw: true, fetch: 'g5ljvRpnGL' } </code></pre> <ul> <li>Azur lane</li> </ul> <pre><code class="language-js">azur { data: { character: 'formidable', approver: '@sinkaroid', favorites: 0, rating: 'questionable', category: 'azur_lane' }, info: '0.70', image: 'https://tomoe.scathach.software/original/c6/40/c6404521f422560458c767dde9410731.jpg', size: 'original', type: 'jpg', nsfw: true, fetch: 'eJ4TYhpE7ARmvwQxMldj' } </code></pre> <ul> <li>search method</li> </ul> <pre><code class="language-js">gelbooru { info: '0.55', message: "i've took 50 clean images of the total initial data 50", pattern_block: '/', clean_image: [ 'https://img3.gelbooru.com/images/33/2d/332dac3ee83a39da47891addfc0171f4.jpg', 'https://img3.gelbooru.com/images/93/31/9331dd4702b22e2f8561f21c6f3ac24a.jpg', 'https://img3.gelbooru.com/images/5c/e4/5ce467ef4b3aa9a59d4aa5a8ecf115b6.jpg', 'https://img3.gelbooru.com/images/b4/45/b44516efa363b00e9b72df5727d9de95.jpeg' // and so on ], is_shuffle: true, from_booru: 'gelbooru' } </code></pre> <a href="#pronunciation" id="pronunciation" style="color: inherit; text-decoration: none;"> <h2>Pronunciation</h2> </a> <a href="https://www.localeplanet.com/java/en-US/index.html"><code>en_US</code></a> • /skah·hahk/ — Scathach bot is an FGO-oriented Lewd bot then this wrapper exists for it. <a href="https://discord.com/oauth2/authorize?client_id=724047481561809007&permissions=808840278&response_type=code&scope=bot+applications.commands">Click here to spill</a> <a href="#legal" id="legal" style="color: inherit; text-decoration: none;"> <h2>Legal</h2> </a> This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel like this tool deserves an attribution, mention it. It won't hurt anybody <a href="#limitations" id="limitations" style="color: inherit; text-decoration: none;"> <h2>Limitations</h2> </a> <ul> <li>There is a hard limit of 100 posts per <a href="https://sinkaroid.github.io/scathach-api/classes/index.Scathach.html"><code>search()</code></a> request</li> <li>There is a rate limit every 1 seconds per request</li> <li>The instance has easy to overload, your data returns may lead to null</li> </ul> <a href="#support-me" id="support-me" style="color: inherit; text-decoration: none;"> <h2>Support me</h2> </a> <blockquote> This instance sits together with Scathach bot, the server may easy to overload then upgrading stuff is not really cheap for me, any kind of donations will helps. <img width="500" src="https://cdn.discordapp.com/attachments/952117487166705747/974559294517284874/Screenshot_428.png" alt="cf"> </blockquote> </div></div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <div class="tsd-navigation settings"> <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> <div class="tsd-accordion-details"> <div class="tsd-filter-visibility"> <h4 class="uppercase">Member Visibility</h4><form> <ul id="tsd-filter-options"> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></form></div> <div class="tsd-theme-toggle"> <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> <nav class="tsd-navigation primary"> <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> <div class="tsd-accordion-details"> <ul> <li class="current selected"><a href="modules.html">scathach-api</a> <ul> <li class="tsd-kind-module"><a href="modules/index.html">index</a></li> <li class="tsd-kind-module"><a href="modules/src_consts.html">src/consts</a></li> <li class="tsd-kind-module"><a href="modules/src_defaults.html">src/defaults</a></li> <li class="tsd-kind-module"><a href="modules/src_request.html">src/request</a></li> <li class="tsd-kind-module"><a href="modules/src_types.html">src/types</a></li> <li class="tsd-kind-module"><a href="modules/src_utils.html">src/utils</a></li></ul></li></ul></div></details></nav></div></div> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div> <div class="overlay"></div><script src="assets/main.js"></script><script src="assets/custom.js"></script></body></html>