Class NekosAPI

constructor

• new NekosAPI(proxy?): NekosAPI

• Parameters

  • Optional proxy: CustomProxy

  Returns NekosAPI

Static lastRequest

getAllArtists

• getAllArtists(options?): Promise<Artist[]>

• Parameters

  • Optional options: Partial<ArtistOptions>

  Returns Promise<Artist[]>

getAllCharacters

• getAllCharacters(options?): Promise<Character[]>

• Parameters

  • Optional options: Partial<CharacterOptions>

  Returns Promise<Character[]>

getAllTags

• getAllTags(options?): Promise<Tag[]>

• Parameters

  • Optional options: Partial<TagOptions>

  Returns Promise<Tag[]>

getArtistByID

• getArtistByID(artistID): Promise<Artist>

• Parameters

  • artistID: number

  Returns Promise<Artist>

getCharacterByID

• getCharacterByID(characterID): Promise<Character>

• Parameters

  • characterID: number

  Returns Promise<Character>

getImage

• getImage(tags?, options?): Promise<NekosImage>

• Parameters

  • Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]

  • Optional options: BaseImageOptions

  Returns Promise<NekosImage>

getImageByID

• getImageByID(id): Promise<NekosImage>

• Parameters

  • id: string | number

  Returns Promise<NekosImage>

getImages

• getImages(tags?, options?): Promise<NekosImage[]>

• Parameters

  • Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]

  • Optional options: FullImageOptions

  Returns Promise<NekosImage[]>

getRandomImage

• getRandomImage(tags?, options?): Promise<NekosImage>

• Parameters

  • Optional tags: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy" | ("Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy")[]

  • Optional options: BaseImageOptions

  Returns Promise<NekosImage>

getTagByID

• getTagByID(tagID): Promise<Tag>

• Parameters

  • tagID: number

  Returns Promise<Tag>

getTagByName

• getTagByName(tagID): Promise<Tag>

• Parameters

  • tagID: "Illustration" | "Girl" | "Black hair" | "Sportswear" | "Sword" | "Kemonomimi" | "Flowers" | "Catgirl" | "White hair" | "Loli" | "Plants" | "Blue Hair" | "Pink hair" | "Purple hair" | "Exposed girl breasts" | "Exposed anus" | "Pussy" | "Dick" | "Maid" | "Beach" | "Reading" | "Mountain" | "Night" | "Gloves" | "Original Style" | "Brown Hair" | "Sunny" | "Rain" | "Shorts" | "Weapon" | "Bikini" | "Ice Cream" | "Tree" | "Bunny girl" | "Dress" | "Usagimimi" | "School Uniform" | "Guitar" | "Baggy Clothes" | "Wet" | "Yuri" | "Red hair" | "Glasses" | "Anal" | "Futanari" | "Masturbating" | "Threesome" | "Kissing" | "Skirt" | "Blonde hair" | "Horsegirl" | "Boy"

  Returns Promise<Tag>