radars-furaffinity-api

FurAffinity wrapper for Node.js based on this wrapper

Stats are for the base branch!

Important: This project can only be used with Furaffinity's Modern style.

Installation

npm install furaffinity-api

APIs

Login(a: string, b: string)

Login to furaffinity use cookies

import { Login } from "furaffinity-api";
// or
const { Login } = require("furaffinity-api");
 
// to allow all results to be accessible, add your cookies
Login("cookie_a", "cookie_b");

Search(query: string, options: SearchOptions)

Searching for content:

import { Search, Type } from 'furaffinity-api';
 
Search('search query', { /** SearchOptions */ type?, rating?, page? }).then(res => {
  // res is an array of Result(s)
  res[0].getSubmission().then(submission => {
    // submission is a Submission
  });
});

Browse(options?: BrowseOptions)

Get results from Browse page:

import { Browse } from "furaffinity-api";
 
Browse({
  /** BrowseOptions */
}).then(res => {
  // res is an array of Result(s)
  res[0].getSubmission().then(submission => {
    // submission is a Submission
  });
});

Submission(id: string)

Looking up a specific submission:

import { Submission } from "furaffinity-api";
 
Submission("1234567890").then(res => {
  // res is a Submission
});

User()

Get information of current logged in user:

import { User } from "furaffinity-api";
 
User().then(user => {
  // console.log(user);
});

Author(id: string)

Get information of an author:

import { Author, WatchingList } from "furaffinity-api";
 
Author("user_id").then(res => {
  // res is an Author
  // Author has id, name, url and avatar(maybe undefined)
  WatchingList(res.id).then(list => {
    // list is an Author array
  });
});

Gallery(id: string)

Get results from someone's gallery:

import { Gallery } from "furaffinity-api";
 
Gallery("author_id").then(res => {
  // res is an array of Result(s)
  res[0].getSubmission().then(submission => {
    // submission is a Submission
  });
});

Scraps(id: string)

Get results from someone's scraps:

import { Scraps } from "furaffinity-api";
 
Scraps("author_id").then(res => {
  // res is an array of Result(s)
  res[0].getSubmission().then(submission => {
    // submission is a Submission
  });
});

WatchingList(id: string)

Get all watching authors of an author(can't get avatar):

import { WatchingList } from "furaffinity-api";
 
WatchingList("author_id").then(list => {
  // list is an Author array
});

MyWatchingList()

Login first Get all watching authors of current login user(can get avatar):

import { MyWatchingList } from "furaffinity-api";
 
MyWatchingList().then(list => {
  // list is an Author array
});
 
## Special Thanks
 
- [insert/furaffinity](https://gitlab.insrt.uk/insert/furaffinity): furaffinity-api is based on this project.
 
## License
ISC