{"id":27359264,"url":"https://github.com/fangmarks/yiff","last_synced_at":"2025-04-13T00:27:46.659Z","repository":{"id":42996953,"uuid":"166299528","full_name":"fangmarks/yiff","owner":"fangmarks","description":"Node.js API Wrapper for various Furry APIs","archived":false,"fork":false,"pushed_at":"2024-01-09T19:33:52.000Z","size":1245,"stargazers_count":20,"open_issues_count":2,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-10T04:04:45.830Z","etag":null,"topics":["bot","phin","yiff"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fangmarks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-17T21:28:34.000Z","updated_at":"2025-01-04T02:38:20.000Z","dependencies_parsed_at":"2024-09-18T20:41:32.435Z","dependency_job_id":null,"html_url":"https://github.com/fangmarks/yiff","commit_stats":null,"previous_names":["fangmarks/yiff","hokkqi/yiff"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fangmarks%2Fyiff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fangmarks%2Fyiff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fangmarks%2Fyiff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fangmarks%2Fyiff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fangmarks","download_url":"https://codeload.github.com/fangmarks/yiff/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650841,"owners_count":21139670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","phin","yiff"],"created_at":"2025-04-13T00:27:46.453Z","updated_at":"2025-04-13T00:27:46.654Z","avatar_url":"https://github.com/fangmarks.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# yiff by [Lio](https://wrwlf.co \"my homepage\")\r\n\r\n[![NPM](https://nodei.co/npm/yiff.png)](https://nodei.co/npm/yiff/)\r\n\r\n## **VERSION 3 IS A BREAKING CHANGE**\r\n## NodeJS V14 or higher is required!\r\n\r\n### **\\*Do not** update from v2 if your current code is still based on v2\\*\r\n\r\nIf you need Support or want more Information, join [my discord server](https://discord.gg/He2822y \"a link to my discord server\")\r\n\r\n\r\n## ⭐️ Supported APIs\r\n\r\n- e621.net\r\n- e926.net\r\n- [yiff.rest](https://yiff.rest)\r\n- [sheri.bot](https://sheri.bot)\r\n- [shibe.online](https://shibe.online)\r\n- randomfox.ca\r\n- [api.floofy.dev](https://floofy.dev)\r\n- [gelbooru.com](https://gelbooru.com)\r\n- [thaldr.in](https://thaldr.in)\r\n\r\n**Yiff, by default, uses the main [Killswitch Instance](https://yiff.click) as a Proxy for any Requests.**\r\n\r\n# Usage\r\n\r\n```ts\r\nimport Yiff from \"yiff\";\r\n\r\n// every object in the config is optional\r\nlet config = {\r\n  useragent: `Project/version (website)`;\r\n    killswitch: {\r\n        enabled: true\r\n        instance: \"https://yiff.click\"\r\n    }\r\n    apikey: {\r\n        sheri: \"\u003cYour Token\u003e\";\r\n        yiffrest: \"\u003cYour Token\u003e\";\r\n        e621: \"\u003cYour Token\u003e\";\r\n        e926: \"\u003cYour Token\u003e\";\r\n    }\r\n}\r\nconst yiff = new Yiff(config);\r\n\r\nlet tags = \"werewolf male/male\"\r\nlet limit = 1\r\n// Basically:\r\n\r\nyiff.e621(tags, limit).then((r) =\u003e {console.log(\"e621\", r)})\r\n// =\u003e Unfiltered E621 Response\r\n\r\nyiff.e926(tags, limit).then((r) =\u003e {console.log(\"e926\", r)})\r\n// =\u003e Unfiltered E926 Response\r\n\r\nyiff.yiffy('animals', 'birb').then((r) =\u003e {console.log(\"yiffy\", r)})\r\n// =\u003e Unfiltered yiff.rest Response\r\n\r\nyiff.floofy().then((r) =\u003e {console.log(\"floofy\", r)})\r\n// =\u003e Unfiltered api.floofy.dev Response\r\n\r\nyiff.sheri('paws').then((r) =\u003e {console.log(\"sheri\", r)})\r\n// =\u003e Unfiltered sheri.bot Response\r\n\r\nyiff.shibe(\"shibes\", 2).then((r) =\u003e {console.log(\"shibes\", r)})\r\n// =\u003e Unfiltered shibe.online Response\r\n\r\nyiff.fox().then((r) =\u003e {console.log(\"fox\", r)})\r\n// =\u003e Unfiltered randomfox.ca Response\r\n\r\nyiff.thaldrin(\"categories/foxes\").then((r) =\u003e {console.log(\"thaldrin\", r)})\r\n// =\u003e Unfiltered thaldr.in Response\r\n```\r\n\r\n## ❓ FAQ\r\n\r\n\u003e **Q:** Will you add other APIs as well?\\\r\n\u003e **A:** Depends on if they're either free or I get an all-access token, as well as if there's proper documentation for the API\r\n\r\n## Contributing \u0026 Issues\r\n\r\nFeel free to make a Pull request and fix some things, otherwise just open a Issue or join [my discord server](https://discord.gg/He2822y) and let me know what you want added!\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffangmarks%2Fyiff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffangmarks%2Fyiff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffangmarks%2Fyiff/lists"}